From ce5c59eb52c2afb9bde77b7f13be8c372cc8df4e Mon Sep 17 00:00:00 2001 From: Schema validation Bot Date: Mon, 15 Jul 2019 13:31:14 +0000 Subject: [PATCH 01/11] Validation result with ERRORS [skip ci] --- .../validation-20190715T133114Z.txt | 1517 +++++++++++++++++ 1 file changed, 1517 insertions(+) create mode 100644 .circleci/validation_results/validation-20190715T133114Z.txt diff --git a/.circleci/validation_results/validation-20190715T133114Z.txt b/.circleci/validation_results/validation-20190715T133114Z.txt new file mode 100644 index 00000000..745624bf --- /dev/null +++ b/.circleci/validation_results/validation-20190715T133114Z.txt @@ -0,0 +1,1517 @@ +SCHEMA VALIDATION +================= +# schemas : 489 files processed +# errors : 140 +# validate ok : 349 +# issues : 213 files / 573 issues + +total time: 5.23 seconds + + +ERROR - schemas with error(s): +... Common/AddressRef.schema.json +... ... de-reference check: Token "#EntityRef" does not exist. + +... Common/AttachmentRefOrValue.schema.json +... ... AttachmentRefOrValue requires property "$id" + +... Common/ChannelRef.schema.json +... ... ChannelRef requires property "$id" + +... Common/ContactMedium.schema.json +... ... de-reference check: Token "#MediumCharacteristic" does not exist. + +... Common/Entity.schema.json +... ... discriminator (@type) defined but not included in 'required' property + +... Common/ExternalReference.schema.json +... ... ExternalReference requires property "$id" + +... Common/MediumCharacteristic.schema.json +... ... MediumCharacteristic requires property "$id" +... ... de-reference check: Token "Entity" does not exist. + +... Common/ProcessFlow.schema.json +... ... ProcessFlow requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Common/RelatedParty.schema.json' + +... Common/QualificationRef.schema.json +... ... QualificationRef requires property "$id" +... ... de-reference check: Token "EntityRef" does not exist. + +... Common/QuantityType.schema.json +... ... QuantityType requires property "type" +... ... QuantityType requires property "$id" + +... Common/RelatedChannel.schema.json +... ... RelatedChannel requires property "$id" +... ... de-reference check: Token "EntityRef" does not exist. + +... Common/RelatedGeographicAddressRefOrValue.schema.json +... ... discriminator (isRef) defined but not included in 'required' property + +... Common/RelatedGeographicLocationRefOrValue.schema.json +... ... discriminator (isRef) defined but not included in 'required' property + +... Common/RelatedPlaceRefOrValue.schema.json +... ... discriminator (isRef) defined but no isRef property defined +... ... discriminator (isRef) defined but not included in 'required' property + +... Common/StatusChange.schema.json +... ... StatusChange requires property "$id" +... ... de-reference check: Token "Entity" does not exist. + +... Common/Street.schema.json +... ... de-reference check: Token "#EntityRef" does not exist. + +... Common/StreetSegment.schema.json +... ... de-reference check: Token "#EntityRef" does not exist. + +... Common/TaskFlow.schema.json +... ... TaskFlow requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Common/RelatedParty.schema.json' + +... Common/TaskFlowRef.schema.json +... ... TaskFlowRef requires property "$id" +... ... de-reference check: Token "Entity" does not exist. + +... Common/TaskFlowRelationship.schema.json +... ... de-reference check: Token "#TaskFlowRef" does not exist. + +... Common/TaxDefinition.schema.json +... ... TaxDefinition requires property "$id" +... ... de-reference check: Token "Entity" does not exist. + +... Common/TicketRelationship.schema.json +... ... TicketRelationship requires property "$id" +... ... de-reference check: Token "Entity" does not exist. + +... Common/TimePeriodType.schema.json +... ... TimePeriodType requires property "type" +... ... TimePeriodType requires property "$id" + +... Common/TroubleTicket.schema.json +... ... TroubleTicket requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Common/RelatedParty.schema.json' + +... Common/TroubleTicketRelationship.schema.json +... ... TroubleTicketRelationship requires property "$id" +... ... de-reference check: Token "Entity" does not exist. + +... Customer/AccumulatedBalance.schema.json +... ... AccumulatedBalance requires property "type" +... ... AccumulatedBalance requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PartyAccountRef.schema.json' + +... Customer/Appointment.schema.json +... ... Appointment requires property "$id" +... ... de-reference check: Token "#AttachmentRefOrValue" does not exist. + +... Customer/AppointmentStateValues.schema.json +... ... AppointmentStateValues requires property "$id" + +... Customer/BalanceActionRequestRef.schema.json +... ... BalanceActionRequestRef requires property "type" +... ... BalanceActionRequestRef requires property "$id" + +... Customer/BalanceActivity.schema.json +... ... BalanceActivity requires property "type" +... ... BalanceActivity requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/QuantityType.schema.json' + +... Customer/BalanceAdjustment.schema.json +... ... BalanceAdjustment requires property "type" +... ... BalanceAdjustment requires property "$id" + +... Customer/BalanceAdjustmentBody.schema.json +... ... BalanceAdjustmentBody requires property "type" +... ... BalanceAdjustmentBody requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/QuantityType.schema.json' + +... Customer/BalanceAdjustmentRequest.schema.json +... ... BalanceAdjustmentRequest requires property "type" +... ... BalanceAdjustmentRequest requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PartyAccountRef.schema.json' + +... Customer/BalanceTopup.schema.json +... ... BalanceTopup requires property "type" +... ... BalanceTopup requires property "$id" + +... Customer/BalanceTopupBody.schema.json +... ... BalanceTopupBody requires property "type" +... ... BalanceTopupBody requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/QuantityType.schema.json' + +... Customer/BalanceTopupRequest.schema.json +... ... BalanceTopupRequest requires property "type" +... ... BalanceTopupRequest requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PartyAccountRef.schema.json' + +... Customer/BalanceTopupStatus.schema.json +... ... BalanceTopupStatusType requires property "type" +... ... BalanceTopupStatusType requires property "$id" +... ... schema mismatch with title (BalanceTopupStatus) and definitions (BalanceTopupStatusType) + +... Customer/BalanceTopupStatusTypeModify.schema.json +... ... BalanceTopupStatusTypeModify requires property "type" +... ... BalanceTopupStatusTypeModify requires property "$id" + +... Customer/BalanceTransfer.schema.json +... ... BalanceTransfer requires property "type" +... ... BalanceTransfer requires property "$id" + +... Customer/BalanceTransferBody.schema.json +... ... BalanceTransferBody requires property "type" +... ... BalanceTransferBody requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/QuantityType.schema.json' + +... Customer/BalanceTransferRequest.schema.json +... ... BalanceTransferRequest requires property "type" +... ... BalanceTransferRequest requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PartyAccountRef.schema.json' + +... Customer/BalanceTransferStatusTypeModify.schema.json +... ... BalanceTransferStatusTypeModify requires property "type" +... ... BalanceTransferStatusTypeModify requires property "$id" + +... Customer/Bill.schema.json +... ... de-reference check: Token "#PaymentRef" does not exist. + +... Customer/BillingAccount.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Common/PartyAccount.schema.json' + +... Customer/Bucket.schema.json +... ... Bucket requires property "type" +... ... Bucket requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PartyAccountRef.schema.json' + +... Customer/BucketBalance.schema.json +... ... BucketBalance requires property "type" +... ... BucketBalance requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PartyAccountRef.schema.json' + +... Customer/BucketBalanceRef.schema.json +... ... BucketBalanceRef requires property "type" +... ... BucketBalanceRef requires property "$id" + +... Customer/CartItem.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PriceAlteration.schema.json' + +... Customer/CartPrice.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PriceAlteration.schema.json' + +... Customer/Customer.schema.json +... ... de-reference check: Token "#MediumCharacteristic" does not exist. + +... Customer/CustomerBill.schema.json +... ... de-reference check: Token "#PaymentRef" does not exist. + +... Customer/Disability.schema.json +... ... Disability requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/TimePeriod.schema.json' + +... Customer/OrderItem.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PriceAlteration.schema.json' + +... Customer/OrderItemPrice.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PriceAlteration.schema.json' + +... Customer/OrderPrice.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PriceAlteration.schema.json' + +... Customer/PaymentItem.schema.json +... ... de-reference check: Token "#PaymentRef" does not exist. + +... Customer/PaymentMethodRefOrValue.schema.json +... ... PaymentMethodRefOrValue requires property "type" +... ... PaymentMethodRefOrValue requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/RelatedPartyRef.schema.json' + +... Customer/PaymentRef.schema.json +... ... PaymentRef requires property "$id" +... ... de-reference check: Token "EntityRef" does not exist. + +... Customer/ProductOfferingQualificationItemRef.schema.json +... ... ProductOfferingQualificationItemRef requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/EntityRef.schema.json' + +... Customer/ProductOrder.schema.json +... ... ProductOrder requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/AgreementRef.schema.json' + +... Customer/ProductOrderItem.schema.json +... ... ProductOrderItem requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/ProductRefOrValue.schema.json' + +... Customer/Quote.schema.json +... ... Quote requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/AgreementRef.schema.json' + +... Customer/QuoteItem.schema.json +... ... QuoteItem requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/AttachmentRefOrValue.schema.json' + +... Customer/QuoteItemRef.schema.json +... ... QuoteItemRef requires property "$id" +... ... de-reference check: Token "EntityRef" does not exist. + +... Customer/QuotePrice.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PriceAlteration.schema.json' + +... Customer/QuoteRef.schema.json +... ... QuoteRef requires property "$id" +... ... de-reference check: Token "EntityRef" does not exist. + +... Customer/SearchTimeSlot.schema.json +... ... SearchTimeSlot requires property "$id" + +... Customer/ShoppingCart.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PriceAlteration.schema.json' + +... EngagedParty/Account.schema.json +... ... de-reference check: Token "#MediumCharacteristic" does not exist. + +... EngagedParty/AgreementSpecCharacteristic.schema.json +... ... de-reference check: Token "#Any" does not exist. + +... EngagedParty/AgreementSpecCharacteristicValue.schema.json +... ... de-reference check: Token "#Any" does not exist. + +... EngagedParty/AgreementSpecification.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/AttachmentRefOrValue.schema.json' + +... EngagedParty/Contact.schema.json +... ... de-reference check: Token "#MediumCharacteristic" does not exist. + +... EngagedParty/FinancialAccount.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Common/Account.schema.json' + +... EngagedParty/Individual.schema.json +... ... Individual requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/Disability.schema.json' + +... EngagedParty/IndividualIdentification.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/AttachmentRefOrValue.schema.json' + +... EngagedParty/LanguageAbility.schema.json +... ... LanguageAbility requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/Entity.schema.json' + +... EngagedParty/Organization.schema.json +... ... Organization requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/TimePeriod.schema.json' + +... EngagedParty/OrganizationChildRelationship.schema.json +... ... OrganizationChildRelationship requires property "$id" + +... EngagedParty/OrganizationIdentification.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/AttachmentRefOrValue.schema.json' + +... EngagedParty/OrganizationParentRelationship.schema.json +... ... OrganizationParentRelationship requires property "$id" + +... EngagedParty/OtherNameIndividual.schema.json +... ... OtherNameIndividual requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/TimePeriod.schema.json' + +... EngagedParty/OtherNameOrganization.schema.json +... ... OtherNameOrganization requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/TimePeriod.schema.json' + +... EngagedParty/Party.schema.json +... ... Party requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/Characteristic.schema.json' + +... EngagedParty/PartyAccount.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Common/Account.schema.json' + +... EngagedParty/PartyBill.schema.json +... ... de-reference check: Token "#PaymentRef" does not exist. + +... EngagedParty/PartyCreditProfile.schema.json +... ... PartyCreditProfile requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/TimePeriod.schema.json' + +... EngagedParty/PartyRole.schema.json +... ... required is not of a type(s) object,boolean +... ... de-reference check: Token "#MediumCharacteristic" does not exist. + +... EngagedParty/RelatedPartyRefOrValue.schema.json +... ... isRef property defined, but not included in required +... ... discriminator (isRef) defined but not included in 'required' property +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/ExternalReference.schema.json' + +... EngagedParty/SettlementAccount.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Common/PartyAccount.schema.json' + +... EngagedParty/Skill.schema.json +... ... Skill requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/TimePeriod.schema.json' + +... EngagedParty/TaxExemptionCertificate.schema.json +... ... TaxExemptionCertificate requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/AttachmentRefOrValue.schema.json' + +... MarketingSales/SalesLead.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'MarketingSales/SalesLeadStateType.schema.json' + +... Product/AlternateProductOfferingProposal.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Product/AgreementItemRef.schema.json' + +... Product/BaseProductRefOrValue.schema.json +... ... isRef property defined, but not included in required +... ... de-reference check: ENOENT: no such file or directory, open 'Product/Characteristic.schema.json' + +... Product/CancelOrder.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Product/TaskStateType.schema.json' + +... Product/CancelProductOrder.schema.json +... ... de-reference check: Token "#CancelOrder" does not exist. + +... Product/LoyaltyAccount.schema.json +... ... LoyaltyAccount additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyAccountRef.schema.json +... ... LoyaltyAccountRef additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyAction.schema.json +... ... LoyaltyAction additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyActionRef.schema.json +... ... LoyaltyActionRef additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyBalance.schema.json +... ... LoyaltyBalance additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyCondition.schema.json +... ... LoyaltyCondition additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyConditionRef.schema.json +... ... LoyaltyConditionRef additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyEvent.schema.json +... ... LoyaltyEvent additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyEventType.schema.json +... ... LoyaltyEventType additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyEventTypeRef.schema.json +... ... LoyaltyEventTypeRef additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyExecutionPoint.schema.json +... ... LoyaltyAccount additionalProperty "title" exists in instance when not allowed +... ... schema mismatch with title (LoyaltyExecutionPoint) and definitions (LoyaltyAccount) + +... Product/LoyaltyProgramMember.schema.json +... ... LoyaltyProgramMember requires property "$id" +... ... LoyaltyProgramMember additionalProperty "id" exists in instance when not allowed +... ... LoyaltyProgramMember additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyProgramMemberRef.schema.json +... ... LoyaltyProgramMemberRef requires property "$id" +... ... LoyaltyProgramMemberRef additionalProperty "id" exists in instance when not allowed +... ... LoyaltyProgramMemberRef additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyProgramProduct.schema.json +... ... LoyaltyProgramProduct requires property "$id" +... ... LoyaltyProgramProduct additionalProperty "id" exists in instance when not allowed +... ... LoyaltyProgramProduct additionalProperty "title" exists in instance when not allowed +... ... de-reference check: ENOENT: no such file or directory, open 'Product/Characteristic.schema.json' + +... Product/LoyaltyProgramProductRef.schema.json +... ... LoyaltyProgramProductRef requires property "$id" +... ... LoyaltyProgramProductRef additionalProperty "id" exists in instance when not allowed +... ... LoyaltyProgramProductRef additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyProgramProductSpec.schema.json +... ... LoyaltyProgramProductSpec additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyProgramProductSpecRef.schema.json +... ... LoyaltyProgramProductSpecRef additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyRule.schema.json +... ... LoyaltyRule additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyRuleAction.schema.json +... ... LoyaltyRuleAction additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyRuleCondition.schema.json +... ... LoyaltyRuleCondition additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyRuleEventType.schema.json +... ... LoyaltyRuleEventType additionalProperty "title" exists in instance when not allowed + +... Product/PriceAlteration.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Product/Price.schema.json' + +... Product/Product.schema.json +... ... Product requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Product/AgreementItemRef.schema.json' + +... Product/ProductOffering.schema.json +... ... de-reference check: Token "#ChannelRef" does not exist. + +... Product/ProductOfferingQualification.schema.json +... ... ProductOfferingQualification requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Product/ChannelRef.schema.json' + +... Product/ProductOfferingQualificationItem.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Product/TaskStateType.schema.json' + +... Product/ProductOfferingQualificationItemRef.schema.json +... ... ProductOfferingQualificationItemRef requires property "$id" +... ... de-reference check: Token "Entity" does not exist. + +... Product/ProductOfferingQualificationRef.schema.json +... ... ProductOfferingQualificationRef requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Product/EntityRef.schema.json' + +... Product/ProductPrice.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PriceAlteration.schema.json' + +... Product/ProductRefOrValue.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Product/AgreementItemRef.schema.json' + +... Product/ProductRelationship.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Product/AgreementItemRef.schema.json' + +... Product/ProductRequest.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Resource/EntityRef.schema.json' + +... Product/ProductRestriction.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Product/Characteristic.schema.json' + +... Product/ProductSpecification.schema.json +... ... de-reference check: Token "#AttachmentRefOrValue" does not exist. + +... Product/Recommendation.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Product/ProductOrderRef.schema.json' + +... Product/RelatedProductOrderItem.schema.json +... ... RelatedProductOrderItem requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Product/Entity.schema.json' + +... Resource/RealizingResourceRef.schema.json +... ... RealizingResourceRef requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Resource/EntityRef.schema.json' + +... Service/AlternateServiceProposal.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/ServiceRestriction.schema.json' + +... Service/ServiceOfferingQualificationRef.schema.json +... ... de-reference check: Token "#QualificationRef" does not exist. + +... Service/ServiceOrder.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/OrderItemRelationship.schema.json' + +... Service/ServiceOrderItem.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/OrderItemRelationship.schema.json' + +... Service/ServiceQualification.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/ServiceRestriction.schema.json' + +... Service/ServiceQualificationItem.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/ServiceRestriction.schema.json' + + +ISSUES - schemas with issue(s): +... Common/AlternateGeographicAddress.schema.json +... ... geographicLocation :: no description value +... ... geographicSubAddress :: no description value + +... Common/AssociationRoleSpec.schema.json +... ... aggregation :: no description value +... ... defaultQuantity :: no description value +... ... entityType :: no description value +... ... isNavigable :: no description value +... ... isSource :: no description value +... ... maxQuantity :: no description value +... ... minQuantity :: no description value +... ... role :: no description value + +... Common/AssociationSpecification.schema.json +... ... constraint :: no description value +... ... associationRoleSpec :: no description value + +... Common/BusinessInteraction.schema.json +... ... interactionData :: no description value +... ... interactionDataComplete :: no description value +... ... interactionDataStatus :: no description value + +... Common/CalendarEventRef.schema.json +... ... CalendarEventRef :: no properties defined + +... Common/CalendarPeriod.schema.json +... ... timeZone :: recommend to add format +... ... hourPeriod :: no description value + +... Common/ChangeRequest.schema.json +... ... workLog :: no description value +... ... incident :: no description value +... ... changeRequestSpecification :: no description value +... ... impactEntity :: no description value +... ... changeRequestCharacteristic :: no description value +... ... targetEntity :: no description value +... ... resolution :: no description value +... ... sla :: no description value +... ... relateChangeRequest :: no description value +... ... category :: no description value +... ... note :: no description value + +... Common/ChangeRequestSpecification.schema.json +... ... validFor :: no description value + +... Common/Channel.schema.json +... ... Channel :: should be renamed as ChannelRef if this is a reference entity + +... Common/CommonComponents.schema.json +... ... Failing to check for issues: TypeError: Cannot read property 'properties' of undefined + +... Common/CommunicationMessage.schema.json +... ... logFlag :: no description value +... ... tryTimes :: recommend to add format + +... Common/Document.schema.json +... ... binaryAttachment :: no description value +... ... category :: no description value +... ... documentRelationship :: no description value +... ... relatedObject :: no description value + +... Common/DocumentCharacteristic.schema.json +... ... value :: no description value + +... Common/DocumentRelationship.schema.json +... ... documentRef :: no description value + +... Common/EntitySpecRelationship.schema.json +... ... associationSpec :: no description value + +... Common/EntitySpecification.schema.json +... ... attachment :: no description value +... ... entitySchema :: no description value +... ... specCharacteristic :: no description value +... ... relatedParty :: no description value + +... Common/GeographicAddress.schema.json +... ... geographicLocation :: no description value +... ... geographicSubAddress :: no description value + +... Common/GeographicAddressValidation.schema.json +... ... validAddress :: no description value +... ... alternateGeographicAddress :: no description value + +... Common/GeographicLocation.schema.json +... ... accuracy :: no description value +... ... spatialRef :: no description value +... ... geometry :: no description value + +... Common/GeographicLocationRef.schema.json +... ... GeographicLocationRef :: no properties defined + +... Common/GeographicSite.schema.json +... ... relatedParty :: no description value +... ... calendar :: no description value +... ... geographicLocation :: no description value +... ... address :: no description value +... ... siteRelationship :: no description value + +... Common/Incident.schema.json +... ... Incident :: should be renamed as IncidentRef if this is a reference entity + +... Common/LocationCharacteristic.schema.json +... ... value :: no description value + +... Common/NetworkFunction.schema.json +... ... NetworkFunction :: should be renamed as NetworkFunctionRef if this is a reference entity + +... Common/Object.schema.json +... ... uri :: no description value + +... Common/Place.schema.json +... ... Place :: should be renamed as PlaceRef if this is a reference entity + +... Common/PlaceRef.schema.json +... ... PlaceRef :: no properties defined + +... Common/Receiver.schema.json +... ... party :: no description value + +... Common/Resolution.schema.json +... ... task :: no description value + +... Common/RetrieveGeographicLocation.schema.json +... ... requestedAccuracy :: no description value +... ... status :: no description value +... ... time :: no description value +... ... geographicLocation :: no description value +... ... thing :: no description value + +... Common/RetrieveLocationRelation.schema.json +... ... distance :: no description value +... ... status :: no description value +... ... time :: no description value +... ... intersection :: no description value +... ... location :: no description value + +... Common/Sender.schema.json +... ... party :: no description value + +... Common/SpecCharacteristic.schema.json +... ... specCharacteristicValue :: no description value +... ... specCharRelationship :: no description value + +... Common/TroubleTicketRef.schema.json +... ... TroubleTicketRef :: no properties defined + +... Common/Value.schema.json +... ... Value :: no properties defined + +... Common/WorkLog.schema.json +... ... lastUpdateDateTime :: recommend to add format +... ... lastUpdateDateTime :: recommend to add format +... ... record :: no description value + +... Customer/AppliedBillingRate.schema.json +... ... appliedTax :: no description value +... ... bill :: no description value +... ... characteristic :: no description value + +... Customer/AppliedCustomerBillingRate.schema.json +... ... appliedTax :: no description value +... ... bill :: no description value +... ... characteristic :: no description value + +... Customer/AppliedPartyBillingRate.schema.json +... ... appliedTax :: no description value +... ... bill :: no description value +... ... characteristic :: no description value + +... Customer/Authorization.schema.json +... ... approver :: no description value + +... Customer/BalanceDeduct.schema.json +... ... relatedParty :: no description value +... ... product :: no description value +... ... balanceReserve :: no description value +... ... requestor :: no description value +... ... partyAccount :: no description value + +... Customer/BalanceDeductRollback.schema.json +... ... relatedParty :: no description value +... ... product :: no description value +... ... partyAccount :: no description value +... ... balanceDeduct :: no description value +... ... requestor :: no description value + +... Customer/BalanceReserve.schema.json +... ... requestor :: no description value +... ... product :: no description value +... ... relatedParty :: no description value +... ... partyAccount :: no description value + +... Customer/BalanceUnreserve.schema.json +... ... balanceReserve :: no description value +... ... relatedParty :: no description value +... ... requestor :: no description value +... ... product :: no description value + +... Customer/BankCardMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/BillFormat.schema.json +... ... BillFormat :: should be renamed as BillFormatRef if this is a reference entity + +... Customer/BillFormatRefOrValue.schema.json +... ... isRef :: no description value + +... Customer/BillPresentationMedia.schema.json +... ... BillPresentationMedia :: should be renamed as BillPresentationMediaRef if this is a reference entity + +... Customer/BillPresentationMediaRefOrValue.schema.json +... ... isRef :: no description value + +... Customer/BillStructure.schema.json +... ... presentationMedia :: no description value +... ... format :: no description value +... ... cycleSpecification :: no description value + +... Customer/BillingCycleSpecification.schema.json +... ... billingDateShift :: recommend to add format +... ... chargeDateOffset :: recommend to add format +... ... creditDateOffset :: recommend to add format +... ... mailingDateOffset :: recommend to add format +... ... paymentDueDateOffset :: recommend to add format + +... Customer/BillingCycleSpecificationRef.schema.json +... ... dateShift :: recommend to add format + +... Customer/BillingCycleSpecificationRefOrValue.schema.json +... ... isRef :: no description value + +... Customer/CartItemRelationship.schema.json +... ... cartItem :: no description value + +... Customer/CartTerm.schema.json +... ... description :: no description value +... ... duration :: no description value + +... Customer/CashDetails.schema.json +... ... CashDetails :: no properties defined + +... Customer/CashMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/CheckMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/DigitalWalletMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/OrderItemRelationship.schema.json +... ... OrderItemRelationship :: should be renamed as OrderItemRelationshipRef if this is a reference entity + +... Customer/OrderRelationship.schema.json +... ... OrderRelationship :: should be renamed as OrderRelationshipRef if this is a reference entity + +... Customer/PaymentMethod.schema.json +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/PaymentPlan.schema.json +... ... paymentMethod :: no description value + +... Customer/ProductOrderRef.schema.json +... ... ProductOrderRef :: no properties defined + +... Customer/QuoteItemRelationship.schema.json +... ... QuoteItemRelationship :: should be renamed as QuoteItemRelationshipRef if this is a reference entity + +... Customer/SettlementNoteAdvice.schema.json +... ... settlementMethod :: no description value +... ... settlementNoteImage :: no description value +... ... receiver :: no description value +... ... taxItem :: no description value +... ... issuer :: no description value +... ... settlementNoteItem :: no description value + +... Customer/SettlementNoteImage.schema.json +... ... imageFileURL :: recommend to add format + +... Customer/SettlementNoteItem.schema.json +... ... period :: no description value +... ... taxItem :: no description value + +... Customer/TokenizedCardMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/VoucherMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/AccountDirectDetails.schema.json +... ... AccountDirectDetails :: should be renamed as AccountDirectDetailsRef if this is a reference entity +... ... account :: no description value + +... EngagedParty/AccountDirectMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/AccountRelationship.schema.json +... ... account :: no description value + +... EngagedParty/AccountTaxExemption.schema.json +... ... issuingJurisdiction :: recommend to add format + +... EngagedParty/Agreement.schema.json +... ... completionDate :: recommend to add format +... ... agreementSpecification :: no description value +... ... agreementItem :: no description value +... ... engagedPartyRole :: no description value +... ... agreementAuthorization :: no description value +... ... characteristic :: no description value +... ... associatedAgreement :: no description value + +... EngagedParty/AgreementItem.schema.json +... ... productOffering :: no description value +... ... termOrCondition :: no description value + +... EngagedParty/BankAccountDebitMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/BankAccountTransferMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/FinancialAccountRef.schema.json +... ... accountBalance :: no description value + +... EngagedParty/OrganizationRef.schema.json +... ... OrganizationRef :: no properties defined + +... EngagedParty/PartnershipType.schema.json +... ... roleType :: no description value + +... EngagedParty/PartyRef.schema.json +... ... PartyRef :: no properties defined + +... EngagedParty/RoleType.schema.json +... ... agreementSpecification :: no description value + +... EngagedParty/Rule.schema.json +... ... consequence :: no description value +... ... metric :: no description value +... ... operator :: no description value +... ... referenceValue :: no description value +... ... tolerance :: no description value +... ... unit :: no description value + +... EngagedParty/RuleRef.schema.json +... ... description :: no description value + +... EngagedParty/SLA.schema.json +... ... approvalDate :: no description value +... ... approved :: no description value +... ... rule :: no description value +... ... relatedParty :: no description value +... ... template :: no description value + +... EngagedParty/SLAViolation.schema.json +... ... date :: no description value +... ... relatedParty :: no description value +... ... violation :: no description value +... ... sla :: no description value + +... EngagedParty/TemplateRef.schema.json +... ... description :: no description value + +... EngagedParty/Violation.schema.json +... ... actualValue :: no description value +... ... comment :: no description value +... ... consequence :: no description value +... ... operator :: no description value +... ... referenceValue :: no description value +... ... tolerance :: no description value +... ... unit :: no description value +... ... violationAverage :: no description value +... ... attachment :: no description value +... ... rule :: no description value + +... MarketingSales/MarketingCampaignRef.schema.json +... ... MarketingCampaignRef :: no properties defined + +... MarketingSales/SalesOpportunityRef.schema.json +... ... SalesOpportunityRef :: no properties defined + +... Product/BundledProductOfferingPriceRelationship.schema.json +... ... BundledProductOfferingPriceRelationship :: should be renamed as BundledProductOfferingPriceRelationshipRef if this is a reference entity + +... Product/BundledProductSpecification.schema.json +... ... BundledProductSpecification :: should be renamed as BundledProductSpecificationRef if this is a reference entity + +... Product/ProductInventoryRelationship.schema.json +... ... product :: no description value + +... Product/ProductOfferingPriceRef.schema.json +... ... ProductOfferingPriceRef :: no properties defined + +... Product/ProductOfferingPriceRelationship.schema.json +... ... ProductOfferingPriceRelationship :: should be renamed as ProductOfferingPriceRelationshipRef if this is a reference entity + +... Product/ProductOfferingRef.schema.json +... ... ProductOfferingRef :: no properties defined + +... Product/ProductRef.schema.json +... ... ProductRef :: no properties defined + +... Product/ProductSpecCharacteristic.schema.json +... ... productSpecCharRelationship :: no description value +... ... productSpecCharacteristicValue :: no description value + +... Product/Promotion.schema.json +... ... pattern :: no description value + +... Product/PromotionCriteriaGroup.schema.json +... ... criteria :: no description value + +... Product/PromotionPattern.schema.json +... ... action :: no description value +... ... criteriaGroup :: no description value + +... Product/QualificationItemRelationship.schema.json +... ... QualificationItemRelationship :: should be renamed as QualificationItemRelationshipRef if this is a reference entity + +... Product/Usage.schema.json +... ... usageSpecification :: no description value +... ... usageCharacteristic :: no description value +... ... relatedParty :: no description value +... ... ratedProductUsage :: no description value + +... Product/UsageConsumptionReport.schema.json +... ... relatedParty :: no description value + +... Product/UsageSpecCharacteristic.schema.json +... ... usageSpecCharacteristicValue :: no description value + +... Product/UsageSpecification.schema.json +... ... usageSpecCharacteristic :: no description value + +... Product/UsageVolumeProduct.schema.json +... ... bucketBalance :: no description value +... ... bucketCounter :: no description value +... ... product :: no description value + +... Resource/LogicalResource.schema.json +... ... resourceRelationship :: no description value +... ... characteristic :: no description value +... ... place :: no description value +... ... partyRole :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/PhysicalResource.schema.json +... ... resourceRelationship :: no description value +... ... characteristic :: no description value +... ... place :: no description value +... ... partyRole :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/Resource.schema.json +... ... resourceRelationship :: no description value +... ... characteristic :: no description value +... ... place :: no description value +... ... partyRole :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/ResourceAlarmRef.schema.json +... ... changeRequest :: no description value + +... Resource/ResourceOrder.schema.json +... ... orderRelationship :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/ResourceOrderItem.schema.json +... ... resourceSpecification :: no description value +... ... orderItemRelationship :: no description value + +... Resource/ResourceOrderItemRelationship.schema.json +... ... orderItem :: no description value + +... Resource/ResourceOrderRelationship.schema.json +... ... resourceOrder :: no description value +... ... serviceOrder :: no description value + +... Resource/SupportingResource.schema.json +... ... SupportingResource :: should be renamed as SupportingResourceRef if this is a reference entity + +... Service/FirstAlert.schema.json +... ... FirstAlert :: should be renamed as FirstAlertRef if this is a reference entity + +... Service/Service.schema.json +... ... serviceDate :: recommend to add format + +... Service/ServiceCategory.schema.json +... ... serviceCandidate :: recommend to add format + +... Service/ServiceLevelObjective.schema.json +... ... graceTimes :: recommend to add format + +... Service/ServiceOrderItemRelationship.schema.json +... ... ServiceOrderItemRelationship :: should be renamed as ServiceOrderItemRelationshipRef if this is a reference entity + +... Service/ServiceQualificationItemRelationship.schema.json +... ... ServiceQualificationItemRelationship :: should be renamed as ServiceQualificationItemRelationshipRef if this is a reference entity + +... Service/ServiceQualificationRelationship.schema.json +... ... ServiceQualificationRelationship :: should be renamed as ServiceQualificationRelationshipRef if this is a reference entity + +... Service/ServiceRef.schema.json +... ... ServiceRef :: no properties defined + +... Service/SupportingService.schema.json +... ... SupportingService :: should be renamed as SupportingServiceRef if this is a reference entity + +... Common/ExternalReference.schema.json +... ... ExternalReference :: should be renamed as ExternalReferenceRef if this is a reference entity + +... Common/RelatedGeographicAddressRefOrValue.schema.json +... ... isRef :: no description value +... ... role :: no description value + +... Common/RelatedGeographicLocationRefOrValue.schema.json +... ... isRef :: no description value +... ... role :: no description value + +... Common/RelatedPlaceRefOrValue.schema.json +... ... role :: no description value + +... Common/Street.schema.json +... ... characteristic :: no description value +... ... address :: no description value + +... Common/StreetSegment.schema.json +... ... address :: no description value + +... Common/TicketRelationship.schema.json +... ... product :: no description value + +... Common/TroubleTicketRelationship.schema.json +... ... troubleTicket :: no description value + +... Customer/Appointment.schema.json +... ... attachment :: no description value +... ... contactMedium :: no description value +... ... note :: no description value +... ... relatedEntity :: no description value +... ... relatedParty :: no description value +... ... status :: no description value +... ... validFor :: no description value + +... Customer/BalanceActivity.schema.json +... ... date :: recommend to add format +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceAdjustmentBody.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceAdjustmentRequest.schema.json +... ... requestedDate :: recommend to add format + +... Customer/BalanceTopupBody.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceTopupRequest.schema.json +... ... confirmationDate :: recommend to add format +... ... requestedDate :: recommend to add format + +... Customer/BalanceTopupStatus.schema.json +... ... Failing to check for issues: TypeError: Cannot read property 'properties' of undefined + +... Customer/BalanceTopupStatusTypeModify.schema.json +... ... BalanceTopupStatusTypeModify :: should be renamed as BalanceTopupStatusTypeModifyRef if this is a reference entity + +... Customer/BalanceTransferBody.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceTransferRequest.schema.json +... ... confirmationDate :: recommend to add format +... ... requestedDate :: recommend to add format + +... Customer/BalanceTransferStatusTypeModify.schema.json +... ... BalanceTransferStatusTypeModify :: should be renamed as BalanceTransferStatusTypeModifyRef if this is a reference entity +... ... status :: no description value + +... Customer/Bill.schema.json +... ... billingAccount :: no description value +... ... taxItem :: no description value +... ... paymentMethod :: no description value +... ... relatedParty :: no description value +... ... financialAccount :: no description value + +... Customer/BillingAccount.schema.json +... ... BillingAccount :: no properties defined + +... Customer/CartItem.schema.json +... ... itemTerm :: no description value +... ... cartItem :: no description value +... ... note :: no description value +... ... ItemTotalPrice :: no description value +... ... product :: no description value +... ... itemPrice :: no description value +... ... productOffering :: no description value +... ... cartItemRelationship :: no description value + +... Customer/CartPrice.schema.json +... ... price :: no description value +... ... priceAlteration :: no description value + +... Customer/Customer.schema.json +... ... engagedParty :: no description value +... ... roleType :: no description value +... ... account :: no description value +... ... paymentMethod :: no description value +... ... contactMedium :: no description value +... ... creditProfile :: no description value +... ... agreement :: no description value +... ... relatedParty :: no description value + +... Customer/CustomerBill.schema.json +... ... billingAccount :: no description value +... ... taxItem :: no description value +... ... paymentMethod :: no description value +... ... relatedParty :: no description value +... ... financialAccount :: no description value + +... Customer/Disability.schema.json +... ... validFor :: no description value + +... Customer/OrderItem.schema.json +... ... appointment :: no description value +... ... billingAccount :: no description value +... ... itemPrice :: no description value +... ... orderItem :: no description value +... ... orderItemRelationship :: no description value +... ... itemTotalPrice :: no description value +... ... payment :: no description value +... ... productOffering :: no description value +... ... product :: no description value +... ... qualification :: no description value +... ... itemTerm :: no description value + +... Customer/OrderItemPrice.schema.json +... ... productOfferingPrice :: no description value +... ... billingAccount :: no description value +... ... price :: no description value +... ... priceAlteration :: no description value + +... Customer/PaymentItem.schema.json +... ... payment :: no description value + +... Customer/PaymentMethodRefOrValue.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/ProductOrder.schema.json +... ... billingAccount :: no description value +... ... channel :: no description value +... ... note :: no description value +... ... orderTotalPrice :: no description value +... ... payment :: no description value +... ... productOfferingQualification :: no description value +... ... quote :: no description value +... ... productOrderItem :: no description value +... ... relatedParty :: no description value + +... Customer/ProductOrderItem.schema.json +... ... appointment :: no description value +... ... billingAccount :: no description value +... ... itemPrice :: no description value +... ... itemTerm :: no description value +... ... itemTotalPrice :: no description value +... ... payment :: no description value +... ... product :: no description value +... ... productOffering :: no description value +... ... productOfferingQualificationItem :: no description value +... ... quoteItem :: no description value +... ... productOrderItem :: no description value +... ... productOrderItemRelationship :: no description value +... ... qualification :: no description value + +... Customer/QuoteItem.schema.json +... ... product :: no description value +... ... productOffering :: no description value + +... Customer/QuotePrice.schema.json +... ... priceAlteration :: no description value +... ... price :: no description value + +... Customer/QuoteRef.schema.json +... ... QuoteRef :: no properties defined + +... Customer/SearchTimeSlot.schema.json +... ... requestedTimeSlot :: no description value +... ... requestedTimeSlot :: recommend to add format +... ... availableTimeSlot :: no description value +... ... availableTimeSlot :: recommend to add format +... ... relatedEntity :: no description value + +... Customer/ShoppingCart.schema.json +... ... contactMedium :: no description value +... ... cartItem :: no description value +... ... relatedParty :: no description value + +... EngagedParty/Account.schema.json +... ... relatedParty :: no description value +... ... taxExemption :: no description value +... ... contact :: no description value +... ... accountBalance :: no description value +... ... accountRelationship :: no description value + +... EngagedParty/AgreementSpecCharacteristic.schema.json +... ... specCharacteristicValue :: no description value + +... EngagedParty/AgreementSpecification.schema.json +... ... serviceCategory :: no description value +... ... specificationCharacteristic :: no description value +... ... relatedParty :: no description value +... ... attachment :: no description value +... ... specificationRelationship :: no description value + +... EngagedParty/Contact.schema.json +... ... contactMedium :: no description value +... ... relatedParty :: no description value + +... EngagedParty/FinancialAccount.schema.json +... ... FinancialAccount :: no properties defined + +... EngagedParty/Individual.schema.json +... ... otherName :: no description value +... ... individualIdentification :: no description value +... ... disability :: no description value +... ... languageAbility :: no description value +... ... skill :: no description value + +... EngagedParty/IndividualIdentification.schema.json +... ... attachment :: no description value + +... EngagedParty/LanguageAbility.schema.json +... ... isFavouriteLanguage :: recommend to add format +... ... validFor :: no description value + +... EngagedParty/Organization.schema.json +... ... existsDuring :: no description value +... ... existsDuring :: recommend to add format +... ... otherName :: no description value +... ... organizationIdentification :: no description value +... ... organizationChildRelationship :: no description value +... ... organizationParentRelationship :: no description value + +... EngagedParty/OrganizationChildRelationship.schema.json +... ... organization :: no description value + +... EngagedParty/OrganizationIdentification.schema.json +... ... attachment :: no description value + +... EngagedParty/OrganizationParentRelationship.schema.json +... ... organization :: no description value + +... EngagedParty/OtherNameIndividual.schema.json +... ... validFor :: no description value + +... EngagedParty/OtherNameOrganization.schema.json +... ... validFor :: no description value + +... EngagedParty/Party.schema.json +... ... externalReference :: no description value +... ... partyCharacteristic :: no description value +... ... taxExemptionCertificate :: no description value +... ... creditRating :: no description value +... ... relatedParty :: no description value +... ... contactMedium :: no description value + +... EngagedParty/PartyAccount.schema.json +... ... billStructure :: no description value +... ... paymentPlan :: no description value +... ... financialAccount :: no description value +... ... defaultPaymentMethod :: no description value + +... EngagedParty/PartyBill.schema.json +... ... billingAccount :: no description value +... ... taxItem :: no description value +... ... paymentMethod :: no description value +... ... relatedParty :: no description value +... ... financialAccount :: no description value + +... EngagedParty/PartyCreditProfile.schema.json +... ... validFor :: no description value + +... EngagedParty/PartyRole.schema.json +... ... engagedParty :: no description value +... ... roleType :: no description value +... ... account :: no description value +... ... paymentMethod :: no description value +... ... contactMedium :: no description value +... ... creditProfile :: no description value +... ... agreement :: no description value +... ... relatedParty :: no description value + +... EngagedParty/RelatedPartyRefOrValue.schema.json +... ... isRef :: no description value +... ... role :: no description value + +... EngagedParty/SettlementAccount.schema.json +... ... SettlementAccount :: no properties defined + +... EngagedParty/Skill.schema.json +... ... validFor :: no description value + +... EngagedParty/TaxExemptionCertificate.schema.json +... ... taxDefinition :: no description value +... ... validFor :: no description value +... ... attachment :: no description value + +... MarketingSales/SalesLead.schema.json +... ... status :: no description value +... ... type :: rename to avoid conflict with @type +... ... priority :: no description value +... ... channel :: no description value +... ... productOffering :: no description value +... ... relatedParty :: no description value +... ... prospectContact :: no description value +... ... productSpecification :: no description value +... ... category :: no description value +... ... salesOpportunity :: no description value +... ... product :: no description value +... ... note :: no description value + +... Product/BaseProductRefOrValue.schema.json +... ... productCharacteristic :: no description value +... ... realizingResource :: no description value +... ... realizingService :: no description value +... ... productRelationship :: no description value +... ... relatedParty :: no description value +... ... productSpecification :: no description value +... ... relatedPlace :: no description value + +... Product/CancelProductOrder.schema.json +... ... CancelProductOrder :: should be renamed as CancelProductOrderRef if this is a reference entity +... ... productOrder :: no description value + +... Product/LoyaltyAccount.schema.json +... ... LoyaltyAccount :: should be renamed as LoyaltyAccountRef if this is a reference entity +... ... loyaltyProgramProduct :: no description value + +... Product/LoyaltyAction.schema.json +... ... type :: rename to avoid conflict with @type + +... Product/LoyaltyEvent.schema.json +... ... eventId :: no description value +... ... eventTime :: recommend to add format + +... Product/LoyaltyEventType.schema.json +... ... LoyaltyEventType :: should be renamed as LoyaltyEventTypeRef if this is a reference entity + +... Product/LoyaltyExecutionPoint.schema.json +... ... Failing to check for issues: TypeError: Cannot read property 'properties' of undefined + +... Product/LoyaltyProgramProduct.schema.json +... ... loyaltyProgramProductSpec :: no description value +... ... loyaltyAccount :: no description value +... ... validFor :: no description value + +... Product/LoyaltyProgramProductSpec.schema.json +... ... productNumber :: no description value +... ... ValidFor :: no description value + +... Product/LoyaltyRuleAction.schema.json +... ... LoyaltyRuleAction :: should be renamed as LoyaltyRuleActionRef if this is a reference entity + +... Product/LoyaltyRuleCondition.schema.json +... ... LoyaltyRuleCondition :: should be renamed as LoyaltyRuleConditionRef if this is a reference entity + +... Product/LoyaltyRuleEventType.schema.json +... ... LoyaltyRuleEventType :: should be renamed as LoyaltyRuleEventTypeRef if this is a reference entity + +... Product/PriceAlteration.schema.json +... ... productOfferingPrice :: no description value +... ... price :: no description value + +... Product/Product.schema.json +... ... agreement :: no description value +... ... billingAccount :: no description value +... ... productCharacteristic :: no description value +... ... productOffering :: no description value +... ... productOrderItem :: no description value +... ... product :: no description value +... ... productPrice :: no description value +... ... productRelationship :: no description value +... ... productSpecification :: no description value +... ... productTerm :: no description value +... ... realizingResource :: no description value +... ... realizingService :: no description value +... ... relatedParty :: no description value +... ... place :: no description value + +... Product/ProductOffering.schema.json +... ... serviceCandidate :: recommend to add format +... ... resourceCandidate :: recommend to add format + +... Product/ProductOfferingQualificationItem.schema.json +... ... eligibilityUnavailabilityReason :: no description value +... ... category :: no description value +... ... qualificationItemRelationship :: no description value +... ... note :: no description value +... ... product :: no description value +... ... terminationError :: no description value +... ... productOffering :: no description value +... ... alternateProductOfferingProposal :: no description value + +... Product/ProductOfferingQualificationRef.schema.json +... ... ProductOfferingQualificationRef :: no properties defined + +... Product/ProductPrice.schema.json +... ... productOfferingPrice :: no description value +... ... billingAccount :: no description value +... ... productPriceAlteration :: no description value +... ... price :: no description value + +... Product/ProductRefOrValue.schema.json +... ... ProductRefOrValue :: no properties defined + +... Product/ProductRelationship.schema.json +... ... product :: no description value + +... Product/ProductRequest.schema.json +... ... referredProduct :: no description value +... ... realizingService :: no description value +... ... billingAccount :: no description value +... ... productOffering :: no description value +... ... agreement :: no description value +... ... characteristic :: no description value +... ... productRelationship :: no description value +... ... realizingResource :: no description value +... ... relatedParty :: no description value +... ... productPrice :: no description value +... ... productSpecification :: no description value +... ... place :: no description value + +... Product/ProductRestriction.schema.json +... ... productCharacteristic :: no description value +... ... productRelationship :: no description value +... ... relatedParty :: no description value +... ... productSpecification :: no description value +... ... relatedPlace :: no description value + +... Product/Recommendation.schema.json +... ... description :: no description value +... ... order :: no description value +... ... channel :: no description value +... ... party :: no description value +... ... item :: no description value + +... Resource/RealizingResourceRef.schema.json +... ... RealizingResourceRef :: no properties defined + +... Service/AlternateServiceProposal.schema.json +... ... alternateService :: no description value + +... Service/ServiceOrder.schema.json +... ... orderDate :: no description value + +error: TypeError: fd must be a file descriptor From c958b5329926bc520cd472922e50cfca662209a4 Mon Sep 17 00:00:00 2001 From: Test results Date: Mon, 15 Jul 2019 15:33:05 +0200 Subject: [PATCH 02/11] First run --- Common/AlternateGeographicAddress.schema.json | 176 +++++++++--------- Common/AssociationRole.schema.json | 72 +++---- Common/AssociationSpecRef.schema.json | 56 +++--- Common/DocumentRelationship.schema.json | 46 ++--- Common/EntityCatalog.schema.json | 98 +++++----- Common/EntityCategory.schema.json | 114 ++++++------ Common/ExternalReference.schema.json | 45 ++--- Common/GeographicPoint.schema.json | 56 +++--- Common/GeographicSiteRef.schema.json | 50 ++--- Common/Money.schema.json | 50 ++--- Common/NetworkFunction.schema.json | 32 ++-- ...tedGeographicAddressRefOrValue.schema.json | 56 +++--- Common/RelatedPlaceRefOrValue.schema.json | 53 +++--- Common/StringCharacteristic.schema.json | 46 ++--- Common/TimePeriod.schema.json | 68 +++---- 15 files changed, 508 insertions(+), 510 deletions(-) diff --git a/Common/AlternateGeographicAddress.schema.json b/Common/AlternateGeographicAddress.schema.json index 5bc5de50..6b89f451 100644 --- a/Common/AlternateGeographicAddress.schema.json +++ b/Common/AlternateGeographicAddress.schema.json @@ -1,91 +1,91 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AlternateGeographicAddress.schema.json", - "title": "AlternateGeographicAddress", - "definitions": { - "AlternateGeographicAddress": { - "$id": "#AlternateGeographicAddress", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "An URI used to access to the address resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of the address" - }, - "name": { - "type": "string", - "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" - }, - "role": { - "type": "string", - "description": "Role of the place, such as: [home delivery], [shop retrieval])" - }, - "city": { - "type": "string", - "description": "City that the address is in" - }, - "country": { - "type": "string", - "description": "Country that the address is in" - }, - "locality": { - "type": "string", - "description": "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature. [ANZLIC-STREET], or a suburb, a bounded locality within a city, town or shire principally of urban character [ANZLICSTREET]" - }, - "postcode": { - "type": "string", - "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" - }, - "stateOrProvince": { - "type": "string", - "description": "the State or Province that the address is in" - }, - "streetName": { - "type": "string", - "description": "Name of the street or other street type" - }, - "streetNr": { - "type": "string", - "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" - }, - "streetNrLast": { - "type": "string", - "description": "Last number in a range of street numbers allocated to a property" - }, - "streetNrLastSuffix": { - "type": "string", - "description": "Last street number suffix for a ranged address" - }, - "streetNrSuffix": { - "type": "string", - "description": "the first street number suffix" - }, - "streetSuffix": { - "type": "string", - "description": "A modifier denoting a relative direction" - }, - "streetType": { - "type": "string", - "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf " - }, - "geographicLocation": { - "$ref": "GeographicLocation.schema.json#GeographicLocation" - }, - "geographicSubAddress": { - "type": "array", - "items": { - "$ref": "GeographicSubAddress.schema.json#GeographicSubAddress" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AlternateGeographicAddress.schema.json", + "title": "AlternateGeographicAddress", + "definitions": { + "AlternateGeographicAddress": { + "$id": "#AlternateGeographicAddress", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "An URI used to access to the address resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of the address" + }, + "name": { + "type": "string", + "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" + }, + "role": { + "type": "string", + "description": "Role of the place, such as: [home delivery], [shop retrieval])" + }, + "city": { + "type": "string", + "description": "City that the address is in" + }, + "country": { + "type": "string", + "description": "Country that the address is in" + }, + "locality": { + "type": "string", + "description": "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature. [ANZLIC-STREET], or a suburb, a bounded locality within a city, town or shire principally of urban character [ANZLICSTREET]" + }, + "postcode": { + "type": "string", + "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" + }, + "stateOrProvince": { + "type": "string", + "description": "the State or Province that the address is in" + }, + "streetName": { + "type": "string", + "description": "Name of the street or other street type" + }, + "streetNr": { + "type": "string", + "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" + }, + "streetNrLast": { + "type": "string", + "description": "Last number in a range of street numbers allocated to a property" + }, + "streetNrLastSuffix": { + "type": "string", + "description": "Last street number suffix for a ranged address" + }, + "streetNrSuffix": { + "type": "string", + "description": "the first street number suffix" + }, + "streetSuffix": { + "type": "string", + "description": "A modifier denoting a relative direction" + }, + "streetType": { + "type": "string", + "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf " + }, + "geographicLocation": { + "$ref": "GeographicLocation.schema.json#GeographicLocation" + }, + "geographicSubAddress": { + "type": "array", + "items": { + "$ref": "GeographicSubAddress.schema.json#GeographicSubAddress" + } } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/AssociationRole.schema.json b/Common/AssociationRole.schema.json index 2300cebb..6ebcddc4 100644 --- a/Common/AssociationRole.schema.json +++ b/Common/AssociationRole.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AssociationRole.schema.json", - "title": "AssociationRole", - "definitions": { - "AssociationRole": { - "$id": "#AssociationRole", - "description": "This embedded object represents the role and type of each entity involved in a relationship.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink reference to the endpoint plays this association role" - }, - "id": { - "type": "string", - "description": "The identifier of the endpoint plays this role" - }, - "isSource": { - "type": "boolean", - "description": "A flag indicating if the participant involved in a uni-directional relationship is the source or not. this flag is true If the association is bi-directional (both end points are navigable)" - }, - "name": { - "type": "string", - "description": "Name of the endpoint which plays this association role" - }, - "role": { - "type": "string", - "description": "The association role of this relationship participant as defined in the associationRoleSpec" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AssociationRole.schema.json", + "title": "AssociationRole", + "definitions": { + "AssociationRole": { + "$id": "#AssociationRole", + "description": "This embedded object represents the role and type of each entity involved in a relationship.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink reference to the endpoint plays this association role" + }, + "id": { + "type": "string", + "description": "The identifier of the endpoint plays this role" + }, + "isSource": { + "type": "boolean", + "description": "A flag indicating if the participant involved in a uni-directional relationship is the source or not. this flag is true If the association is bi-directional (both end points are navigable)" + }, + "name": { + "type": "string", + "description": "Name of the endpoint which plays this association role" + }, + "role": { + "type": "string", + "description": "The association role of this relationship participant as defined in the associationRoleSpec" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/AssociationSpecRef.schema.json b/Common/AssociationSpecRef.schema.json index 13274a84..cc3fd459 100644 --- a/Common/AssociationSpecRef.schema.json +++ b/Common/AssociationSpecRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AssociationSpecRef.schema.json", - "title": "AssociationSpecRef", - "definitions": { - "AssociationSpecRef": { - "$id": "#AssociationSpecRef", - "description": "reference to an AssociationSpecification object", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink reference to the target AssociationSpecification" - }, - "id": { - "type": "string", - "description": "reference id to the target AssociationSpecification" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AssociationSpecRef.schema.json", + "title": "AssociationSpecRef", + "definitions": { + "AssociationSpecRef": { + "$id": "#AssociationSpecRef", + "description": "reference to an AssociationSpecification object", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink reference to the target AssociationSpecification" + }, + "id": { + "type": "string", + "description": "reference id to the target AssociationSpecification" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/DocumentRelationship.schema.json b/Common/DocumentRelationship.schema.json index bac0d932..2c118cfa 100644 --- a/Common/DocumentRelationship.schema.json +++ b/Common/DocumentRelationship.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DocumentRelationship.schema.json", - "title": "DocumentRelationship", - "definitions": { - "DocumentRelationship": { - "$id": "#DocumentRelationship", - "description": "Another document that is related to the current document;", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "The type of relationship" - }, - "documentRef": { - "$ref": "DocumentRef.schema.json#DocumentRef" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DocumentRelationship.schema.json", + "title": "DocumentRelationship", + "definitions": { + "DocumentRelationship": { + "$id": "#DocumentRelationship", + "description": "Another document that is related to the current document;", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of relationship" + }, + "documentRef": { + "$ref": "DocumentRef.schema.json#DocumentRef" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/EntityCatalog.schema.json b/Common/EntityCatalog.schema.json index dfa67e78..28b68431 100644 --- a/Common/EntityCatalog.schema.json +++ b/Common/EntityCatalog.schema.json @@ -1,52 +1,52 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntityCatalog.schema.json", - "title": "EntityCatalog", - "definitions": { - "EntityCatalog": { - "$id": "#EntityCatalog", - "description": "The root entity for entity catalog management. An entity catalog can be defined as a collection of entity catalog items and arranging them in a particular manner based on the need.\nIn comparison to Product, Service and Resource catalogs, the entity catalog is intended for the purpose of providing any SID entity to consumers via a catalog, with its specification and policy providing governance over its content. Even Entity catalog may have an overlap with Product, Service or Resource catalog, it does not replace them. It is primarily intended to address those SID entities which may not be addressed by any of Product, Service or Resource catalog.\nAn entity catalog comprises of a list of RootEntities made available through EntityCatalogItems. This API addresses only RootEntity extended items as EntitySpecification. An entity catalog typically includes name, description and time period that it is valid for.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of this catalog" - }, - "href": { - "type": "string", - "description": "Unique reference of the catalog" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Catalog" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the catalog" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which the catalog is valid" - }, - "version": { - "type": "string", - "description": "Catalog version" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntityCatalog.schema.json", + "title": "EntityCatalog", + "definitions": { + "EntityCatalog": { + "$id": "#EntityCatalog", + "description": "The root entity for entity catalog management. An entity catalog can be defined as a collection of entity catalog items and arranging them in a particular manner based on the need.\nIn comparison to Product, Service and Resource catalogs, the entity catalog is intended for the purpose of providing any SID entity to consumers via a catalog, with its specification and policy providing governance over its content. Even Entity catalog may have an overlap with Product, Service or Resource catalog, it does not replace them. It is primarily intended to address those SID entities which may not be addressed by any of Product, Service or Resource catalog.\nAn entity catalog comprises of a list of RootEntities made available through EntityCatalogItems. This API addresses only RootEntity extended items as EntitySpecification. An entity catalog typically includes name, description and time period that it is valid for.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of this catalog" + }, + "href": { + "type": "string", + "description": "Unique reference of the catalog" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Catalog" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the catalog" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which the catalog is valid" + }, + "version": { + "type": "string", + "description": "Catalog version" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/EntityCategory.schema.json b/Common/EntityCategory.schema.json index 1f259cf6..51e5767d 100644 --- a/Common/EntityCategory.schema.json +++ b/Common/EntityCategory.schema.json @@ -1,60 +1,60 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntityCategory.schema.json", - "title": "EntityCategory", - "definitions": { - "EntityCategory": { - "$id": "#EntityCategory", - "description": "The (entity) category resource is used to group entity catalog items in logical containers. Categories can contain other categories.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the category" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to the category" - }, - "id": { - "type": "string", - "description": "Unique identifier of the category" - }, - "isRoot": { - "type": "boolean", - "description": "If true, this Boolean indicates that the category is a root of categories" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the category" - }, - "parentId": { - "type": "string", - "description": "Unique identifier of the parent category" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which the category is valid" - }, - "version": { - "type": "string", - "description": "Category version" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntityCategory.schema.json", + "title": "EntityCategory", + "definitions": { + "EntityCategory": { + "$id": "#EntityCategory", + "description": "The (entity) category resource is used to group entity catalog items in logical containers. Categories can contain other categories.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the category" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to the category" + }, + "id": { + "type": "string", + "description": "Unique identifier of the category" + }, + "isRoot": { + "type": "boolean", + "description": "If true, this Boolean indicates that the category is a root of categories" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the category" + }, + "parentId": { + "type": "string", + "description": "Unique identifier of the parent category" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which the category is valid" + }, + "version": { + "type": "string", + "description": "Category version" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/ExternalReference.schema.json b/Common/ExternalReference.schema.json index 5f736d75..9f1ceccd 100644 --- a/Common/ExternalReference.schema.json +++ b/Common/ExternalReference.schema.json @@ -1,26 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ExternalReference.schema.json", - "title": "ExternalReference", - "definitions": { - "ExternalReference": { - "type": "object", - "description": "External reference of the individual or reference in other system", - "properties": { - "externalReferenceType": { - "type": "string", - "description": "Type of the external reference" - }, - "name": { - "type": "string", - "description": "External reference name" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ExternalReference.schema.json", + "title": "ExternalReference", + "definitions": { + "ExternalReference": { + "$id": "#ExternalReference", + "type": "object", + "description": "External reference of the individual or reference in other system", + "properties": { + "externalReferenceType": { + "type": "string", + "description": "Type of the external reference" + }, + "name": { + "type": "string", + "description": "External reference name" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Common/GeographicPoint.schema.json b/Common/GeographicPoint.schema.json index 67fe283a..3e2f4482 100644 --- a/Common/GeographicPoint.schema.json +++ b/Common/GeographicPoint.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicPoint.schema.json", - "title": "GeographicPoint", - "definitions": { - "GeographicPoint": { - "$id": "#GeographicPoint", - "description": "A GeographicPoint defines a geographic point through coordinates.", - "type": "object", - "properties": { - "x": { - "type": "string", - "description": "x coordinate (usually latitude)" - }, - "y": { - "type": "string", - "description": "y coordinate (usually longitude)" - }, - "z": { - "type": "string", - "description": "z coordinate (usually elevation)" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicPoint.schema.json", + "title": "GeographicPoint", + "definitions": { + "GeographicPoint": { + "$id": "#GeographicPoint", + "description": "A GeographicPoint defines a geographic point through coordinates.", + "type": "object", + "properties": { + "x": { + "type": "string", + "description": "x coordinate (usually latitude)" + }, + "y": { + "type": "string", + "description": "y coordinate (usually longitude)" + }, + "z": { + "type": "string", + "description": "z coordinate (usually elevation)" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/GeographicSiteRef.schema.json b/Common/GeographicSiteRef.schema.json index ae1ffc78..c8c081ed 100644 --- a/Common/GeographicSiteRef.schema.json +++ b/Common/GeographicSiteRef.schema.json @@ -1,28 +1,28 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicSiteRef.schema.json", - "title": "GeographicSiteRef", - "definitions": { - "GeographicSiteRef": { - "$id": "#GeographicSiteRef", - "type": "object", - "properties": { - "href": { - "type": "integer" - }, - "id": { - "type": "integer" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicSiteRef.schema.json", + "title": "GeographicSiteRef", + "definitions": { + "GeographicSiteRef": { + "$id": "#GeographicSiteRef", + "type": "object", + "properties": { + "href": { + "type": "integer" + }, + "id": { + "type": "integer" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Money.schema.json b/Common/Money.schema.json index d2db5d92..0ade88f6 100644 --- a/Common/Money.schema.json +++ b/Common/Money.schema.json @@ -1,28 +1,28 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Money.schema.json", - "title": "Money", - "definitions": { - "Money": { - "$id": "#Money", - "description": "A base / value business entity used to represent money", - "type": "object", - "properties": { - "unit": { - "type": "string", - "description": "Currency (ISO4217 norm uses 3 letters to define the currency)" - }, - "value": { - "type": "number", - "format": "float", - "description": "A positive floating point number" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Money.schema.json", + "title": "Money", + "definitions": { + "Money": { + "$id": "#Money", + "description": "A base / value business entity used to represent money", + "type": "object", + "properties": { + "unit": { + "type": "string", + "description": "Currency (ISO4217 norm uses 3 letters to define the currency)" + }, + "value": { + "type": "number", + "format": "float", + "description": "A positive floating point number" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/NetworkFunction.schema.json b/Common/NetworkFunction.schema.json index 28cf8c2b..5715990a 100644 --- a/Common/NetworkFunction.schema.json +++ b/Common/NetworkFunction.schema.json @@ -1,19 +1,19 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "NetworkFunction.schema.json", - "title": "NetworkFunction", - "definitions": { - "NetworkFunction": { - "$id": "#NetworkFunction", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "id": { - "type": "string" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "NetworkFunction.schema.json", + "title": "NetworkFunction", + "definitions": { + "NetworkFunction": { + "$id": "#NetworkFunction", + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "id": { + "type": "string" } + } } -} + } +} \ No newline at end of file diff --git a/Common/RelatedGeographicAddressRefOrValue.schema.json b/Common/RelatedGeographicAddressRefOrValue.schema.json index 2b938ea9..e9c66820 100644 --- a/Common/RelatedGeographicAddressRefOrValue.schema.json +++ b/Common/RelatedGeographicAddressRefOrValue.schema.json @@ -1,32 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedGeographicAddressRefOrValue.schema.json", - "title": "RelatedGeographicAddressRefOrValue", - "definitions": { - "RelatedGeographicAddressRefOrValue": { - "discriminator": "isRef", - "$id": "#RelatedGeographicAddressRefOrValue", - "description": "#TODO", - "type": "object", - "properties": { - "isRef": { - "type": "boolean", - "default": true - - }, - "role":{ - "type": "string" - } - }, - "required": [ - "role" - ], - "allOf": [ - { - "$ref": "RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" - } - - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedGeographicAddressRefOrValue.schema.json", + "title": "RelatedGeographicAddressRefOrValue", + "definitions": { + "RelatedGeographicAddressRefOrValue": { + "discriminator": "isRef", + "$id": "#RelatedGeographicAddressRefOrValue", + "description": "#TODO", + "type": "object", + "properties": { + "isRef": { + "type": "boolean", + "default": true + }, + "role": { + "type": "string" } + }, + "required": [ + "role" + ], + "allOf": [ + { + "$ref": "RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" + } + ] } - } \ No newline at end of file + } +} \ No newline at end of file diff --git a/Common/RelatedPlaceRefOrValue.schema.json b/Common/RelatedPlaceRefOrValue.schema.json index d68ed731..8aa31549 100644 --- a/Common/RelatedPlaceRefOrValue.schema.json +++ b/Common/RelatedPlaceRefOrValue.schema.json @@ -1,30 +1,29 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedPlaceRefOrValue.schema.json", - "title": "RelatedPlaceRefOrValue", - "definitions": { - "RelatedPlaceRefOrValue": { - "discriminator": "isRef", - "$id": "#RelatedPlaceRefOrValue", - "description": "Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself", - "type": "object", - "properties": { - "role":{ - "type": "string" - } - }, - "required": [ - "role" - ], - "allOf": [ - { - "$ref": "PlaceRef.schema.json#PlaceRef" - }, - { - "$ref": "Place.schema.json#Place" - } - - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedPlaceRefOrValue.schema.json", + "title": "RelatedPlaceRefOrValue", + "definitions": { + "RelatedPlaceRefOrValue": { + "discriminator": "isRef", + "$id": "#RelatedPlaceRefOrValue", + "description": "Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself", + "type": "object", + "properties": { + "role": { + "type": "string" } + }, + "required": [ + "role" + ], + "allOf": [ + { + "$ref": "PlaceRef.schema.json#PlaceRef" + }, + { + "$ref": "Place.schema.json#Place" + } + ] } - } \ No newline at end of file + } +} \ No newline at end of file diff --git a/Common/StringCharacteristic.schema.json b/Common/StringCharacteristic.schema.json index 58387826..e5c3b635 100644 --- a/Common/StringCharacteristic.schema.json +++ b/Common/StringCharacteristic.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "StringCharacteristic.schema.json", - "title": "StringCharacteristic", - "definitions": { - "StringCharacteristic": { - "$id": "#StringCharacteristic", - "description": "A characteristic which value is a string", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "valueType": { - "type": "string", - "description": "Data type of the value of the characteristic" - }, - "value": { - "type": "string", - "description": "Value of the characteristic" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "StringCharacteristic.schema.json", + "title": "StringCharacteristic", + "definitions": { + "StringCharacteristic": { + "$id": "#StringCharacteristic", + "description": "A characteristic which value is a string", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "valueType": { + "type": "string", + "description": "Data type of the value of the characteristic" + }, + "value": { + "type": "string", + "description": "Value of the characteristic" } + } } -} + } +} \ No newline at end of file diff --git a/Common/TimePeriod.schema.json b/Common/TimePeriod.schema.json index 59f84f9f..2be7f7ce 100644 --- a/Common/TimePeriod.schema.json +++ b/Common/TimePeriod.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TimePeriod.schema.json", - "title": "TimePeriod", - "definitions": { - "TimePeriod": { - "$id": "#TimePeriod", - "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", - "type": "object", - "properties": { - "startDateTime": { - "description": "Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end", - "type": "string", - "format": "date-time", - "examples": [ - "1985-04-12T23:20:50.52Z", - "2018-09-21T09:13:16-07:00" - ] - }, - "endDateTime": { - "description": "End of the time period, using IETC-RFC-3339 format", - "type": "string", - "format": "date-time", - "examples": [ - "1985-04-12T23:20:50.52Z", - "2018-09-21T09:13:16-07:00" - ] - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TimePeriod.schema.json", + "title": "TimePeriod", + "definitions": { + "TimePeriod": { + "$id": "#TimePeriod", + "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", + "type": "object", + "properties": { + "startDateTime": { + "description": "Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end", + "type": "string", + "format": "date-time", + "examples": [ + "1985-04-12T23:20:50.52Z", + "2018-09-21T09:13:16-07:00" + ] + }, + "endDateTime": { + "description": "End of the time period, using IETC-RFC-3339 format", + "type": "string", + "format": "date-time", + "examples": [ + "1985-04-12T23:20:50.52Z", + "2018-09-21T09:13:16-07:00" + ] } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file From 396d88d356b588347467fa3e89b76a6f6cf5d31d Mon Sep 17 00:00:00 2001 From: Schema validation Bot Date: Mon, 15 Jul 2019 13:33:49 +0000 Subject: [PATCH 03/11] Validation result with ERRORS [skip ci] --- .../validation-20190715T133349Z.txt | 1514 +++++++++++++++++ 1 file changed, 1514 insertions(+) create mode 100644 .circleci/validation_results/validation-20190715T133349Z.txt diff --git a/.circleci/validation_results/validation-20190715T133349Z.txt b/.circleci/validation_results/validation-20190715T133349Z.txt new file mode 100644 index 00000000..c9b3e13e --- /dev/null +++ b/.circleci/validation_results/validation-20190715T133349Z.txt @@ -0,0 +1,1514 @@ +SCHEMA VALIDATION +================= +# schemas : 489 files processed +# errors : 139 +# validate ok : 350 +# issues : 213 files / 573 issues + +total time: 4.37 seconds + + +ERROR - schemas with error(s): +... Common/AddressRef.schema.json +... ... de-reference check: Token "#EntityRef" does not exist. + +... Common/AttachmentRefOrValue.schema.json +... ... AttachmentRefOrValue requires property "$id" + +... Common/ChannelRef.schema.json +... ... ChannelRef requires property "$id" + +... Common/ContactMedium.schema.json +... ... de-reference check: Token "#MediumCharacteristic" does not exist. + +... Common/Entity.schema.json +... ... discriminator (@type) defined but not included in 'required' property + +... Common/MediumCharacteristic.schema.json +... ... MediumCharacteristic requires property "$id" +... ... de-reference check: Token "Entity" does not exist. + +... Common/ProcessFlow.schema.json +... ... ProcessFlow requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Common/RelatedParty.schema.json' + +... Common/QualificationRef.schema.json +... ... QualificationRef requires property "$id" +... ... de-reference check: Token "EntityRef" does not exist. + +... Common/QuantityType.schema.json +... ... QuantityType requires property "type" +... ... QuantityType requires property "$id" + +... Common/RelatedChannel.schema.json +... ... RelatedChannel requires property "$id" +... ... de-reference check: Token "EntityRef" does not exist. + +... Common/RelatedGeographicAddressRefOrValue.schema.json +... ... discriminator (isRef) defined but not included in 'required' property + +... Common/RelatedGeographicLocationRefOrValue.schema.json +... ... discriminator (isRef) defined but not included in 'required' property + +... Common/RelatedPlaceRefOrValue.schema.json +... ... discriminator (isRef) defined but no isRef property defined +... ... discriminator (isRef) defined but not included in 'required' property + +... Common/StatusChange.schema.json +... ... StatusChange requires property "$id" +... ... de-reference check: Token "Entity" does not exist. + +... Common/Street.schema.json +... ... de-reference check: Token "#EntityRef" does not exist. + +... Common/StreetSegment.schema.json +... ... de-reference check: Token "#EntityRef" does not exist. + +... Common/TaskFlow.schema.json +... ... TaskFlow requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Common/RelatedParty.schema.json' + +... Common/TaskFlowRef.schema.json +... ... TaskFlowRef requires property "$id" +... ... de-reference check: Token "Entity" does not exist. + +... Common/TaskFlowRelationship.schema.json +... ... de-reference check: Token "#TaskFlowRef" does not exist. + +... Common/TaxDefinition.schema.json +... ... TaxDefinition requires property "$id" +... ... de-reference check: Token "Entity" does not exist. + +... Common/TicketRelationship.schema.json +... ... TicketRelationship requires property "$id" +... ... de-reference check: Token "Entity" does not exist. + +... Common/TimePeriodType.schema.json +... ... TimePeriodType requires property "type" +... ... TimePeriodType requires property "$id" + +... Common/TroubleTicket.schema.json +... ... TroubleTicket requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Common/RelatedParty.schema.json' + +... Common/TroubleTicketRelationship.schema.json +... ... TroubleTicketRelationship requires property "$id" +... ... de-reference check: Token "Entity" does not exist. + +... Customer/AccumulatedBalance.schema.json +... ... AccumulatedBalance requires property "type" +... ... AccumulatedBalance requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PartyAccountRef.schema.json' + +... Customer/Appointment.schema.json +... ... Appointment requires property "$id" +... ... de-reference check: Token "#AttachmentRefOrValue" does not exist. + +... Customer/AppointmentStateValues.schema.json +... ... AppointmentStateValues requires property "$id" + +... Customer/BalanceActionRequestRef.schema.json +... ... BalanceActionRequestRef requires property "type" +... ... BalanceActionRequestRef requires property "$id" + +... Customer/BalanceActivity.schema.json +... ... BalanceActivity requires property "type" +... ... BalanceActivity requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/QuantityType.schema.json' + +... Customer/BalanceAdjustment.schema.json +... ... BalanceAdjustment requires property "type" +... ... BalanceAdjustment requires property "$id" + +... Customer/BalanceAdjustmentBody.schema.json +... ... BalanceAdjustmentBody requires property "type" +... ... BalanceAdjustmentBody requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/QuantityType.schema.json' + +... Customer/BalanceAdjustmentRequest.schema.json +... ... BalanceAdjustmentRequest requires property "type" +... ... BalanceAdjustmentRequest requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PartyAccountRef.schema.json' + +... Customer/BalanceTopup.schema.json +... ... BalanceTopup requires property "type" +... ... BalanceTopup requires property "$id" + +... Customer/BalanceTopupBody.schema.json +... ... BalanceTopupBody requires property "type" +... ... BalanceTopupBody requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/QuantityType.schema.json' + +... Customer/BalanceTopupRequest.schema.json +... ... BalanceTopupRequest requires property "type" +... ... BalanceTopupRequest requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PartyAccountRef.schema.json' + +... Customer/BalanceTopupStatus.schema.json +... ... BalanceTopupStatusType requires property "type" +... ... BalanceTopupStatusType requires property "$id" +... ... schema mismatch with title (BalanceTopupStatus) and definitions (BalanceTopupStatusType) + +... Customer/BalanceTopupStatusTypeModify.schema.json +... ... BalanceTopupStatusTypeModify requires property "type" +... ... BalanceTopupStatusTypeModify requires property "$id" + +... Customer/BalanceTransfer.schema.json +... ... BalanceTransfer requires property "type" +... ... BalanceTransfer requires property "$id" + +... Customer/BalanceTransferBody.schema.json +... ... BalanceTransferBody requires property "type" +... ... BalanceTransferBody requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/QuantityType.schema.json' + +... Customer/BalanceTransferRequest.schema.json +... ... BalanceTransferRequest requires property "type" +... ... BalanceTransferRequest requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PartyAccountRef.schema.json' + +... Customer/BalanceTransferStatusTypeModify.schema.json +... ... BalanceTransferStatusTypeModify requires property "type" +... ... BalanceTransferStatusTypeModify requires property "$id" + +... Customer/Bill.schema.json +... ... de-reference check: Token "#PaymentRef" does not exist. + +... Customer/BillingAccount.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Common/PartyAccount.schema.json' + +... Customer/Bucket.schema.json +... ... Bucket requires property "type" +... ... Bucket requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PartyAccountRef.schema.json' + +... Customer/BucketBalance.schema.json +... ... BucketBalance requires property "type" +... ... BucketBalance requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PartyAccountRef.schema.json' + +... Customer/BucketBalanceRef.schema.json +... ... BucketBalanceRef requires property "type" +... ... BucketBalanceRef requires property "$id" + +... Customer/CartItem.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PriceAlteration.schema.json' + +... Customer/CartPrice.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PriceAlteration.schema.json' + +... Customer/Customer.schema.json +... ... de-reference check: Token "#MediumCharacteristic" does not exist. + +... Customer/CustomerBill.schema.json +... ... de-reference check: Token "#PaymentRef" does not exist. + +... Customer/Disability.schema.json +... ... Disability requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/TimePeriod.schema.json' + +... Customer/OrderItem.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PriceAlteration.schema.json' + +... Customer/OrderItemPrice.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PriceAlteration.schema.json' + +... Customer/OrderPrice.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PriceAlteration.schema.json' + +... Customer/PaymentItem.schema.json +... ... de-reference check: Token "#PaymentRef" does not exist. + +... Customer/PaymentMethodRefOrValue.schema.json +... ... PaymentMethodRefOrValue requires property "type" +... ... PaymentMethodRefOrValue requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/RelatedPartyRef.schema.json' + +... Customer/PaymentRef.schema.json +... ... PaymentRef requires property "$id" +... ... de-reference check: Token "EntityRef" does not exist. + +... Customer/ProductOfferingQualificationItemRef.schema.json +... ... ProductOfferingQualificationItemRef requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/EntityRef.schema.json' + +... Customer/ProductOrder.schema.json +... ... ProductOrder requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/AgreementRef.schema.json' + +... Customer/ProductOrderItem.schema.json +... ... ProductOrderItem requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/ProductRefOrValue.schema.json' + +... Customer/Quote.schema.json +... ... Quote requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/AgreementRef.schema.json' + +... Customer/QuoteItem.schema.json +... ... QuoteItem requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/AttachmentRefOrValue.schema.json' + +... Customer/QuoteItemRef.schema.json +... ... QuoteItemRef requires property "$id" +... ... de-reference check: Token "EntityRef" does not exist. + +... Customer/QuotePrice.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PriceAlteration.schema.json' + +... Customer/QuoteRef.schema.json +... ... QuoteRef requires property "$id" +... ... de-reference check: Token "EntityRef" does not exist. + +... Customer/SearchTimeSlot.schema.json +... ... SearchTimeSlot requires property "$id" + +... Customer/ShoppingCart.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/PriceAlteration.schema.json' + +... EngagedParty/Account.schema.json +... ... de-reference check: Token "#MediumCharacteristic" does not exist. + +... EngagedParty/AgreementSpecCharacteristic.schema.json +... ... de-reference check: Token "#Any" does not exist. + +... EngagedParty/AgreementSpecCharacteristicValue.schema.json +... ... de-reference check: Token "#Any" does not exist. + +... EngagedParty/AgreementSpecification.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/AttachmentRefOrValue.schema.json' + +... EngagedParty/Contact.schema.json +... ... de-reference check: Token "#MediumCharacteristic" does not exist. + +... EngagedParty/FinancialAccount.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Common/Account.schema.json' + +... EngagedParty/Individual.schema.json +... ... Individual requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/Disability.schema.json' + +... EngagedParty/IndividualIdentification.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/AttachmentRefOrValue.schema.json' + +... EngagedParty/LanguageAbility.schema.json +... ... LanguageAbility requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/Entity.schema.json' + +... EngagedParty/Organization.schema.json +... ... Organization requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/TimePeriod.schema.json' + +... EngagedParty/OrganizationChildRelationship.schema.json +... ... OrganizationChildRelationship requires property "$id" + +... EngagedParty/OrganizationIdentification.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/AttachmentRefOrValue.schema.json' + +... EngagedParty/OrganizationParentRelationship.schema.json +... ... OrganizationParentRelationship requires property "$id" + +... EngagedParty/OtherNameIndividual.schema.json +... ... OtherNameIndividual requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/TimePeriod.schema.json' + +... EngagedParty/OtherNameOrganization.schema.json +... ... OtherNameOrganization requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/TimePeriod.schema.json' + +... EngagedParty/Party.schema.json +... ... Party requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/ExternalReference.schema.json' + +... EngagedParty/PartyAccount.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Common/Account.schema.json' + +... EngagedParty/PartyBill.schema.json +... ... de-reference check: Token "#PaymentRef" does not exist. + +... EngagedParty/PartyCreditProfile.schema.json +... ... PartyCreditProfile requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/TimePeriod.schema.json' + +... EngagedParty/PartyRole.schema.json +... ... required is not of a type(s) object,boolean +... ... de-reference check: Token "#MediumCharacteristic" does not exist. + +... EngagedParty/RelatedPartyRefOrValue.schema.json +... ... isRef property defined, but not included in required +... ... discriminator (isRef) defined but not included in 'required' property +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/ExternalReference.schema.json' + +... EngagedParty/SettlementAccount.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Common/PartyAccount.schema.json' + +... EngagedParty/Skill.schema.json +... ... Skill requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/TimePeriod.schema.json' + +... EngagedParty/TaxExemptionCertificate.schema.json +... ... TaxExemptionCertificate requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'EngagedParty/AttachmentRefOrValue.schema.json' + +... MarketingSales/SalesLead.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'MarketingSales/SalesLeadStateType.schema.json' + +... Product/AlternateProductOfferingProposal.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Product/AgreementItemRef.schema.json' + +... Product/BaseProductRefOrValue.schema.json +... ... isRef property defined, but not included in required +... ... de-reference check: ENOENT: no such file or directory, open 'Product/Characteristic.schema.json' + +... Product/CancelOrder.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Product/TaskStateType.schema.json' + +... Product/CancelProductOrder.schema.json +... ... de-reference check: Token "#CancelOrder" does not exist. + +... Product/LoyaltyAccount.schema.json +... ... LoyaltyAccount additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyAccountRef.schema.json +... ... LoyaltyAccountRef additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyAction.schema.json +... ... LoyaltyAction additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyActionRef.schema.json +... ... LoyaltyActionRef additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyBalance.schema.json +... ... LoyaltyBalance additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyCondition.schema.json +... ... LoyaltyCondition additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyConditionRef.schema.json +... ... LoyaltyConditionRef additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyEvent.schema.json +... ... LoyaltyEvent additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyEventType.schema.json +... ... LoyaltyEventType additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyEventTypeRef.schema.json +... ... LoyaltyEventTypeRef additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyExecutionPoint.schema.json +... ... LoyaltyAccount additionalProperty "title" exists in instance when not allowed +... ... schema mismatch with title (LoyaltyExecutionPoint) and definitions (LoyaltyAccount) + +... Product/LoyaltyProgramMember.schema.json +... ... LoyaltyProgramMember requires property "$id" +... ... LoyaltyProgramMember additionalProperty "id" exists in instance when not allowed +... ... LoyaltyProgramMember additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyProgramMemberRef.schema.json +... ... LoyaltyProgramMemberRef requires property "$id" +... ... LoyaltyProgramMemberRef additionalProperty "id" exists in instance when not allowed +... ... LoyaltyProgramMemberRef additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyProgramProduct.schema.json +... ... LoyaltyProgramProduct requires property "$id" +... ... LoyaltyProgramProduct additionalProperty "id" exists in instance when not allowed +... ... LoyaltyProgramProduct additionalProperty "title" exists in instance when not allowed +... ... de-reference check: ENOENT: no such file or directory, open 'Product/Characteristic.schema.json' + +... Product/LoyaltyProgramProductRef.schema.json +... ... LoyaltyProgramProductRef requires property "$id" +... ... LoyaltyProgramProductRef additionalProperty "id" exists in instance when not allowed +... ... LoyaltyProgramProductRef additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyProgramProductSpec.schema.json +... ... LoyaltyProgramProductSpec additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyProgramProductSpecRef.schema.json +... ... LoyaltyProgramProductSpecRef additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyRule.schema.json +... ... LoyaltyRule additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyRuleAction.schema.json +... ... LoyaltyRuleAction additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyRuleCondition.schema.json +... ... LoyaltyRuleCondition additionalProperty "title" exists in instance when not allowed + +... Product/LoyaltyRuleEventType.schema.json +... ... LoyaltyRuleEventType additionalProperty "title" exists in instance when not allowed + +... Product/PriceAlteration.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Product/Price.schema.json' + +... Product/Product.schema.json +... ... Product requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Product/AgreementItemRef.schema.json' + +... Product/ProductOffering.schema.json +... ... de-reference check: Token "#ChannelRef" does not exist. + +... Product/ProductOfferingQualification.schema.json +... ... ProductOfferingQualification requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Product/ChannelRef.schema.json' + +... Product/ProductOfferingQualificationItem.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Product/TaskStateType.schema.json' + +... Product/ProductOfferingQualificationItemRef.schema.json +... ... ProductOfferingQualificationItemRef requires property "$id" +... ... de-reference check: Token "Entity" does not exist. + +... Product/ProductOfferingQualificationRef.schema.json +... ... ProductOfferingQualificationRef requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Product/EntityRef.schema.json' + +... Product/ProductPrice.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Product/BillingAccountRef.schema.json' + +... Product/ProductRefOrValue.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Product/AgreementItemRef.schema.json' + +... Product/ProductRelationship.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Product/AgreementItemRef.schema.json' + +... Product/ProductRequest.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Product/BillingAccountRef.schema.json' + +... Product/ProductRestriction.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Product/Characteristic.schema.json' + +... Product/ProductSpecification.schema.json +... ... de-reference check: Token "#AttachmentRefOrValue" does not exist. + +... Product/Recommendation.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Product/ProductOrderRef.schema.json' + +... Product/RelatedProductOrderItem.schema.json +... ... RelatedProductOrderItem requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Product/Entity.schema.json' + +... Resource/RealizingResourceRef.schema.json +... ... RealizingResourceRef requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Resource/EntityRef.schema.json' + +... Service/AlternateServiceProposal.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/ServiceRestriction.schema.json' + +... Service/ServiceOfferingQualificationRef.schema.json +... ... de-reference check: Token "#QualificationRef" does not exist. + +... Service/ServiceOrder.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/OrderItemRelationship.schema.json' + +... Service/ServiceOrderItem.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/OrderItemRelationship.schema.json' + +... Service/ServiceQualification.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/ServiceRestriction.schema.json' + +... Service/ServiceQualificationItem.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/ServiceRestriction.schema.json' + + +ISSUES - schemas with issue(s): +... Common/AlternateGeographicAddress.schema.json +... ... geographicLocation :: no description value +... ... geographicSubAddress :: no description value + +... Common/AssociationRoleSpec.schema.json +... ... aggregation :: no description value +... ... defaultQuantity :: no description value +... ... entityType :: no description value +... ... isNavigable :: no description value +... ... isSource :: no description value +... ... maxQuantity :: no description value +... ... minQuantity :: no description value +... ... role :: no description value + +... Common/AssociationSpecification.schema.json +... ... constraint :: no description value +... ... associationRoleSpec :: no description value + +... Common/BusinessInteraction.schema.json +... ... interactionData :: no description value +... ... interactionDataComplete :: no description value +... ... interactionDataStatus :: no description value + +... Common/CalendarEventRef.schema.json +... ... CalendarEventRef :: no properties defined + +... Common/CalendarPeriod.schema.json +... ... timeZone :: recommend to add format +... ... hourPeriod :: no description value + +... Common/ChangeRequest.schema.json +... ... workLog :: no description value +... ... incident :: no description value +... ... changeRequestSpecification :: no description value +... ... impactEntity :: no description value +... ... changeRequestCharacteristic :: no description value +... ... targetEntity :: no description value +... ... resolution :: no description value +... ... sla :: no description value +... ... relateChangeRequest :: no description value +... ... category :: no description value +... ... note :: no description value + +... Common/ChangeRequestSpecification.schema.json +... ... validFor :: no description value + +... Common/Channel.schema.json +... ... Channel :: should be renamed as ChannelRef if this is a reference entity + +... Common/CommonComponents.schema.json +... ... Failing to check for issues: TypeError: Cannot read property 'properties' of undefined + +... Common/CommunicationMessage.schema.json +... ... logFlag :: no description value +... ... tryTimes :: recommend to add format + +... Common/Document.schema.json +... ... binaryAttachment :: no description value +... ... category :: no description value +... ... documentRelationship :: no description value +... ... relatedObject :: no description value + +... Common/DocumentCharacteristic.schema.json +... ... value :: no description value + +... Common/DocumentRelationship.schema.json +... ... documentRef :: no description value + +... Common/EntitySpecRelationship.schema.json +... ... associationSpec :: no description value + +... Common/EntitySpecification.schema.json +... ... attachment :: no description value +... ... entitySchema :: no description value +... ... specCharacteristic :: no description value +... ... relatedParty :: no description value + +... Common/ExternalReference.schema.json +... ... ExternalReference :: should be renamed as ExternalReferenceRef if this is a reference entity + +... Common/GeographicAddress.schema.json +... ... geographicLocation :: no description value +... ... geographicSubAddress :: no description value + +... Common/GeographicAddressValidation.schema.json +... ... validAddress :: no description value +... ... alternateGeographicAddress :: no description value + +... Common/GeographicLocation.schema.json +... ... accuracy :: no description value +... ... spatialRef :: no description value +... ... geometry :: no description value + +... Common/GeographicLocationRef.schema.json +... ... GeographicLocationRef :: no properties defined + +... Common/GeographicSite.schema.json +... ... relatedParty :: no description value +... ... calendar :: no description value +... ... geographicLocation :: no description value +... ... address :: no description value +... ... siteRelationship :: no description value + +... Common/Incident.schema.json +... ... Incident :: should be renamed as IncidentRef if this is a reference entity + +... Common/LocationCharacteristic.schema.json +... ... value :: no description value + +... Common/NetworkFunction.schema.json +... ... NetworkFunction :: should be renamed as NetworkFunctionRef if this is a reference entity + +... Common/Object.schema.json +... ... uri :: no description value + +... Common/Place.schema.json +... ... Place :: should be renamed as PlaceRef if this is a reference entity + +... Common/PlaceRef.schema.json +... ... PlaceRef :: no properties defined + +... Common/Receiver.schema.json +... ... party :: no description value + +... Common/Resolution.schema.json +... ... task :: no description value + +... Common/RetrieveGeographicLocation.schema.json +... ... requestedAccuracy :: no description value +... ... status :: no description value +... ... time :: no description value +... ... geographicLocation :: no description value +... ... thing :: no description value + +... Common/RetrieveLocationRelation.schema.json +... ... distance :: no description value +... ... status :: no description value +... ... time :: no description value +... ... intersection :: no description value +... ... location :: no description value + +... Common/Sender.schema.json +... ... party :: no description value + +... Common/SpecCharacteristic.schema.json +... ... specCharacteristicValue :: no description value +... ... specCharRelationship :: no description value + +... Common/TroubleTicketRef.schema.json +... ... TroubleTicketRef :: no properties defined + +... Common/Value.schema.json +... ... Value :: no properties defined + +... Common/WorkLog.schema.json +... ... lastUpdateDateTime :: recommend to add format +... ... lastUpdateDateTime :: recommend to add format +... ... record :: no description value + +... Customer/AppliedBillingRate.schema.json +... ... appliedTax :: no description value +... ... bill :: no description value +... ... characteristic :: no description value + +... Customer/AppliedCustomerBillingRate.schema.json +... ... appliedTax :: no description value +... ... bill :: no description value +... ... characteristic :: no description value + +... Customer/AppliedPartyBillingRate.schema.json +... ... appliedTax :: no description value +... ... bill :: no description value +... ... characteristic :: no description value + +... Customer/Authorization.schema.json +... ... approver :: no description value + +... Customer/BalanceDeduct.schema.json +... ... relatedParty :: no description value +... ... product :: no description value +... ... balanceReserve :: no description value +... ... requestor :: no description value +... ... partyAccount :: no description value + +... Customer/BalanceDeductRollback.schema.json +... ... relatedParty :: no description value +... ... product :: no description value +... ... partyAccount :: no description value +... ... balanceDeduct :: no description value +... ... requestor :: no description value + +... Customer/BalanceReserve.schema.json +... ... requestor :: no description value +... ... product :: no description value +... ... relatedParty :: no description value +... ... partyAccount :: no description value + +... Customer/BalanceUnreserve.schema.json +... ... balanceReserve :: no description value +... ... relatedParty :: no description value +... ... requestor :: no description value +... ... product :: no description value + +... Customer/BankCardMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/BillFormat.schema.json +... ... BillFormat :: should be renamed as BillFormatRef if this is a reference entity + +... Customer/BillFormatRefOrValue.schema.json +... ... isRef :: no description value + +... Customer/BillPresentationMedia.schema.json +... ... BillPresentationMedia :: should be renamed as BillPresentationMediaRef if this is a reference entity + +... Customer/BillPresentationMediaRefOrValue.schema.json +... ... isRef :: no description value + +... Customer/BillStructure.schema.json +... ... presentationMedia :: no description value +... ... format :: no description value +... ... cycleSpecification :: no description value + +... Customer/BillingCycleSpecification.schema.json +... ... billingDateShift :: recommend to add format +... ... chargeDateOffset :: recommend to add format +... ... creditDateOffset :: recommend to add format +... ... mailingDateOffset :: recommend to add format +... ... paymentDueDateOffset :: recommend to add format + +... Customer/BillingCycleSpecificationRef.schema.json +... ... dateShift :: recommend to add format + +... Customer/BillingCycleSpecificationRefOrValue.schema.json +... ... isRef :: no description value + +... Customer/CartItemRelationship.schema.json +... ... cartItem :: no description value + +... Customer/CartTerm.schema.json +... ... description :: no description value +... ... duration :: no description value + +... Customer/CashDetails.schema.json +... ... CashDetails :: no properties defined + +... Customer/CashMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/CheckMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/DigitalWalletMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/OrderItemRelationship.schema.json +... ... OrderItemRelationship :: should be renamed as OrderItemRelationshipRef if this is a reference entity + +... Customer/OrderRelationship.schema.json +... ... OrderRelationship :: should be renamed as OrderRelationshipRef if this is a reference entity + +... Customer/PaymentMethod.schema.json +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/PaymentPlan.schema.json +... ... paymentMethod :: no description value + +... Customer/ProductOrderRef.schema.json +... ... ProductOrderRef :: no properties defined + +... Customer/QuoteItemRelationship.schema.json +... ... QuoteItemRelationship :: should be renamed as QuoteItemRelationshipRef if this is a reference entity + +... Customer/SettlementNoteAdvice.schema.json +... ... settlementMethod :: no description value +... ... settlementNoteImage :: no description value +... ... receiver :: no description value +... ... taxItem :: no description value +... ... issuer :: no description value +... ... settlementNoteItem :: no description value + +... Customer/SettlementNoteImage.schema.json +... ... imageFileURL :: recommend to add format + +... Customer/SettlementNoteItem.schema.json +... ... period :: no description value +... ... taxItem :: no description value + +... Customer/TokenizedCardMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/VoucherMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/AccountDirectDetails.schema.json +... ... AccountDirectDetails :: should be renamed as AccountDirectDetailsRef if this is a reference entity +... ... account :: no description value + +... EngagedParty/AccountDirectMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/AccountRelationship.schema.json +... ... account :: no description value + +... EngagedParty/AccountTaxExemption.schema.json +... ... issuingJurisdiction :: recommend to add format + +... EngagedParty/Agreement.schema.json +... ... completionDate :: recommend to add format +... ... agreementSpecification :: no description value +... ... agreementItem :: no description value +... ... engagedPartyRole :: no description value +... ... agreementAuthorization :: no description value +... ... characteristic :: no description value +... ... associatedAgreement :: no description value + +... EngagedParty/AgreementItem.schema.json +... ... productOffering :: no description value +... ... termOrCondition :: no description value + +... EngagedParty/BankAccountDebitMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/BankAccountTransferMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/FinancialAccountRef.schema.json +... ... accountBalance :: no description value + +... EngagedParty/OrganizationRef.schema.json +... ... OrganizationRef :: no properties defined + +... EngagedParty/PartnershipType.schema.json +... ... roleType :: no description value + +... EngagedParty/PartyRef.schema.json +... ... PartyRef :: no properties defined + +... EngagedParty/RoleType.schema.json +... ... agreementSpecification :: no description value + +... EngagedParty/Rule.schema.json +... ... consequence :: no description value +... ... metric :: no description value +... ... operator :: no description value +... ... referenceValue :: no description value +... ... tolerance :: no description value +... ... unit :: no description value + +... EngagedParty/RuleRef.schema.json +... ... description :: no description value + +... EngagedParty/SLA.schema.json +... ... approvalDate :: no description value +... ... approved :: no description value +... ... rule :: no description value +... ... relatedParty :: no description value +... ... template :: no description value + +... EngagedParty/SLAViolation.schema.json +... ... date :: no description value +... ... relatedParty :: no description value +... ... violation :: no description value +... ... sla :: no description value + +... EngagedParty/TemplateRef.schema.json +... ... description :: no description value + +... EngagedParty/Violation.schema.json +... ... actualValue :: no description value +... ... comment :: no description value +... ... consequence :: no description value +... ... operator :: no description value +... ... referenceValue :: no description value +... ... tolerance :: no description value +... ... unit :: no description value +... ... violationAverage :: no description value +... ... attachment :: no description value +... ... rule :: no description value + +... MarketingSales/MarketingCampaignRef.schema.json +... ... MarketingCampaignRef :: no properties defined + +... MarketingSales/SalesOpportunityRef.schema.json +... ... SalesOpportunityRef :: no properties defined + +... Product/BundledProductOfferingPriceRelationship.schema.json +... ... BundledProductOfferingPriceRelationship :: should be renamed as BundledProductOfferingPriceRelationshipRef if this is a reference entity + +... Product/BundledProductSpecification.schema.json +... ... BundledProductSpecification :: should be renamed as BundledProductSpecificationRef if this is a reference entity + +... Product/ProductInventoryRelationship.schema.json +... ... product :: no description value + +... Product/ProductOfferingPriceRef.schema.json +... ... ProductOfferingPriceRef :: no properties defined + +... Product/ProductOfferingPriceRelationship.schema.json +... ... ProductOfferingPriceRelationship :: should be renamed as ProductOfferingPriceRelationshipRef if this is a reference entity + +... Product/ProductOfferingRef.schema.json +... ... ProductOfferingRef :: no properties defined + +... Product/ProductRef.schema.json +... ... ProductRef :: no properties defined + +... Product/ProductSpecCharacteristic.schema.json +... ... productSpecCharRelationship :: no description value +... ... productSpecCharacteristicValue :: no description value + +... Product/Promotion.schema.json +... ... pattern :: no description value + +... Product/PromotionCriteriaGroup.schema.json +... ... criteria :: no description value + +... Product/PromotionPattern.schema.json +... ... action :: no description value +... ... criteriaGroup :: no description value + +... Product/QualificationItemRelationship.schema.json +... ... QualificationItemRelationship :: should be renamed as QualificationItemRelationshipRef if this is a reference entity + +... Product/Usage.schema.json +... ... usageSpecification :: no description value +... ... usageCharacteristic :: no description value +... ... relatedParty :: no description value +... ... ratedProductUsage :: no description value + +... Product/UsageConsumptionReport.schema.json +... ... relatedParty :: no description value + +... Product/UsageSpecCharacteristic.schema.json +... ... usageSpecCharacteristicValue :: no description value + +... Product/UsageSpecification.schema.json +... ... usageSpecCharacteristic :: no description value + +... Product/UsageVolumeProduct.schema.json +... ... bucketBalance :: no description value +... ... bucketCounter :: no description value +... ... product :: no description value + +... Resource/LogicalResource.schema.json +... ... resourceRelationship :: no description value +... ... characteristic :: no description value +... ... place :: no description value +... ... partyRole :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/PhysicalResource.schema.json +... ... resourceRelationship :: no description value +... ... characteristic :: no description value +... ... place :: no description value +... ... partyRole :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/Resource.schema.json +... ... resourceRelationship :: no description value +... ... characteristic :: no description value +... ... place :: no description value +... ... partyRole :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/ResourceAlarmRef.schema.json +... ... changeRequest :: no description value + +... Resource/ResourceOrder.schema.json +... ... orderRelationship :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/ResourceOrderItem.schema.json +... ... resourceSpecification :: no description value +... ... orderItemRelationship :: no description value + +... Resource/ResourceOrderItemRelationship.schema.json +... ... orderItem :: no description value + +... Resource/ResourceOrderRelationship.schema.json +... ... resourceOrder :: no description value +... ... serviceOrder :: no description value + +... Resource/SupportingResource.schema.json +... ... SupportingResource :: should be renamed as SupportingResourceRef if this is a reference entity + +... Service/FirstAlert.schema.json +... ... FirstAlert :: should be renamed as FirstAlertRef if this is a reference entity + +... Service/Service.schema.json +... ... serviceDate :: recommend to add format + +... Service/ServiceCategory.schema.json +... ... serviceCandidate :: recommend to add format + +... Service/ServiceLevelObjective.schema.json +... ... graceTimes :: recommend to add format + +... Service/ServiceOrderItemRelationship.schema.json +... ... ServiceOrderItemRelationship :: should be renamed as ServiceOrderItemRelationshipRef if this is a reference entity + +... Service/ServiceQualificationItemRelationship.schema.json +... ... ServiceQualificationItemRelationship :: should be renamed as ServiceQualificationItemRelationshipRef if this is a reference entity + +... Service/ServiceQualificationRelationship.schema.json +... ... ServiceQualificationRelationship :: should be renamed as ServiceQualificationRelationshipRef if this is a reference entity + +... Service/ServiceRef.schema.json +... ... ServiceRef :: no properties defined + +... Service/SupportingService.schema.json +... ... SupportingService :: should be renamed as SupportingServiceRef if this is a reference entity + +... Common/RelatedGeographicAddressRefOrValue.schema.json +... ... isRef :: no description value +... ... role :: no description value + +... Common/RelatedGeographicLocationRefOrValue.schema.json +... ... isRef :: no description value +... ... role :: no description value + +... Common/RelatedPlaceRefOrValue.schema.json +... ... role :: no description value + +... Common/Street.schema.json +... ... characteristic :: no description value +... ... address :: no description value + +... Common/StreetSegment.schema.json +... ... address :: no description value + +... Common/TicketRelationship.schema.json +... ... product :: no description value + +... Common/TroubleTicketRelationship.schema.json +... ... troubleTicket :: no description value + +... Customer/Appointment.schema.json +... ... attachment :: no description value +... ... contactMedium :: no description value +... ... note :: no description value +... ... relatedEntity :: no description value +... ... relatedParty :: no description value +... ... status :: no description value +... ... validFor :: no description value + +... Customer/BalanceActivity.schema.json +... ... date :: recommend to add format +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceAdjustmentBody.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceAdjustmentRequest.schema.json +... ... requestedDate :: recommend to add format + +... Customer/BalanceTopupBody.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceTopupRequest.schema.json +... ... confirmationDate :: recommend to add format +... ... requestedDate :: recommend to add format + +... Customer/BalanceTopupStatus.schema.json +... ... Failing to check for issues: TypeError: Cannot read property 'properties' of undefined + +... Customer/BalanceTopupStatusTypeModify.schema.json +... ... BalanceTopupStatusTypeModify :: should be renamed as BalanceTopupStatusTypeModifyRef if this is a reference entity + +... Customer/BalanceTransferBody.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceTransferRequest.schema.json +... ... confirmationDate :: recommend to add format +... ... requestedDate :: recommend to add format + +... Customer/BalanceTransferStatusTypeModify.schema.json +... ... BalanceTransferStatusTypeModify :: should be renamed as BalanceTransferStatusTypeModifyRef if this is a reference entity +... ... status :: no description value + +... Customer/Bill.schema.json +... ... billingAccount :: no description value +... ... taxItem :: no description value +... ... paymentMethod :: no description value +... ... relatedParty :: no description value +... ... financialAccount :: no description value + +... Customer/BillingAccount.schema.json +... ... BillingAccount :: no properties defined + +... Customer/CartItem.schema.json +... ... itemTerm :: no description value +... ... cartItem :: no description value +... ... note :: no description value +... ... ItemTotalPrice :: no description value +... ... product :: no description value +... ... itemPrice :: no description value +... ... productOffering :: no description value +... ... cartItemRelationship :: no description value + +... Customer/CartPrice.schema.json +... ... price :: no description value +... ... priceAlteration :: no description value + +... Customer/Customer.schema.json +... ... engagedParty :: no description value +... ... roleType :: no description value +... ... account :: no description value +... ... paymentMethod :: no description value +... ... contactMedium :: no description value +... ... creditProfile :: no description value +... ... agreement :: no description value +... ... relatedParty :: no description value + +... Customer/CustomerBill.schema.json +... ... billingAccount :: no description value +... ... taxItem :: no description value +... ... paymentMethod :: no description value +... ... relatedParty :: no description value +... ... financialAccount :: no description value + +... Customer/Disability.schema.json +... ... validFor :: no description value + +... Customer/OrderItem.schema.json +... ... appointment :: no description value +... ... billingAccount :: no description value +... ... itemPrice :: no description value +... ... orderItem :: no description value +... ... orderItemRelationship :: no description value +... ... itemTotalPrice :: no description value +... ... payment :: no description value +... ... productOffering :: no description value +... ... product :: no description value +... ... qualification :: no description value +... ... itemTerm :: no description value + +... Customer/OrderItemPrice.schema.json +... ... productOfferingPrice :: no description value +... ... billingAccount :: no description value +... ... price :: no description value +... ... priceAlteration :: no description value + +... Customer/PaymentItem.schema.json +... ... payment :: no description value + +... Customer/PaymentMethodRefOrValue.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/ProductOrder.schema.json +... ... billingAccount :: no description value +... ... channel :: no description value +... ... note :: no description value +... ... orderTotalPrice :: no description value +... ... payment :: no description value +... ... productOfferingQualification :: no description value +... ... quote :: no description value +... ... productOrderItem :: no description value +... ... relatedParty :: no description value + +... Customer/ProductOrderItem.schema.json +... ... appointment :: no description value +... ... billingAccount :: no description value +... ... itemPrice :: no description value +... ... itemTerm :: no description value +... ... itemTotalPrice :: no description value +... ... payment :: no description value +... ... product :: no description value +... ... productOffering :: no description value +... ... productOfferingQualificationItem :: no description value +... ... quoteItem :: no description value +... ... productOrderItem :: no description value +... ... productOrderItemRelationship :: no description value +... ... qualification :: no description value + +... Customer/QuoteItem.schema.json +... ... product :: no description value +... ... productOffering :: no description value + +... Customer/QuotePrice.schema.json +... ... priceAlteration :: no description value +... ... price :: no description value + +... Customer/QuoteRef.schema.json +... ... QuoteRef :: no properties defined + +... Customer/SearchTimeSlot.schema.json +... ... requestedTimeSlot :: no description value +... ... requestedTimeSlot :: recommend to add format +... ... availableTimeSlot :: no description value +... ... availableTimeSlot :: recommend to add format +... ... relatedEntity :: no description value + +... Customer/ShoppingCart.schema.json +... ... contactMedium :: no description value +... ... cartItem :: no description value +... ... relatedParty :: no description value + +... EngagedParty/Account.schema.json +... ... relatedParty :: no description value +... ... taxExemption :: no description value +... ... contact :: no description value +... ... accountBalance :: no description value +... ... accountRelationship :: no description value + +... EngagedParty/AgreementSpecCharacteristic.schema.json +... ... specCharacteristicValue :: no description value + +... EngagedParty/AgreementSpecification.schema.json +... ... serviceCategory :: no description value +... ... specificationCharacteristic :: no description value +... ... relatedParty :: no description value +... ... attachment :: no description value +... ... specificationRelationship :: no description value + +... EngagedParty/Contact.schema.json +... ... contactMedium :: no description value +... ... relatedParty :: no description value + +... EngagedParty/FinancialAccount.schema.json +... ... FinancialAccount :: no properties defined + +... EngagedParty/Individual.schema.json +... ... otherName :: no description value +... ... individualIdentification :: no description value +... ... disability :: no description value +... ... languageAbility :: no description value +... ... skill :: no description value + +... EngagedParty/IndividualIdentification.schema.json +... ... attachment :: no description value + +... EngagedParty/LanguageAbility.schema.json +... ... isFavouriteLanguage :: recommend to add format +... ... validFor :: no description value + +... EngagedParty/Organization.schema.json +... ... existsDuring :: no description value +... ... existsDuring :: recommend to add format +... ... otherName :: no description value +... ... organizationIdentification :: no description value +... ... organizationChildRelationship :: no description value +... ... organizationParentRelationship :: no description value + +... EngagedParty/OrganizationChildRelationship.schema.json +... ... organization :: no description value + +... EngagedParty/OrganizationIdentification.schema.json +... ... attachment :: no description value + +... EngagedParty/OrganizationParentRelationship.schema.json +... ... organization :: no description value + +... EngagedParty/OtherNameIndividual.schema.json +... ... validFor :: no description value + +... EngagedParty/OtherNameOrganization.schema.json +... ... validFor :: no description value + +... EngagedParty/Party.schema.json +... ... externalReference :: no description value +... ... partyCharacteristic :: no description value +... ... taxExemptionCertificate :: no description value +... ... creditRating :: no description value +... ... relatedParty :: no description value +... ... contactMedium :: no description value + +... EngagedParty/PartyAccount.schema.json +... ... billStructure :: no description value +... ... paymentPlan :: no description value +... ... financialAccount :: no description value +... ... defaultPaymentMethod :: no description value + +... EngagedParty/PartyBill.schema.json +... ... billingAccount :: no description value +... ... taxItem :: no description value +... ... paymentMethod :: no description value +... ... relatedParty :: no description value +... ... financialAccount :: no description value + +... EngagedParty/PartyCreditProfile.schema.json +... ... validFor :: no description value + +... EngagedParty/PartyRole.schema.json +... ... engagedParty :: no description value +... ... roleType :: no description value +... ... account :: no description value +... ... paymentMethod :: no description value +... ... contactMedium :: no description value +... ... creditProfile :: no description value +... ... agreement :: no description value +... ... relatedParty :: no description value + +... EngagedParty/RelatedPartyRefOrValue.schema.json +... ... isRef :: no description value +... ... role :: no description value + +... EngagedParty/SettlementAccount.schema.json +... ... SettlementAccount :: no properties defined + +... EngagedParty/Skill.schema.json +... ... validFor :: no description value + +... EngagedParty/TaxExemptionCertificate.schema.json +... ... taxDefinition :: no description value +... ... validFor :: no description value +... ... attachment :: no description value + +... MarketingSales/SalesLead.schema.json +... ... status :: no description value +... ... type :: rename to avoid conflict with @type +... ... priority :: no description value +... ... channel :: no description value +... ... productOffering :: no description value +... ... relatedParty :: no description value +... ... prospectContact :: no description value +... ... productSpecification :: no description value +... ... category :: no description value +... ... salesOpportunity :: no description value +... ... product :: no description value +... ... note :: no description value + +... Product/BaseProductRefOrValue.schema.json +... ... productCharacteristic :: no description value +... ... realizingResource :: no description value +... ... realizingService :: no description value +... ... productRelationship :: no description value +... ... relatedParty :: no description value +... ... productSpecification :: no description value +... ... relatedPlace :: no description value + +... Product/CancelProductOrder.schema.json +... ... CancelProductOrder :: should be renamed as CancelProductOrderRef if this is a reference entity +... ... productOrder :: no description value + +... Product/LoyaltyAccount.schema.json +... ... LoyaltyAccount :: should be renamed as LoyaltyAccountRef if this is a reference entity +... ... loyaltyProgramProduct :: no description value + +... Product/LoyaltyAction.schema.json +... ... type :: rename to avoid conflict with @type + +... Product/LoyaltyEvent.schema.json +... ... eventId :: no description value +... ... eventTime :: recommend to add format + +... Product/LoyaltyEventType.schema.json +... ... LoyaltyEventType :: should be renamed as LoyaltyEventTypeRef if this is a reference entity + +... Product/LoyaltyExecutionPoint.schema.json +... ... Failing to check for issues: TypeError: Cannot read property 'properties' of undefined + +... Product/LoyaltyProgramProduct.schema.json +... ... loyaltyProgramProductSpec :: no description value +... ... loyaltyAccount :: no description value +... ... validFor :: no description value + +... Product/LoyaltyProgramProductSpec.schema.json +... ... productNumber :: no description value +... ... ValidFor :: no description value + +... Product/LoyaltyRuleAction.schema.json +... ... LoyaltyRuleAction :: should be renamed as LoyaltyRuleActionRef if this is a reference entity + +... Product/LoyaltyRuleCondition.schema.json +... ... LoyaltyRuleCondition :: should be renamed as LoyaltyRuleConditionRef if this is a reference entity + +... Product/LoyaltyRuleEventType.schema.json +... ... LoyaltyRuleEventType :: should be renamed as LoyaltyRuleEventTypeRef if this is a reference entity + +... Product/PriceAlteration.schema.json +... ... productOfferingPrice :: no description value +... ... price :: no description value + +... Product/Product.schema.json +... ... agreement :: no description value +... ... billingAccount :: no description value +... ... productCharacteristic :: no description value +... ... productOffering :: no description value +... ... productOrderItem :: no description value +... ... product :: no description value +... ... productPrice :: no description value +... ... productRelationship :: no description value +... ... productSpecification :: no description value +... ... productTerm :: no description value +... ... realizingResource :: no description value +... ... realizingService :: no description value +... ... relatedParty :: no description value +... ... place :: no description value + +... Product/ProductOffering.schema.json +... ... serviceCandidate :: recommend to add format +... ... resourceCandidate :: recommend to add format + +... Product/ProductOfferingQualificationItem.schema.json +... ... eligibilityUnavailabilityReason :: no description value +... ... category :: no description value +... ... qualificationItemRelationship :: no description value +... ... note :: no description value +... ... product :: no description value +... ... terminationError :: no description value +... ... productOffering :: no description value +... ... alternateProductOfferingProposal :: no description value + +... Product/ProductOfferingQualificationRef.schema.json +... ... ProductOfferingQualificationRef :: no properties defined + +... Product/ProductPrice.schema.json +... ... productOfferingPrice :: no description value +... ... billingAccount :: no description value +... ... productPriceAlteration :: no description value +... ... price :: no description value + +... Product/ProductRefOrValue.schema.json +... ... ProductRefOrValue :: no properties defined + +... Product/ProductRelationship.schema.json +... ... product :: no description value + +... Product/ProductRequest.schema.json +... ... referredProduct :: no description value +... ... realizingService :: no description value +... ... billingAccount :: no description value +... ... productOffering :: no description value +... ... agreement :: no description value +... ... characteristic :: no description value +... ... productRelationship :: no description value +... ... realizingResource :: no description value +... ... relatedParty :: no description value +... ... productPrice :: no description value +... ... productSpecification :: no description value +... ... place :: no description value + +... Product/ProductRestriction.schema.json +... ... productCharacteristic :: no description value +... ... productRelationship :: no description value +... ... relatedParty :: no description value +... ... productSpecification :: no description value +... ... relatedPlace :: no description value + +... Product/Recommendation.schema.json +... ... description :: no description value +... ... order :: no description value +... ... channel :: no description value +... ... party :: no description value +... ... item :: no description value + +... Resource/RealizingResourceRef.schema.json +... ... RealizingResourceRef :: no properties defined + +... Service/AlternateServiceProposal.schema.json +... ... alternateService :: no description value + +... Service/ServiceOrder.schema.json +... ... orderDate :: no description value + +error: TypeError: fd must be a file descriptor From ade060a90045969882dd07079e62266ff8cb1be7 Mon Sep 17 00:00:00 2001 From: Test results Date: Mon, 15 Jul 2019 15:38:24 +0200 Subject: [PATCH 04/11] Automated schema fix --- Common/Address.schema.json | 136 +++--- Common/AddressRef.schema.json | 26 +- Common/Any.schema.json | 20 +- Common/Area.schema.json | 70 +-- Common/Association.schema.json | 128 +++--- Common/AssociationRoleSpec.schema.json | 80 ++-- Common/AssociationSpecification.schema.json | 116 ++--- Common/Attachment.schema.json | 154 +++---- Common/AttachmentRef.schema.json | 76 +-- Common/AttachmentRefOrValue.schema.json | 32 +- Common/BaseEvent.schema.json | 131 +++--- Common/BasePlusEvent.schema.json | 122 ++--- Common/BusinessInteraction.schema.json | 68 +-- Common/CalendarEventRef.schema.json | 32 +- Common/CalendarPeriod.schema.json | 66 +-- Common/ChangeRequest.schema.json | 364 +++++++-------- .../ChangeRequestCharacteristic.schema.json | 48 +- Common/ChangeRequestRef.schema.json | 56 +-- Common/ChangeRequestSpecification.schema.json | 70 +-- Common/Channel.schema.json | 57 ++- Common/ChannelRef.schema.json | 39 +- Common/Characteristic.schema.json | 61 +-- Common/CommonComponents.schema.json | 82 ++-- Common/CommunicationMessage.schema.json | 188 ++++---- ...unicationRequestCharacteristic.schema.json | 48 +- Common/ConstraintRef.schema.json | 70 +-- Common/ContactMedium.schema.json | 64 +-- Common/Document.schema.json | 188 ++++---- Common/DocumentAttachment.schema.json | 106 ++--- Common/DocumentCharacteristic.schema.json | 46 +- Common/DocumentRef.schema.json | 54 +-- Common/DocumentSpecification.schema.json | 74 +-- Common/Duration.schema.json | 39 +- Common/Entity.schema.json | 84 ++-- Common/EntityAttachment.schema.json | 90 ++-- Common/EntityCatalogItem.schema.json | 98 ++-- Common/EntityCatalogItemRef.schema.json | 72 +-- Common/EntityRef.schema.json | 62 +-- Common/EntitySchemaRef.schema.json | 40 +- Common/EntitySpecRelationship.schema.json | 86 ++-- Common/EntitySpecification.schema.json | 140 +++--- Common/EntitySpecificationRef.schema.json | 72 +-- Common/Error.schema.json | 122 ++--- Common/EventRef.schema.json | 74 +-- Common/ExportJob.schema.json | 118 ++--- Common/FileDocument.schema.json | 74 +-- Common/FloatCharacteristic.schema.json | 48 +- Common/GeographicAddress.schema.json | 146 +++--- Common/GeographicAddressRef.schema.json | 56 +-- .../GeographicAddressValidation.schema.json | 100 ++-- Common/GeographicLocation.schema.json | 65 ++- Common/GeographicLocationRef.schema.json | 29 +- Common/GeographicSite.schema.json | 134 +++--- Common/GeographicSubAddress.schema.json | 120 ++--- Common/HeaderItem.schema.json | 46 +- Common/HourPeriod.schema.json | 46 +- Common/Hub.schema.json | 86 ++-- Common/ImpactEntityRef.schema.json | 64 +-- Common/ImportJob.schema.json | 110 ++--- Common/Incident.schema.json | 48 +- Common/IntegerCharacteristic.schema.json | 46 +- Common/JobStateType.schema.json | 32 +- Common/LocationCharacteristic.schema.json | 44 +- Common/MediumCharacteristic.schema.json | 117 ++--- Common/Monitor.schema.json | 80 ++-- Common/Note.schema.json | 66 +-- Common/Notification.schema.json | 74 +-- Common/Object.schema.json | 46 +- Common/ObjectCharacteristic.schema.json | 46 +- Common/Place.schema.json | 56 +-- Common/PlaceRef.schema.json | 31 +- Common/ProcessFlow.schema.json | 139 +++--- Common/ProcessFlowRef.schema.json | 42 +- Common/ProcessFlowStateType.schema.json | 32 +- Common/QualificationRef.schema.json | 37 +- Common/Quantity.schema.json | 48 +- Common/QuantityType.schema.json | 44 +- Common/RatedProductUsage.schema.json | 138 +++--- Common/Receiver.schema.json | 86 ++-- Common/ReceiverRef.schema.json | 56 +-- Common/Record.schema.json | 58 +-- Common/RelatedChangeRequestRef.schema.json | 72 +-- Common/RelatedChannel.schema.json | 45 +- Common/RelatedEntity.schema.json | 50 +- Common/RelatedEntityRef.schema.json | 64 +-- ...edGeographicLocationRefOrValue.schema.json | 56 ++- Common/RelatedObject.schema.json | 48 +- Common/RelatedPlace.schema.json | 64 +-- Common/Request.schema.json | 70 +-- Common/Resolution.schema.json | 68 +-- Common/Response.schema.json | 62 +-- Common/RetrieveGeographicLocation.schema.json | 76 +-- Common/RetrieveLocationRelation.schema.json | 80 ++-- Common/Sender.schema.json | 70 +-- Common/SiteRelationship.schema.json | 70 +-- Common/SpecCharRelationship.schema.json | 72 +-- Common/SpecCharacteristic.schema.json | 96 ++-- Common/SpecCharacteristicValue.schema.json | 104 ++--- Common/StatusChange.schema.json | 58 +-- Common/Street.schema.json | 80 ++-- Common/StreetSegment.schema.json | 78 ++-- Common/SubAddress.schema.json | 118 ++--- Common/TargetEntityRef.schema.json | 64 +-- Common/Task.schema.json | 56 +-- Common/TaskFlow.schema.json | 161 +++---- Common/TaskFlowRef.schema.json | 51 ++- Common/TaskFlowRelationship.schema.json | 43 +- Common/TaskFlowStateType.schema.json | 34 +- Common/TaskStateType.schema.json | 32 +- Common/TaxDefinition.schema.json | 61 +-- Common/Ticket.schema.json | 186 ++++---- Common/TicketRelationship.schema.json | 45 +- Common/TimePeriodType.schema.json | 44 +- Common/TroubleTicket.schema.json | 261 +++++------ Common/TroubleTicketRef.schema.json | 31 +- Common/TroubleTicketRelationship.schema.json | 43 +- Common/TroubleTicketStatusType.schema.json | 40 +- Common/Value.schema.json | 28 +- Common/WorkLog.schema.json | 70 +-- Customer/AccumulatedBalance.schema.json | 112 ++--- Customer/AppliedBillingRate.schema.json | 128 +++--- ...pliedBillingRateCharacteristic.schema.json | 48 +- Customer/AppliedBillingTaxRate.schema.json | 58 +-- .../AppliedCustomerBillingRate.schema.json | 128 +++--- Customer/AppliedPartyBillingRate.schema.json | 128 +++--- Customer/Appointment.schema.json | 183 ++++---- Customer/AppointmentRef.schema.json | 64 +-- Customer/AppointmentStateType.schema.json | 32 +- Customer/AppointmentStateValues.schema.json | 31 +- Customer/Authorization.schema.json | 88 ++-- Customer/BalanceActionRequestRef.schema.json | 44 +- Customer/BalanceActivity.schema.json | 122 ++--- Customer/BalanceAdjustment.schema.json | 16 +- Customer/BalanceAdjustmentBody.schema.json | 60 +-- Customer/BalanceAdjustmentRequest.schema.json | 120 ++--- Customer/BalanceDeduct.schema.json | 122 ++--- Customer/BalanceDeductRef.schema.json | 56 +-- Customer/BalanceDeductRollback.schema.json | 104 ++--- Customer/BalanceReserve.schema.json | 152 +++--- Customer/BalanceReserveRef.schema.json | 56 +-- Customer/BalanceTopup.schema.json | 16 +- Customer/BalanceTopupBody.schema.json | 60 +-- Customer/BalanceTopupRequest.schema.json | 190 ++++---- Customer/BalanceTopupStatus.schema.json | 42 +- .../BalanceTopupStatusTypeModify.schema.json | 30 +- Customer/BalanceTransfer.schema.json | 16 +- Customer/BalanceTransferBody.schema.json | 70 +-- Customer/BalanceTransferRequest.schema.json | 192 ++++---- ...alanceTransferStatusTypeModify.schema.json | 28 +- Customer/BalanceUnreserve.schema.json | 98 ++-- Customer/BankCardDetails.schema.json | 98 ++-- Customer/BankCardMethod.schema.json | 116 ++--- Customer/Bill.schema.json | 230 +++++----- Customer/BillFormat.schema.json | 70 +-- Customer/BillFormatRef.schema.json | 64 +-- Customer/BillFormatRefOrValue.schema.json | 56 ++- Customer/BillPresentationMedia.schema.json | 70 +-- Customer/BillPresentationMediaRef.schema.json | 64 +-- ...illPresentationMediaRefOrValue.schema.json | 56 ++- Customer/BillRef.schema.json | 64 +-- Customer/BillStructure.schema.json | 56 +-- Customer/BillingAccount.schema.json | 39 +- Customer/BillingAccountRef.schema.json | 64 +-- .../BillingCycleSpecification.schema.json | 134 +++--- .../BillingCycleSpecificationRef.schema.json | 80 ++-- ...ngCycleSpecificationRefOrValue.schema.json | 56 ++- Customer/Bucket.schema.json | 29 +- Customer/BucketBalance.schema.json | 158 +++---- Customer/BucketBalanceRef.schema.json | 44 +- Customer/CartItem.schema.json | 148 +++--- Customer/CartItemActionType.schema.json | 32 +- Customer/CartItemRef.schema.json | 48 +- Customer/CartItemRelationship.schema.json | 60 +-- Customer/CartItemStatusType.schema.json | 28 +- Customer/CartPrice.schema.json | 98 ++-- Customer/CartTerm.schema.json | 48 +- Customer/CashDetails.schema.json | 30 +- Customer/CashMethod.schema.json | 116 ++--- Customer/CheckDetails.schema.json | 74 +-- Customer/CheckMethod.schema.json | 116 ++--- Customer/CreditProfile.schema.json | 66 +-- Customer/Customer.schema.json | 176 +++---- Customer/CustomerBill.schema.json | 228 ++++----- Customer/DigitalWalletDetails.schema.json | 58 +-- Customer/DigitalWalletMethod.schema.json | 116 ++--- Customer/Disability.schema.json | 51 ++- Customer/OrderItem.schema.json | 172 +++---- Customer/OrderItemActionType.schema.json | 32 +- Customer/OrderItemPrice.schema.json | 107 ++--- Customer/OrderItemRelationship.schema.json | 44 +- Customer/OrderPrice.schema.json | 110 ++--- Customer/OrderRelationship.schema.json | 50 +- Customer/OrderTerm.schema.json | 56 +-- Customer/PaymentItem.schema.json | 46 +- Customer/PaymentMethod.schema.json | 112 ++--- Customer/PaymentMethodRef.schema.json | 64 +-- Customer/PaymentMethodRefOrValue.schema.json | 68 +-- Customer/PaymentPlan.schema.json | 94 ++-- Customer/PaymentRef.schema.json | 37 +- Customer/Price.schema.json | 68 +-- Customer/ProductOrder.schema.json | 283 ++++++------ Customer/ProductOrderItem.schema.json | 183 ++++---- .../ProductOrderItemStateType.schema.json | 44 +- Customer/ProductOrderRef.schema.json | 31 +- Customer/ProductOrderStateType.schema.json | 46 +- Customer/Quote.schema.json | 286 ++++++------ Customer/QuoteItem.schema.json | 193 ++++---- Customer/QuoteItemRef.schema.json | 66 +-- Customer/QuoteItemRelationship.schema.json | 48 +- Customer/QuotePrice.schema.json | 98 ++-- Customer/QuoteRef.schema.json | 28 +- Customer/SearchTimeSlot.schema.json | 123 ++--- Customer/SettlementMethod.schema.json | 48 +- Customer/SettlementNoteAdvice.schema.json | 178 ++++---- Customer/SettlementNoteImage.schema.json | 64 +-- Customer/SettlementNoteItem.schema.json | 112 ++--- Customer/ShoppingCart.schema.json | 106 ++--- Customer/ShoppingCartRef.schema.json | 56 +-- Customer/TaxItem.schema.json | 58 +-- Customer/TimeSlot.schema.json | 60 +-- Customer/TokenizedCardDetails.schema.json | 80 ++-- Customer/TokenizedCardMethod.schema.json | 116 ++--- Customer/VoucherDetails.schema.json | 68 +-- Customer/VoucherMethod.schema.json | 116 ++--- EngagedParty/Account.schema.json | 164 +++---- EngagedParty/AccountBalance.schema.json | 66 +-- EngagedParty/AccountBalanceRef.schema.json | 64 +-- EngagedParty/AccountDirectDetails.schema.json | 36 +- EngagedParty/AccountDirectMethod.schema.json | 118 ++--- EngagedParty/AccountRef.schema.json | 72 +-- EngagedParty/AccountRelationship.schema.json | 60 +-- EngagedParty/AccountTaxExemption.schema.json | 72 +-- EngagedParty/Agreement.schema.json | 205 +++++---- EngagedParty/AgreementAttachment.schema.json | 66 +-- .../AgreementAuthorization.schema.json | 58 +-- EngagedParty/AgreementItem.schema.json | 56 +-- EngagedParty/AgreementItemRef.schema.json | 40 +- EngagedParty/AgreementRef.schema.json | 40 +- .../AgreementSpecCharacteristic.schema.json | 84 ++-- ...reementSpecCharacteristicValue.schema.json | 88 ++-- .../AgreementSpecification.schema.json | 168 +++---- .../AgreementSpecificationRef.schema.json | 48 +- ...ementSpecificationRelationship.schema.json | 48 +- .../AgreementTermOrCondition.schema.json | 56 +-- EngagedParty/BankAccount.schema.json | 64 +-- .../BankAccountDebitDetails.schema.json | 72 +-- .../BankAccountDebitMethod.schema.json | 116 ++--- .../BankAccountTransferDetails.schema.json | 72 +-- .../BankAccountTransferMethod.schema.json | 116 ++--- EngagedParty/Contact.schema.json | 88 ++-- EngagedParty/FinancialAccount.schema.json | 37 +- EngagedParty/FinancialAccountRef.schema.json | 70 +-- EngagedParty/Individual.schema.json | 265 +++++------ .../IndividualIdentification.schema.json | 80 ++-- EngagedParty/IndividualStateType.schema.json | 28 +- EngagedParty/IssuerRef.schema.json | 56 +-- EngagedParty/LanguageAbility.schema.json | 91 ++-- EngagedParty/Organization.schema.json | 145 +++--- .../OrganizationChildRelationship.schema.json | 43 +- .../OrganizationIdentification.schema.json | 80 ++-- ...OrganizationParentRelationship.schema.json | 43 +- EngagedParty/OrganizationRef.schema.json | 27 +- .../OrganizationStateType.schema.json | 32 +- EngagedParty/OtherName.schema.json | 104 ++--- EngagedParty/OtherNameIndividual.schema.json | 126 ++--- .../OtherNameOrganization.schema.json | 61 +-- EngagedParty/PartnershipType.schema.json | 82 ++-- EngagedParty/PartnershipTypeRef.schema.json | 64 +-- EngagedParty/Party.schema.json | 117 ++--- EngagedParty/PartyAccount.schema.json | 78 ++-- EngagedParty/PartyAccountRef.schema.json | 80 ++-- EngagedParty/PartyBill.schema.json | 228 ++++----- EngagedParty/PartyCreditProfile.schema.json | 69 +-- EngagedParty/PartyOrPartyRoleRef.schema.json | 72 +-- EngagedParty/PartyRef.schema.json | 35 +- EngagedParty/PartyRole.schema.json | 188 ++++---- EngagedParty/PartyRoleRef.schema.json | 80 ++-- EngagedParty/RelatedParty.schema.json | 48 +- EngagedParty/RelatedPartyRef.schema.json | 70 +-- .../RelatedPartyRefOrValue.schema.json | 52 +-- EngagedParty/RoleType.schema.json | 82 ++-- EngagedParty/RoleTypeRef.schema.json | 72 +-- EngagedParty/Rule.schema.json | 72 +-- EngagedParty/RuleRef.schema.json | 62 +-- EngagedParty/SLA.schema.json | 132 +++--- EngagedParty/SLARef.schema.json | 64 +-- EngagedParty/SLAViolation.schema.json | 74 +-- EngagedParty/SLAViolationRef.schema.json | 50 +- EngagedParty/SettlementAccount.schema.json | 39 +- EngagedParty/Skill.schema.json | 67 +-- .../TaxExemptionCertificate.schema.json | 61 +-- EngagedParty/TemplateRef.schema.json | 62 +-- EngagedParty/Violation.schema.json | 90 ++-- MarketingSales/MarketSegmentRef.schema.json | 62 +-- .../MarketingCampaignRef.schema.json | 29 +- MarketingSales/SalesLead.schema.json | 234 +++++----- .../SalesOpportunityRef.schema.json | 29 +- ...ternateProductOfferingProposal.schema.json | 66 +-- Product/BaseProductRefOrValue.schema.json | 154 +++---- Product/BundledProductOffering.schema.json | 72 +-- .../BundledProductOfferingOption.schema.json | 56 +-- ...oductOfferingPriceRelationship.schema.json | 55 +-- Product/BundledProductOfferingRef.schema.json | 64 +-- .../BundledProductSpecification.schema.json | 64 +-- Product/CancelOrder.schema.json | 84 ++-- Product/CancelProductOrder.schema.json | 42 +- Product/Catalog.schema.json | 134 +++--- Product/Category.schema.json | 140 +++--- Product/CategoryRef.schema.json | 40 +- Product/ConsumptionSummary.schema.json | 88 ++-- ...ligibilityUnavailabilityReason.schema.json | 48 +- Product/LoyaltyAccount.schema.json | 43 +- Product/LoyaltyAccountRef.schema.json | 33 +- Product/LoyaltyAction.schema.json | 139 +++--- Product/LoyaltyActionRef.schema.json | 37 +- Product/LoyaltyBalance.schema.json | 67 ++- Product/LoyaltyCondition.schema.json | 61 ++- Product/LoyaltyConditionRef.schema.json | 37 +- Product/LoyaltyEvent.schema.json | 61 ++- Product/LoyaltyEventType.schema.json | 45 +- Product/LoyaltyEventTypeRef.schema.json | 37 +- Product/LoyaltyExecutionPoint.schema.json | 150 +++--- Product/LoyaltyProgramMember.schema.json | 71 ++- Product/LoyaltyProgramMemberRef.schema.json | 47 +- Product/LoyaltyProgramProduct.schema.json | 107 +++-- Product/LoyaltyProgramProductRef.schema.json | 47 +- Product/LoyaltyProgramProductSpec.schema.json | 87 ++-- .../LoyaltyProgramProductSpecRef.schema.json | 33 +- Product/LoyaltyRule.schema.json | 143 +++--- Product/LoyaltyRuleAction.schema.json | 37 +- Product/LoyaltyRuleCondition.schema.json | 37 +- Product/LoyaltyRuleEventType.schema.json | 37 +- Product/NetworkProduct.schema.json | 92 ++-- Product/NetworkProductRef.schema.json | 72 +-- Product/OrderStateType.schema.json | 46 +- Product/PriceAlteration.schema.json | 105 ++--- Product/PricingLogicAlgorithm.schema.json | 80 ++-- Product/Product.schema.json | 273 +++++------ Product/ProductActionType.schema.json | 32 +- Product/ProductCharacteristic.schema.json | 48 +- .../ProductInventoryRelationship.schema.json | 51 ++- Product/ProductOffering.schema.json | 294 ++++++------ Product/ProductOfferingPrice.schema.json | 292 ++++++------ Product/ProductOfferingPriceRef.schema.json | 31 +- ...oductOfferingPriceRelationship.schema.json | 64 +-- .../ProductOfferingQualification.schema.json | 207 ++++----- ...oductOfferingQualificationItem.schema.json | 150 +++--- ...ctOfferingQualificationItemRef.schema.json | 74 +-- ...roductOfferingQualificationRef.schema.json | 30 +- ...OfferingQualificationStateType.schema.json | 32 +- Product/ProductOfferingRef.schema.json | 31 +- Product/ProductOfferingTerm.schema.json | 64 +-- Product/ProductPrice.schema.json | 107 ++--- Product/ProductRef.schema.json | 29 +- Product/ProductRefOrValue.schema.json | 30 +- Product/ProductRelationship.schema.json | 51 ++- Product/ProductRequest.schema.json | 250 +++++----- Product/ProductRestriction.schema.json | 110 ++--- .../ProductSpecCharRelationship.schema.json | 48 +- Product/ProductSpecCharacteristic.schema.json | 96 ++-- ...ProductSpecCharacteristicValue.schema.json | 88 ++-- Product/ProductSpecification.schema.json | 228 ++++----- ...uctSpecificationCharacteristic.schema.json | 140 +++--- ...tionCharacteristicRelationship.schema.json | 80 ++-- ...ecificationCharacteristicValue.schema.json | 104 ++--- ...ficationCharacteristicValueUse.schema.json | 92 ++-- Product/ProductSpecificationRef.schema.json | 48 +- ...oductSpecificationRelationship.schema.json | 64 +-- .../ProductSpecificationSchemaRef.schema.json | 40 +- Product/ProductStatusType.schema.json | 40 +- Product/ProductTerm.schema.json | 64 +-- Product/Promotion.schema.json | 110 ++--- Product/PromotionAction.schema.json | 66 +-- Product/PromotionCriteria.schema.json | 64 +-- Product/PromotionCriteriaGroup.schema.json | 68 +-- Product/PromotionPattern.schema.json | 104 ++--- .../QualificationItemRelationship.schema.json | 48 +- Product/QuoteItemStateType.schema.json | 32 +- Product/QuoteStateType.schema.json | 36 +- Product/QuoteTerm.schema.json | 56 +-- Product/Recommendation.schema.json | 132 +++--- Product/RecommendationItem.schema.json | 48 +- Product/RelatedProductOrderItem.schema.json | 82 ++-- Product/TargetProductSchema.schema.json | 45 +- Product/Usage.schema.json | 124 ++--- Product/UsageCharacteristic.schema.json | 48 +- Product/UsageConsumptionReport.schema.json | 94 ++-- Product/UsageConsumptionReportRef.schema.json | 74 +-- .../UsageConsumptionReportRequest.schema.json | 118 ++--- ...sageConsumptionReportRequestIn.schema.json | 76 +-- Product/UsageSpecCharacteristic.schema.json | 68 +-- .../UsageSpecCharacteristicValue.schema.json | 72 +-- Product/UsageSpecification.schema.json | 84 ++-- Product/UsageSpecificationRef.schema.json | 64 +-- Product/UsageVolumeBalance.schema.json | 56 +-- Product/UsageVolumeProduct.schema.json | 100 ++-- Product/UsageVolumeProductRef.schema.json | 56 +-- Resource/LogicalResource.schema.json | 182 ++++---- Resource/PhysicalResource.schema.json | 208 ++++----- Resource/RealizingResourceRef.schema.json | 28 +- Resource/Resource.schema.json | 174 +++---- Resource/ResourceAlarmRef.schema.json | 62 +-- Resource/ResourceCandidateRef.schema.json | 72 +-- Resource/ResourceCharacteristic.schema.json | 46 +- Resource/ResourceOrder.schema.json | 180 ++++---- Resource/ResourceOrderItem.schema.json | 82 ++-- Resource/ResourceOrderItemRef.schema.json | 46 +- .../ResourceOrderItemRelationship.schema.json | 44 +- Resource/ResourceOrderRef.schema.json | 54 +-- .../ResourceOrderRelationship.schema.json | 50 +- Resource/ResourceRef.schema.json | 46 +- Resource/ResourceRelationship.schema.json | 48 +- Resource/ResourceSpecificationRef.schema.json | 72 +-- Resource/SupportingResource.schema.json | 54 +-- Service/AlternateServiceProposal.schema.json | 56 +-- Service/AppliedConsequence.schema.json | 64 +-- Service/BaseService.schema.json | 174 +++---- Service/FirstAlert.schema.json | 56 +-- Service/ImpactPattern.schema.json | 54 +-- .../MeasureThresholdRuleViolation.schema.json | 118 ++--- .../MetricDefMeasureConsequence.schema.json | 72 +-- .../MetricDefMeasureThresholdRule.schema.json | 118 ++--- Service/ProblemAcknowledgement.schema.json | 82 ++-- Service/ProblemGroup.schema.json | 68 +-- Service/ProblemUnacknowledgement.schema.json | 82 ++-- Service/ProblemUngroup.schema.json | 68 +-- Service/Service.schema.json | 130 +++--- Service/ServiceCandidate.schema.json | 120 ++--- Service/ServiceCandidateRef.schema.json | 72 +-- Service/ServiceCatalog.schema.json | 126 ++--- Service/ServiceCategory.schema.json | 142 +++--- Service/ServiceCategoryRef.schema.json | 64 +-- Service/ServiceCharacteristic.schema.json | 56 +-- ...ligibilityUnavailabilityReason.schema.json | 48 +- Service/ServiceLevelObjective.schema.json | 142 +++--- Service/ServiceLevelObjectiveRef.schema.json | 56 +-- .../ServiceLevelSpecConsequence.schema.json | 48 +- Service/ServiceLevelSpecParameter.schema.json | 94 ++-- Service/ServiceLevelSpecification.schema.json | 86 ++-- .../ServiceLevelSpecificationRef.schema.json | 64 +-- ...erviceOfferingQualificationRef.schema.json | 64 +-- Service/ServiceOrder.schema.json | 210 ++++----- Service/ServiceOrderActionType.schema.json | 32 +- Service/ServiceOrderItem.schema.json | 89 ++-- .../ServiceOrderItemRelationship.schema.json | 53 ++- Service/ServiceOrderRef.schema.json | 64 +-- Service/ServiceOrderRelationship.schema.json | 68 +-- Service/ServiceOrderStateType.schema.json | 42 +- Service/ServiceProblem.schema.json | 432 +++++++++--------- Service/ServiceProblemEventRecord.schema.json | 80 ++-- Service/ServiceProblemRef.schema.json | 62 +-- Service/ServiceQualification.schema.json | 184 ++++---- Service/ServiceQualificationItem.schema.json | 172 +++---- ...eQualificationItemRelationship.schema.json | 48 +- ...rviceQualificationRelationship.schema.json | 46 +- Service/ServiceRef.schema.json | 31 +- Service/ServiceRelationship.schema.json | 43 +- .../ServiceSpecCharRelationship.schema.json | 80 ++-- Service/ServiceSpecCharacteristic.schema.json | 148 +++--- ...ServiceSpecCharacteristicValue.schema.json | 104 ++--- Service/ServiceSpecRelationship.schema.json | 80 ++-- Service/ServiceSpecification.schema.json | 198 ++++---- Service/ServiceSpecificationRef.schema.json | 80 ++-- Service/ServiceStateType.schema.json | 36 +- Service/ServiceTest.schema.json | 144 +++--- Service/ServiceTestCharacteristic.schema.json | 48 +- Service/ServiceTestSpecification.schema.json | 102 ++--- .../ServiceTestSpecificationRef.schema.json | 64 +-- Service/SupportingService.schema.json | 64 +-- Service/TargetServiceSchema.schema.json | 43 +- Service/TerminationError.schema.json | 38 +- Service/TestMeasure.schema.json | 114 ++--- Service/TestMeasureDefinition.schema.json | 126 ++--- Service/TrackingRecord.schema.json | 88 ++-- 474 files changed, 19798 insertions(+), 19717 deletions(-) diff --git a/Common/Address.schema.json b/Common/Address.schema.json index ff0dff0f..44debacb 100644 --- a/Common/Address.schema.json +++ b/Common/Address.schema.json @@ -1,71 +1,71 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Address.schema.json", - "title": "Address", - "definitions": { - "Address": { - "$id": "#Address", - "description": "Structured textual way of describing how to find a Property in an urban area (country properties are often\ndefined differently).\nNote : Address corresponds to SID UrbanPropertyAddress", - "type": "object", - "properties": { - "city": { - "type": "string", - "description": "City that the address is in" - }, - "country": { - "type": "string", - "description": "Country that the address is in" - }, - "locality": { - "type": "string", - "description": "\"An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature.\" [ANZLIC-STREET], or a suburb \"a bounded locality within a city, town or shire principally of urban character \" [ANZLICSTREET]" - }, - "postcode": { - "type": "string", - "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" - }, - "stateOrProvince": { - "type": "string", - "description": "the State or Province that the address is in" - }, - "streetName": { - "type": "string", - "description": "Name of the street or other street type" - }, - "streetNr": { - "type": "string", - "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" - }, - "streetNrLast": { - "type": "string", - "description": "Last number in a range of street numbers allocated to a property" - }, - "streetNrLastSuffix": { - "type": "string", - "description": "Last street number suffix for a ranged address" - }, - "streetNrSuffix": { - "type": "string", - "description": "the first street number suffix" - }, - "streetSuffix": { - "type": "string", - "description": "A modifier denoting a relative direction" - }, - "streetType": { - "type": "string", - "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf " - }, - "subAddress": { - "$ref": "SubAddress.schema.json#SubAddress", - "description": "Within a property in an urban area, may refer to a building, building cluster, or a floor of a multistory building" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Address.schema.json", + "title": "Address", + "definitions": { + "Address": { + "$id": "#Address", + "description": "Structured textual way of describing how to find a Property in an urban area (country properties are often\ndefined differently).\nNote : Address corresponds to SID UrbanPropertyAddress", + "type": "object", + "properties": { + "city": { + "type": "string", + "description": "City that the address is in" + }, + "country": { + "type": "string", + "description": "Country that the address is in" + }, + "locality": { + "type": "string", + "description": "\"An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature.\" [ANZLIC-STREET], or a suburb \"a bounded locality within a city, town or shire principally of urban character \" [ANZLICSTREET]" + }, + "postcode": { + "type": "string", + "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" + }, + "stateOrProvince": { + "type": "string", + "description": "the State or Province that the address is in" + }, + "streetName": { + "type": "string", + "description": "Name of the street or other street type" + }, + "streetNr": { + "type": "string", + "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" + }, + "streetNrLast": { + "type": "string", + "description": "Last number in a range of street numbers allocated to a property" + }, + "streetNrLastSuffix": { + "type": "string", + "description": "Last street number suffix for a ranged address" + }, + "streetNrSuffix": { + "type": "string", + "description": "the first street number suffix" + }, + "streetSuffix": { + "type": "string", + "description": "A modifier denoting a relative direction" + }, + "streetType": { + "type": "string", + "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf " + }, + "subAddress": { + "$ref": "SubAddress.schema.json#SubAddress", + "description": "Within a property in an urban area, may refer to a building, building cluster, or a floor of a multistory building" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/AddressRef.schema.json b/Common/AddressRef.schema.json index 071835c3..b5d22d4c 100644 --- a/Common/AddressRef.schema.json +++ b/Common/AddressRef.schema.json @@ -1,16 +1,16 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AddressRef.schema.json", - "title": "AddressRef", - "definitions": { - "AddressRef": { - "$id": "#AddressRef", - "type": "object", - "allOf": [ - { - "$ref": "Entity.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AddressRef.schema.json", + "title": "AddressRef", + "definitions": { + "AddressRef": { + "$id": "#AddressRef", + "type": "object", + "allOf": [ + { + "$ref": "EntityRef.schema.json#EntityRef" } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Any.schema.json b/Common/Any.schema.json index 152f28f0..fd85d65c 100644 --- a/Common/Any.schema.json +++ b/Common/Any.schema.json @@ -1,9 +1,11 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Any.schema.json", - "title": "Any", - "definitions": { - "Any": { - } - } -} +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Any.schema.json", + "title": "Any", + "definitions": { + "Any": { + "$id": "#Any", + "type": "object" + } + } +} \ No newline at end of file diff --git a/Common/Area.schema.json b/Common/Area.schema.json index 915f2871..94c05b2b 100644 --- a/Common/Area.schema.json +++ b/Common/Area.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Area.schema.json", - "title": "Area", - "definitions": { - "Area": { - "$id": "#Area", - "description": "Area corresponds to a geographic area as a city, a locality, a district, etc.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of an Area" - }, - "name": { - "type": "string", - "description": "The defined name of the municipality" - }, - "areaType": { - "type": "string", - "description": "SUBURB, LOCALITY, CITY, TOWN, BOROUGH, ..." - }, - "characteristic": { - "type": "array", - "description": "Any additional characterization of the Area, defined for the Area type", - "items": { - "$ref": "LocationCharacteristic.schema.json#LocationCharacteristic" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Area.schema.json", + "title": "Area", + "definitions": { + "Area": { + "$id": "#Area", + "description": "Area corresponds to a geographic area as a city, a locality, a district, etc.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of an Area" + }, + "name": { + "type": "string", + "description": "The defined name of the municipality" + }, + "areaType": { + "type": "string", + "description": "SUBURB, LOCALITY, CITY, TOWN, BOROUGH, ..." + }, + "characteristic": { + "type": "array", + "description": "Any additional characterization of the Area, defined for the Area type", + "items": { + "$ref": "LocationCharacteristic.schema.json#LocationCharacteristic" + } } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Association.schema.json b/Common/Association.schema.json index 4335f72b..7ef72a15 100644 --- a/Common/Association.schema.json +++ b/Common/Association.schema.json @@ -1,67 +1,67 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Association.schema.json", - "title": "Association", - "definitions": { - "Association": { - "$id": "#Association", - "description": "Association is the class that describe a relationship between two or more entity specifications based on a given association specification. The role and type of each endpoint in the relationship is given by an association role. The type of endpoints in the relationship should match the ones as defined in the corresponding association role specification. A relationship between entity specifications may be governed by conditions and rules which are addressed by constraint references in this resource. Constraints for a relationship may include new rules and conditions in addition to those defined for the corresponding association specification", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the association" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to this association" - }, - "id": { - "type": "string", - "description": "unique identifier of the association" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "The last modified date of this association object" - }, - "lifecycleStatus": { - "type": "string", - "description": "Indicates the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name given to this association" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which this association is valid" - }, - "version": { - "type": "string", - "description": "Version of this REST resource" - }, - "associationSpec": { - "$ref": "AssociationSpecRef.schema.json#AssociationSpecRef", - "description": "The specification of this association" - }, - "associationRole": { - "$ref": "AssociationRole.schema.json#AssociationRole", - "description": "The role of this association" - }, - "constraint": { - "description": "Any constraints in this association", - "type": "array", - "items": { - "$ref": "ConstraintRef.schema.json#ConstraintRef" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Association.schema.json", + "title": "Association", + "definitions": { + "Association": { + "$id": "#Association", + "description": "Association is the class that describe a relationship between two or more entity specifications based on a given association specification. The role and type of each endpoint in the relationship is given by an association role. The type of endpoints in the relationship should match the ones as defined in the corresponding association role specification. A relationship between entity specifications may be governed by conditions and rules which are addressed by constraint references in this resource. Constraints for a relationship may include new rules and conditions in addition to those defined for the corresponding association specification", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the association" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to this association" + }, + "id": { + "type": "string", + "description": "unique identifier of the association" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "The last modified date of this association object" + }, + "lifecycleStatus": { + "type": "string", + "description": "Indicates the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name given to this association" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which this association is valid" + }, + "version": { + "type": "string", + "description": "Version of this REST resource" + }, + "associationSpec": { + "$ref": "AssociationSpecRef.schema.json#AssociationSpecRef", + "description": "The specification of this association" + }, + "associationRole": { + "$ref": "AssociationRole.schema.json#AssociationRole", + "description": "The role of this association" + }, + "constraint": { + "description": "Any constraints in this association", + "type": "array", + "items": { + "$ref": "ConstraintRef.schema.json#ConstraintRef" + } } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/AssociationRoleSpec.schema.json b/Common/AssociationRoleSpec.schema.json index e0685691..b55790bd 100644 --- a/Common/AssociationRoleSpec.schema.json +++ b/Common/AssociationRoleSpec.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AssociationRoleSpec.schema.json", - "title": "AssociationRoleSpec", - "definitions": { - "AssociationRoleSpec": { - "$id": "#AssociationRoleSpec", - "description": "This embedded object represents the role and type of each entity involved in a relationship.", - "type": "object", - "properties": { - "aggregation": { - "type": "string" - }, - "defaultQuantity": { - "type": "integer" - }, - "entityType": { - "type": "string" - }, - "isNavigable": { - "type": "boolean" - }, - "isSource": { - "type": "boolean" - }, - "maxQuantity": { - "type": "integer" - }, - "minQuantity": { - "type": "integer" - }, - "role": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AssociationRoleSpec.schema.json", + "title": "AssociationRoleSpec", + "definitions": { + "AssociationRoleSpec": { + "$id": "#AssociationRoleSpec", + "description": "This embedded object represents the role and type of each entity involved in a relationship.", + "type": "object", + "properties": { + "aggregation": { + "type": "string" + }, + "defaultQuantity": { + "type": "integer" + }, + "entityType": { + "type": "string" + }, + "isNavigable": { + "type": "boolean" + }, + "isSource": { + "type": "boolean" + }, + "maxQuantity": { + "type": "integer" + }, + "minQuantity": { + "type": "integer" + }, + "role": { + "type": "string" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/AssociationSpecification.schema.json b/Common/AssociationSpecification.schema.json index 7abd582e..855b281f 100644 --- a/Common/AssociationSpecification.schema.json +++ b/Common/AssociationSpecification.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AssociationSpecification.schema.json", - "title": "AssociationSpecification", - "definitions": { - "AssociationSpecification": { - "$id": "#AssociationSpecification", - "description": "AssociationSpecification is an association class that describes a type of relationship between two entities. This is a generic construct that may be used to describe relationship types and roles. The role and type of each entity in the relationship is given by an association role specification. Two role specifications are embedded in the association specification.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the specification" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to this specification" - }, - "id": { - "type": "string", - "description": "unique identifier of the association specification" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "The last modified date of this specification" - }, - "lifecycleStatus": { - "type": "string", - "description": "Indicates the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name given to this association specification" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which this specification is valid" - }, - "version": { - "type": "string", - "description": "Version of this association" - }, - "constraint": { - "type": "array", - "items": { - "$ref": "ConstraintRef.schema.json#ConstraintRef" - } - }, - "associationRoleSpec": { - "$ref": "AssociationRoleSpec.schema.json#AssociationRoleSpec" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AssociationSpecification.schema.json", + "title": "AssociationSpecification", + "definitions": { + "AssociationSpecification": { + "$id": "#AssociationSpecification", + "description": "AssociationSpecification is an association class that describes a type of relationship between two entities. This is a generic construct that may be used to describe relationship types and roles. The role and type of each entity in the relationship is given by an association role specification. Two role specifications are embedded in the association specification.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the specification" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to this specification" + }, + "id": { + "type": "string", + "description": "unique identifier of the association specification" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "The last modified date of this specification" + }, + "lifecycleStatus": { + "type": "string", + "description": "Indicates the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name given to this association specification" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which this specification is valid" + }, + "version": { + "type": "string", + "description": "Version of this association" + }, + "constraint": { + "type": "array", + "items": { + "$ref": "ConstraintRef.schema.json#ConstraintRef" + } + }, + "associationRoleSpec": { + "$ref": "AssociationRoleSpec.schema.json#AssociationRoleSpec" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Attachment.schema.json b/Common/Attachment.schema.json index ac5e7d46..77182f4c 100644 --- a/Common/Attachment.schema.json +++ b/Common/Attachment.schema.json @@ -1,80 +1,80 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Attachment.schema.json", - "title": "Attachment", - "definitions": { - "Attachment": { - "$id": "#Attachment", - "description": "Complements the description of an element (for instance a product) through video, pictures...", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for this particular attachment", - "examples": [ - "4aafacbd-11ff-4dc8-b445-305f2215715f", - "2334bc59-726e-4d34-ab96-f50e0561412f" - ] - }, - "href": { - "type": "string", - "format": "uri", - "description": "URI for this Attachment", - "examples": [ - "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f" - ] - }, - "name": { - "type": "string", - "description": "The name of the attachment" - }, - "description": { - "type": "string", - "description": "A narrative text describing the content of the attachment", - "examples": [ - "Photograph of the Product", - "Explanation Video" - ] - }, - "attachmentType": { - "type": "string", - "description": "Attachment type such as video, picture", - "examples": [ - "video", - "picture" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "Uniform Resource Locator, is a web page address (a subset of URI)", - "examples": [ - "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f" - ] - }, - "mimeType": { - "type": "string", - "description": "Attachment mime type such as extension file for video, picture and document" - }, - "content": { - "type": "string", - "format": "base64", - "description": "The actual contents of the attachment object, if embedded, encoded as base64" - }, - "size": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "The size of the attachment." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period of time for which the attachment is valid" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Attachment.schema.json", + "title": "Attachment", + "definitions": { + "Attachment": { + "$id": "#Attachment", + "description": "Complements the description of an element (for instance a product) through video, pictures...", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for this particular attachment", + "examples": [ + "4aafacbd-11ff-4dc8-b445-305f2215715f", + "2334bc59-726e-4d34-ab96-f50e0561412f" + ] + }, + "href": { + "type": "string", + "format": "uri", + "description": "URI for this Attachment", + "examples": [ + "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f" + ] + }, + "name": { + "type": "string", + "description": "The name of the attachment" + }, + "description": { + "type": "string", + "description": "A narrative text describing the content of the attachment", + "examples": [ + "Photograph of the Product", + "Explanation Video" + ] + }, + "attachmentType": { + "type": "string", + "description": "Attachment type such as video, picture", + "examples": [ + "video", + "picture" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "Uniform Resource Locator, is a web page address (a subset of URI)", + "examples": [ + "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f" + ] + }, + "mimeType": { + "type": "string", + "description": "Attachment mime type such as extension file for video, picture and document" + }, + "content": { + "type": "string", + "format": "base64", + "description": "The actual contents of the attachment object, if embedded, encoded as base64" + }, + "size": { + "$ref": "Quantity.schema.json#Quantity", + "description": "The size of the attachment." + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period of time for which the attachment is valid" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/AttachmentRef.schema.json b/Common/AttachmentRef.schema.json index bab73a54..475cfcaa 100644 --- a/Common/AttachmentRef.schema.json +++ b/Common/AttachmentRef.schema.json @@ -1,41 +1,41 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AttachmentRef.schema.json", - "title": "AttachmentRef", - "definitions": { - "AttachmentRef": { - "$id": "#AttachmentRef", - "description": "Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative text describing the content of the attachment" - }, - "href": { - "type": "string", - "description": "URL serving as reference for the attachment resource", - "format": "uri" - }, - "id": { - "description": "Unique-Identifier for this attachment", - "type": "string" - }, - "url": { - "description": "Link to the attachment media/content", - "type": "string", - "format": "uri" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AttachmentRef.schema.json", + "title": "AttachmentRef", + "definitions": { + "AttachmentRef": { + "$id": "#AttachmentRef", + "description": "Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative text describing the content of the attachment" + }, + "href": { + "type": "string", + "description": "URL serving as reference for the attachment resource", + "format": "uri" + }, + "id": { + "description": "Unique-Identifier for this attachment", + "type": "string" + }, + "url": { + "description": "Link to the attachment media/content", + "type": "string", + "format": "uri" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "EntityRef.schema.json#EntityRef" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/AttachmentRefOrValue.schema.json b/Common/AttachmentRefOrValue.schema.json index 55831b0e..8e45da53 100644 --- a/Common/AttachmentRefOrValue.schema.json +++ b/Common/AttachmentRefOrValue.schema.json @@ -1,20 +1,20 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AttachmentRefOrValue.schema.json", - "title": "AttachmentRefOrValue", - "definitions": { - "AttachmentRefOrValue": { - "type": "object", - "description": "An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and not to AttchmentRefOrValue itself", - "allOf": [ - { - "$ref": "AttachmentRef.schema.json#AttachmentRef" - }, - { - "$ref": "Attachment.schema.json#Attachment" - } - - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AttachmentRefOrValue.schema.json", + "title": "AttachmentRefOrValue", + "definitions": { + "AttachmentRefOrValue": { + "$id": "#AttachmentRefOrValue", + "type": "object", + "description": "An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and not to AttchmentRefOrValue itself", + "allOf": [ + { + "$ref": "AttachmentRef.schema.json#AttachmentRef" + }, + { + "$ref": "Attachment.schema.json#Attachment" } + ] } + } } \ No newline at end of file diff --git a/Common/BaseEvent.schema.json b/Common/BaseEvent.schema.json index 6272cb68..0617c346 100644 --- a/Common/BaseEvent.schema.json +++ b/Common/BaseEvent.schema.json @@ -1,66 +1,65 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BaseEvent.schema.json", - "title": "BaseEvent", - "definitions": { - "BaseEvent": { - "$id": "#BaseEvent", - "description": "Base event with common attributes.", - "type": "object", - "properties": { - - "id": { - "type": "string", - "description": "Identifier of the Process flow" - }, - "href": { - "type": "string", - "description": "Reference of the ProcessFlow" - }, - "eventId": { - "type": "string", - "description": "The identifier of the notification." - }, - "eventTime": { - "type": "string", - "format": "date-time", - "description": "Time of the event occurrence." - }, - "eventType": { - "type": "string", - "description": "The type of the notification." - }, - "correlationId": { - "type": "string", - "description": "The correlation id for this event." - }, - "domain": { - "type": "string", - "description": "The domain of the event." - }, - "title": { - "type": "string", - "description": "The title of the event." - }, - "description": { - "type": "string", - "description": "An explnatory of the event." - }, - "priority": { - "type": "string", - "description": "A priority." - }, - "timeOcurred": { - "type": "string", - "format": "date-time", - "description": "The time the event occured." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] - } - } -} +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BaseEvent.schema.json", + "title": "BaseEvent", + "definitions": { + "BaseEvent": { + "$id": "#BaseEvent", + "description": "Base event with common attributes.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the Process flow" + }, + "href": { + "type": "string", + "description": "Reference of the ProcessFlow" + }, + "eventId": { + "type": "string", + "description": "The identifier of the notification." + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "Time of the event occurrence." + }, + "eventType": { + "type": "string", + "description": "The type of the notification." + }, + "correlationId": { + "type": "string", + "description": "The correlation id for this event." + }, + "domain": { + "type": "string", + "description": "The domain of the event." + }, + "title": { + "type": "string", + "description": "The title of the event." + }, + "description": { + "type": "string", + "description": "An explnatory of the event." + }, + "priority": { + "type": "string", + "description": "A priority." + }, + "timeOcurred": { + "type": "string", + "format": "date-time", + "description": "The time the event occured." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] + } + } +} \ No newline at end of file diff --git a/Common/BasePlusEvent.schema.json b/Common/BasePlusEvent.schema.json index 16235b88..73240532 100644 --- a/Common/BasePlusEvent.schema.json +++ b/Common/BasePlusEvent.schema.json @@ -1,61 +1,61 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BasePlusEvent.schema.json", - "title": "BasePlusEvent", - "definitions": { - "BasePlusEvent": { - "$id": "#BasePlusEvent", - "description": "Base event with common attributes.", - "type": "object", - "properties": { - "eventId": { - "type": "string", - "description": "The identifier of the notification." - }, - "eventTime": { - "type": "string", - "format": "date-time", - "description": "Time of the event occurrence." - }, - "eventType": { - "type": "string", - "description": "The type of the notification." - }, - "correlationId": { - "type": "string", - "description": "The correlation id for this event." - }, - "domain": { - "type": "string", - "description": "The domain of the event." - }, - "title": { - "type": "string", - "description": "The title of the event." - }, - "description": { - "type": "string", - "description": "An explnatory of the event." - }, - "priority": { - "type": "string", - "description": "A priority." - }, - "timeOcurred": { - "type": "string", - "format": "date-time", - "description": "The time the event occured." - }, - "fieldPath": { - "type": "string", - "description": "The path identifying the object field concerned by this notification." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] - } - } -} +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BasePlusEvent.schema.json", + "title": "BasePlusEvent", + "definitions": { + "BasePlusEvent": { + "$id": "#BasePlusEvent", + "description": "Base event with common attributes.", + "type": "object", + "properties": { + "eventId": { + "type": "string", + "description": "The identifier of the notification." + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "Time of the event occurrence." + }, + "eventType": { + "type": "string", + "description": "The type of the notification." + }, + "correlationId": { + "type": "string", + "description": "The correlation id for this event." + }, + "domain": { + "type": "string", + "description": "The domain of the event." + }, + "title": { + "type": "string", + "description": "The title of the event." + }, + "description": { + "type": "string", + "description": "An explnatory of the event." + }, + "priority": { + "type": "string", + "description": "A priority." + }, + "timeOcurred": { + "type": "string", + "format": "date-time", + "description": "The time the event occured." + }, + "fieldPath": { + "type": "string", + "description": "The path identifying the object field concerned by this notification." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] + } + } +} \ No newline at end of file diff --git a/Common/BusinessInteraction.schema.json b/Common/BusinessInteraction.schema.json index 3f26e7ba..cee181ff 100644 --- a/Common/BusinessInteraction.schema.json +++ b/Common/BusinessInteraction.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BusinessInteraction.schema.json", - "title": "BusinessInteraction", - "definitions": { - "BusinessInteraction": { - "$id": "#BusinessInteraction", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A description of this interaction" - }, - "id": { - "type": "string", - "description": "The unique ID for this interaction" - }, - "interactionData": { - "type": "string", - "format": "date-time" - }, - "interactionDataComplete": { - "type": "string", - "format": "date-time" - }, - "interactionDataStatus": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BusinessInteraction.schema.json", + "title": "BusinessInteraction", + "definitions": { + "BusinessInteraction": { + "$id": "#BusinessInteraction", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of this interaction" + }, + "id": { + "type": "string", + "description": "The unique ID for this interaction" + }, + "interactionData": { + "type": "string", + "format": "date-time" + }, + "interactionDataComplete": { + "type": "string", + "format": "date-time" + }, + "interactionDataStatus": { + "type": "string" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/CalendarEventRef.schema.json b/Common/CalendarEventRef.schema.json index fba6f057..f122814b 100644 --- a/Common/CalendarEventRef.schema.json +++ b/Common/CalendarEventRef.schema.json @@ -1,20 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CalendarEventRef.schema.json", - "title": "CalendarEventRef", - "definitions": { - "CalendarEventRef": { - "$id": "#CalendarEventRef", - "type": "object", - - "description": "Reference of a CalendarEvent", - "properties": { - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CalendarEventRef.schema.json", + "title": "CalendarEventRef", + "definitions": { + "CalendarEventRef": { + "$id": "#CalendarEventRef", + "type": "object", + "description": "Reference of a CalendarEvent", + "properties": {}, + "allOf": [ + { + "$ref": "EntityRef.schema.json#EntityRef" } + ] } -} + } +} \ No newline at end of file diff --git a/Common/CalendarPeriod.schema.json b/Common/CalendarPeriod.schema.json index 017e7020..ed3bc2e3 100644 --- a/Common/CalendarPeriod.schema.json +++ b/Common/CalendarPeriod.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CalendarPeriod.schema.json", - "title": "CalendarPeriod", - "definitions": { - "CalendarPeriod": { - "$id": "#CalendarPeriod", - "type": "object", - "properties": { - "day": { - "type": "string", - "description": "Day where the calendar status applies (e.g.: monday, mon-to-fri, weekdays, weekend, all week, ...)" - }, - "status": { - "type": "string", - "description": "Indication of the availability of the site (e.g.: open)" - }, - "timeZone": { - "type": "string", - "description": "Indication of the timezone applicable to the calendar information (e.g.: Paris, GMT+1)" - }, - "hourPeriod": { - "type": "array", - "items": { - "$ref": "HourPeriod.schema.json#HourPeriod" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CalendarPeriod.schema.json", + "title": "CalendarPeriod", + "definitions": { + "CalendarPeriod": { + "$id": "#CalendarPeriod", + "type": "object", + "properties": { + "day": { + "type": "string", + "description": "Day where the calendar status applies (e.g.: monday, mon-to-fri, weekdays, weekend, all week, ...)" + }, + "status": { + "type": "string", + "description": "Indication of the availability of the site (e.g.: open)" + }, + "timeZone": { + "type": "string", + "description": "Indication of the timezone applicable to the calendar information (e.g.: Paris, GMT+1)" + }, + "hourPeriod": { + "type": "array", + "items": { + "$ref": "HourPeriod.schema.json#HourPeriod" + } } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/ChangeRequest.schema.json b/Common/ChangeRequest.schema.json index 79a03453..c0866d8e 100644 --- a/Common/ChangeRequest.schema.json +++ b/Common/ChangeRequest.schema.json @@ -1,185 +1,185 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ChangeRequest.schema.json", - "title": "ChangeRequest", - "definitions": { - "ChangeRequest": { - "$id": "#ChangeRequest", - "description": "Change Request is a type of request which can be used for the management and control of Change Management \nprocess between a customer and a service provider or between a service provider and a partner and vice versa.", - "type": "object", - "properties": { - "actualEndTime": { - "type": "string", - "format": "date-time", - "description": "Date and time when the change implementation actually finished" - }, - "actualStartTime": { - "type": "string", - "format": "date-time", - "description": "Date and time when the change implementation actually started" - }, - "budget": { - "type": "string", - "description": "The budget reserved for the change" - }, - "channel": { - "type": "string", - "description": "A channel represents the way the Change Request was created" - }, - "completionDate": { - "type": "string", - "format": "date-time", - "description": "Date and time when the change request is confirmed to be completed" - }, - "currency": { - "type": "string", - "description": "The used currency related with cost" - }, - "description": { - "type": "string", - "description": "Description of the change request" - }, - "externalId": { - "type": "string", - "description": "ID given by the requestor to facilitate the relationship set up and subsequent searches" - }, - "href": { - "type": "string", - "description": "Hyperlink to access a change request" - }, - "id": { - "type": "string", - "description": "Identifier of a Change Request. It is created on repository side (a Change Management system)" - }, - "impact": { - "type": "string", - "description": "Indicates the impact of this change" - }, - "plannedEndTime": { - "type": "string", - "format": "date-time", - "description": "Date and time when the change implementation is planned to be finished" - }, - "plannedStartTime": { - "type": "string", - "format": "date-time", - "description": "Date and time when the change implementation is planned to be started" - }, - "priority": { - "type": "string", - "description": "Used by consumers to prioritize a change request in Change Management system" - }, - "requestDate": { - "type": "string", - "format": "date-time", - "description": "Date and time when the change request is raised" - }, - "requestType": { - "type": "string", - "description": "Indicates the type of the change request" - }, - "risk": { - "type": "string", - "description": "The risk to implement this change request" - }, - "riskMitigationPlan": { - "type": "string", - "description": "The risk mitigation plan" - }, - "riskValue": { - "type": "string", - "description": "The additional cost if the risk will happen" - }, - "scheduledDate": { - "type": "string", - "format": "date-time", - "description": "Date and time that the schedule is made" - }, - "status": { - "type": "string", - "description": "Status of the change request and its sub-state" - }, - "attachment": { - "type": "array", - "items": { - "$ref": "Attachment.schema.json#Attachment" - }, - "description": "The attachments of the communication message (when it is email type)" - }, - "workLog": { - "$ref": "WorkLog.schema.json#WorkLog" - }, - "incident": { - "type": "array", - "items": { - "$ref": "Incident.schema.json#Incident" - } - }, - "changeRequestSpecification": { - "$ref": "ChangeRequestSpecification.schema.json#ChangeRequestSpecification" - }, - "impactEntity": { - "type": "array", - "items": { - "$ref": "ImpactEntityRef.schema.json#ImpactEntityRef" - } - }, - "changeRequestCharacteristic": { - "type": "array", - "items": { - "$ref": "ChangeRequestCharacteristic.schema.json#ChangeRequestCharacteristic" - } - }, - "targetEntity": { - "type": "array", - "items": { - "$ref": "TargetEntityRef.schema.json#TargetEntityRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "description": "The parties involved in the change request" - }, - "resolution": { - "$ref": "Resolution.schema.json#Resolution" - }, - "sla": { - "type": "array", - "items": { - "$ref": "../EngagedParty/SLARef.schema.json#SLARef" - } - }, - "relateChangeRequest": { - "type": "array", - "items": { - "$ref": "RelatedChangeRequestRef.schema.json#RelatedChangeRequestRef" - } - }, - "category": { - "type": "array", - "items": { - "$ref": "../Product/CategoryRef.schema.json#CategoryRef" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "Note.schema.json#Note" - } - }, - "location": { - "$ref": "GeographicAddressRef.schema.json#GeographicAddressRef", - "description": "The place at which the change request occurred" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ChangeRequest.schema.json", + "title": "ChangeRequest", + "definitions": { + "ChangeRequest": { + "$id": "#ChangeRequest", + "description": "Change Request is a type of request which can be used for the management and control of Change Management \nprocess between a customer and a service provider or between a service provider and a partner and vice versa.", + "type": "object", + "properties": { + "actualEndTime": { + "type": "string", + "format": "date-time", + "description": "Date and time when the change implementation actually finished" + }, + "actualStartTime": { + "type": "string", + "format": "date-time", + "description": "Date and time when the change implementation actually started" + }, + "budget": { + "type": "string", + "description": "The budget reserved for the change" + }, + "channel": { + "type": "string", + "description": "A channel represents the way the Change Request was created" + }, + "completionDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the change request is confirmed to be completed" + }, + "currency": { + "type": "string", + "description": "The used currency related with cost" + }, + "description": { + "type": "string", + "description": "Description of the change request" + }, + "externalId": { + "type": "string", + "description": "ID given by the requestor to facilitate the relationship set up and subsequent searches" + }, + "href": { + "type": "string", + "description": "Hyperlink to access a change request" + }, + "id": { + "type": "string", + "description": "Identifier of a Change Request. It is created on repository side (a Change Management system)" + }, + "impact": { + "type": "string", + "description": "Indicates the impact of this change" + }, + "plannedEndTime": { + "type": "string", + "format": "date-time", + "description": "Date and time when the change implementation is planned to be finished" + }, + "plannedStartTime": { + "type": "string", + "format": "date-time", + "description": "Date and time when the change implementation is planned to be started" + }, + "priority": { + "type": "string", + "description": "Used by consumers to prioritize a change request in Change Management system" + }, + "requestDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the change request is raised" + }, + "requestType": { + "type": "string", + "description": "Indicates the type of the change request" + }, + "risk": { + "type": "string", + "description": "The risk to implement this change request" + }, + "riskMitigationPlan": { + "type": "string", + "description": "The risk mitigation plan" + }, + "riskValue": { + "type": "string", + "description": "The additional cost if the risk will happen" + }, + "scheduledDate": { + "type": "string", + "format": "date-time", + "description": "Date and time that the schedule is made" + }, + "status": { + "type": "string", + "description": "Status of the change request and its sub-state" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "Attachment.schema.json#Attachment" + }, + "description": "The attachments of the communication message (when it is email type)" + }, + "workLog": { + "$ref": "WorkLog.schema.json#WorkLog" + }, + "incident": { + "type": "array", + "items": { + "$ref": "Incident.schema.json#Incident" + } + }, + "changeRequestSpecification": { + "$ref": "ChangeRequestSpecification.schema.json#ChangeRequestSpecification" + }, + "impactEntity": { + "type": "array", + "items": { + "$ref": "ImpactEntityRef.schema.json#ImpactEntityRef" + } + }, + "changeRequestCharacteristic": { + "type": "array", + "items": { + "$ref": "ChangeRequestCharacteristic.schema.json#ChangeRequestCharacteristic" + } + }, + "targetEntity": { + "type": "array", + "items": { + "$ref": "TargetEntityRef.schema.json#TargetEntityRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "The parties involved in the change request" + }, + "resolution": { + "$ref": "Resolution.schema.json#Resolution" + }, + "sla": { + "type": "array", + "items": { + "$ref": "../EngagedParty/SLARef.schema.json#SLARef" + } + }, + "relateChangeRequest": { + "type": "array", + "items": { + "$ref": "RelatedChangeRequestRef.schema.json#RelatedChangeRequestRef" + } + }, + "category": { + "type": "array", + "items": { + "$ref": "../Product/CategoryRef.schema.json#CategoryRef" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "Note.schema.json#Note" + } + }, + "location": { + "$ref": "GeographicAddressRef.schema.json#GeographicAddressRef", + "description": "The place at which the change request occurred" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/ChangeRequestCharacteristic.schema.json b/Common/ChangeRequestCharacteristic.schema.json index 585fb3e7..708ab679 100644 --- a/Common/ChangeRequestCharacteristic.schema.json +++ b/Common/ChangeRequestCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ChangeRequestCharacteristic.schema.json", - "title": "ChangeRequestCharacteristic", - "definitions": { - "ChangeRequestCharacteristic": { - "$id": "#ChangeRequestCharacteristic", - "description": "Characteristics of the change request to instantiate or to modify", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic." - }, - "value": { - "type": "string", - "description": "Value of the characteristic." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ChangeRequestCharacteristic.schema.json", + "title": "ChangeRequestCharacteristic", + "definitions": { + "ChangeRequestCharacteristic": { + "$id": "#ChangeRequestCharacteristic", + "description": "Characteristics of the change request to instantiate or to modify", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic." + }, + "value": { + "type": "string", + "description": "Value of the characteristic." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/ChangeRequestRef.schema.json b/Common/ChangeRequestRef.schema.json index 3b88a49f..6d3bd1ea 100644 --- a/Common/ChangeRequestRef.schema.json +++ b/Common/ChangeRequestRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ChangeRequestRef.schema.json", - "title": "ChangeRequestRef", - "definitions": { - "ChangeRequestRef": { - "$id": "#ChangeRequestRef", - "type": "object", - "description": "Reference to a Change Request", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "href": { - "type": "string", - "description": "The reference link to the change request" - }, - "id": { - "type": "string", - "description": "The identifier of the change request" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ChangeRequestRef.schema.json", + "title": "ChangeRequestRef", + "definitions": { + "ChangeRequestRef": { + "$id": "#ChangeRequestRef", + "type": "object", + "description": "Reference to a Change Request", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "href": { + "type": "string", + "description": "The reference link to the change request" + }, + "id": { + "type": "string", + "description": "The identifier of the change request" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/ChangeRequestSpecification.schema.json b/Common/ChangeRequestSpecification.schema.json index b5295516..d20a4d5a 100644 --- a/Common/ChangeRequestSpecification.schema.json +++ b/Common/ChangeRequestSpecification.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ChangeRequestSpecification.schema.json", - "title": "ChangeRequestSpecification", - "definitions": { - "ChangeRequestSpecification": { - "$id": "#ChangeRequestSpecification", - "description": "Defines a set of attributes related to Change Request.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the specification" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the specification." - }, - "id": { - "type": "string", - "description": "Identifier of the specification." - }, - "name": { - "type": "string", - "description": "Name of the specification." - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ChangeRequestSpecification.schema.json", + "title": "ChangeRequestSpecification", + "definitions": { + "ChangeRequestSpecification": { + "$id": "#ChangeRequestSpecification", + "description": "Defines a set of attributes related to Change Request.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the specification" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the specification." + }, + "id": { + "type": "string", + "description": "Identifier of the specification." + }, + "name": { + "type": "string", + "description": "Name of the specification." + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Channel.schema.json b/Common/Channel.schema.json index 5a1d7f0d..4a87ebd0 100755 --- a/Common/Channel.schema.json +++ b/Common/Channel.schema.json @@ -1,32 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Channel.schema.json", - "title": "Channel", - "definitions": { - "Channel": { - "$id": "#Channel", - "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the channel" - }, - "id": { - "type": "string", - "description": "Unique identifier of the channel" - }, - "name": { - "type": "string", - "description": "Name of the channel" - } - - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Channel.schema.json", + "title": "Channel", + "definitions": { + "Channel": { + "$id": "#Channel", + "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the channel" + }, + "id": { + "type": "string", + "description": "Unique identifier of the channel" + }, + "name": { + "type": "string", + "description": "Name of the channel" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/ChannelRef.schema.json b/Common/ChannelRef.schema.json index 7846ee9d..73ab4876 100644 --- a/Common/ChannelRef.schema.json +++ b/Common/ChannelRef.schema.json @@ -1,22 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ChannelRef.schema.json", - "title": "ChannelRef", - "definitions": { - "ChannelRef": { - "type": "object", - "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..", - "properties": { - "name": { - "type": "string", - "description": "Name of the channel." - } - }, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ChannelRef.schema.json", + "title": "ChannelRef", + "definitions": { + "ChannelRef": { + "$id": "#ChannelRef", + "type": "object", + "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..", + "properties": { + "name": { + "type": "string", + "description": "Name of the channel." } + }, + "allOf": [ + { + "$ref": "EntityRef.schema.json#EntityRef" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Characteristic.schema.json b/Common/Characteristic.schema.json index 5fbf2ca9..a92a19f7 100644 --- a/Common/Characteristic.schema.json +++ b/Common/Characteristic.schema.json @@ -1,32 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Characteristic.schema.json", - "title": "Characteristic", - "definitions": { - "Characteristic": { - "$id": "#Characteristic", - "description": "Describes a given characteristic of an object or entity through a name/value pair.", - "type": "object", - "required" : ["name","value"], - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "valueType": { - "type": "string", - "description": "Data type of the value of the characteristic" - }, - "value": { - "$ref": "Any.schema.json#/definitions/Any", - "description": "The value of the characteristic" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Characteristic.schema.json", + "title": "Characteristic", + "definitions": { + "Characteristic": { + "$id": "#Characteristic", + "description": "Describes a given characteristic of an object or entity through a name/value pair.", + "type": "object", + "required": [ + "name", + "value" + ], + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "valueType": { + "type": "string", + "description": "Data type of the value of the characteristic" + }, + "value": { + "$ref": "Any.schema.json#Any", + "description": "The value of the characteristic" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/CommonComponents.schema.json b/Common/CommonComponents.schema.json index b90019ef..27925062 100644 --- a/Common/CommonComponents.schema.json +++ b/Common/CommonComponents.schema.json @@ -1,44 +1,44 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CommonComponents.json", - "title": "CommonComponents", - "description": "Highly reusable schema fragments for use in TMForum Open-APIs", - "definitions": { - "polymorphicPattern": { - "$id": "#polymorphicPattern", - "type": "object", - "properties": { - "@schemaLocation": { - "type": "string", - "format": "uri", - "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", - "examples": [ - "http://host/schemas/Subclass.schema.json" - ] - }, - "@baseType": { - "type": "string", - "description": "When sub-classing, this defines the super-class", - "examples": [ - "Place", - "ServiceSpecification" - ] - }, - "@type": { - "type": "string", - "description": "When sub-classing, this defines the sub-class entity name", - "examples": [ - "VendorProductOffering", - "DroneServiceSpecification" - ] - } - }, - "dependencies": { - "@schemaLocation": [ - "@baseType", - "@type" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CommonComponents.json", + "title": "CommonComponents", + "description": "Highly reusable schema fragments for use in TMForum Open-APIs", + "definitions": { + "polymorphicPattern": { + "$id": "#polymorphicPattern", + "type": "object", + "properties": { + "@schemaLocation": { + "type": "string", + "format": "uri", + "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", + "examples": [ + "http://host/schemas/Subclass.schema.json" + ] + }, + "@baseType": { + "type": "string", + "description": "When sub-classing, this defines the super-class", + "examples": [ + "Place", + "ServiceSpecification" + ] + }, + "@type": { + "type": "string", + "description": "When sub-classing, this defines the sub-class entity name", + "examples": [ + "VendorProductOffering", + "DroneServiceSpecification" + ] } + }, + "dependencies": { + "@schemaLocation": [ + "@baseType", + "@type" + ] + } } -} + } +} \ No newline at end of file diff --git a/Common/CommunicationMessage.schema.json b/Common/CommunicationMessage.schema.json index 318948f6..53356dbc 100644 --- a/Common/CommunicationMessage.schema.json +++ b/Common/CommunicationMessage.schema.json @@ -1,97 +1,97 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CommunicationMessage.schema.json", - "title": "CommunicationMessage", - "definitions": { - "CommunicationMessage": { - "$id": "#CommunicationMessage", - "description": "Communication message means a notification approach in the format of a message which can be dispatched (sent) to the certain user by the system with the content which can be felt and understood by the recipient. The user can be either a final customer or a customer service agent. The message can reach the customer in different interaction channels, including: email, short message, mobile app notification (push).", - "type": "object", - "properties": { - "callbackFlag": { - "type": "boolean", - "description": "Do you want a callback on delivery of communication message?" - }, - "content": { - "type": "string", - "description": "The content of the communication message" - }, - "description": { - "type": "string", - "description": "Description for the whole object" - }, - "href": { - "type": "string", - "description": "Hypertext Reference of the Communication Message" - }, - "id": { - "type": "string", - "description": "Unique identifier of Communication Message" - }, - "logFlag": { - "type": "boolean" - }, - "priority": { - "type": "string", - "description": "The priority of the communication message.\nSmall number means higher priority." - }, - "sendTime": { - "type": "string", - "format": "date-time", - "description": "The time of sending communication message" - }, - "sendTimeComplete": { - "type": "string", - "format": "date-time", - "description": "The time of completion of sending communication message" - }, - "status": { - "type": "string", - "description": "Status of communication message" - }, - "subject": { - "type": "string", - "description": "The title of the message, necessary for the email and mobile app push" - }, - "tryTimes": { - "type": "integer", - "description": "How many times do you want to retry the delivery of this message?" - }, - "messageType": { - "type": "string", - "description": "The type of message, such as: SMS, Email, Mobile app push notification" - }, - "attachment": { - "type": "array", - "description": "Any attachment associated with this message", - "items": { - "$ref": "Attachment.schema.json#Attachment" - } - }, - "receiver": { - "type": "array", - "description": "The receiver(s) of this message", - "items": { - "$ref": "Receiver.schema.json#Receiver" - } - }, - "sender": { - "$ref": "Sender.schema.json#Sender", - "description": "The sender of this message" - }, - "characteristic": { - "type": "array", - "description": "Any additional characteristic(s) of this message", - "items": { - "$ref": "CommunicationRequestCharacteristic.schema.json#CommunicationRequestCharacteristic" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CommunicationMessage.schema.json", + "title": "CommunicationMessage", + "definitions": { + "CommunicationMessage": { + "$id": "#CommunicationMessage", + "description": "Communication message means a notification approach in the format of a message which can be dispatched (sent) to the certain user by the system with the content which can be felt and understood by the recipient. The user can be either a final customer or a customer service agent. The message can reach the customer in different interaction channels, including: email, short message, mobile app notification (push).", + "type": "object", + "properties": { + "callbackFlag": { + "type": "boolean", + "description": "Do you want a callback on delivery of communication message?" + }, + "content": { + "type": "string", + "description": "The content of the communication message" + }, + "description": { + "type": "string", + "description": "Description for the whole object" + }, + "href": { + "type": "string", + "description": "Hypertext Reference of the Communication Message" + }, + "id": { + "type": "string", + "description": "Unique identifier of Communication Message" + }, + "logFlag": { + "type": "boolean" + }, + "priority": { + "type": "string", + "description": "The priority of the communication message.\nSmall number means higher priority." + }, + "sendTime": { + "type": "string", + "format": "date-time", + "description": "The time of sending communication message" + }, + "sendTimeComplete": { + "type": "string", + "format": "date-time", + "description": "The time of completion of sending communication message" + }, + "status": { + "type": "string", + "description": "Status of communication message" + }, + "subject": { + "type": "string", + "description": "The title of the message, necessary for the email and mobile app push" + }, + "tryTimes": { + "type": "integer", + "description": "How many times do you want to retry the delivery of this message?" + }, + "messageType": { + "type": "string", + "description": "The type of message, such as: SMS, Email, Mobile app push notification" + }, + "attachment": { + "type": "array", + "description": "Any attachment associated with this message", + "items": { + "$ref": "Attachment.schema.json#Attachment" + } + }, + "receiver": { + "type": "array", + "description": "The receiver(s) of this message", + "items": { + "$ref": "Receiver.schema.json#Receiver" + } + }, + "sender": { + "$ref": "Sender.schema.json#Sender", + "description": "The sender of this message" + }, + "characteristic": { + "type": "array", + "description": "Any additional characteristic(s) of this message", + "items": { + "$ref": "CommunicationRequestCharacteristic.schema.json#CommunicationRequestCharacteristic" + } } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/CommunicationRequestCharacteristic.schema.json b/Common/CommunicationRequestCharacteristic.schema.json index fa67589d..5cb0633d 100644 --- a/Common/CommunicationRequestCharacteristic.schema.json +++ b/Common/CommunicationRequestCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CommunicationRequestCharacteristic.schema.json", - "title": "CommunicationRequestCharacteristic", - "definitions": { - "CommunicationRequestCharacteristic": { - "$id": "#CommunicationRequestCharacteristic", - "description": "The values of parameters which are used in the content if the content contains them.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Content parameter identifier" - }, - "value": { - "type": "string", - "description": "Content parameter value" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CommunicationRequestCharacteristic.schema.json", + "title": "CommunicationRequestCharacteristic", + "definitions": { + "CommunicationRequestCharacteristic": { + "$id": "#CommunicationRequestCharacteristic", + "description": "The values of parameters which are used in the content if the content contains them.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Content parameter identifier" + }, + "value": { + "type": "string", + "description": "Content parameter value" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/ConstraintRef.schema.json b/Common/ConstraintRef.schema.json index b1c2a8c0..2a2be543 100644 --- a/Common/ConstraintRef.schema.json +++ b/Common/ConstraintRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ConstraintRef.schema.json", - "title": "ConstraintRef", - "definitions": { - "ConstraintRef": { - "$id": "#ConstraintRef", - "type": "object", - "description": "Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.", - "properties": { - "@referredType": { - "type": "string", - "description": "The (class) type of the referred constraint" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to the target constraint" - }, - "id": { - "type": "string", - "description": "reference id to the target constraint" - }, - "name": { - "type": "string", - "description": "Name given to the constraint" - }, - "version": { - "type": "string", - "description": "constraint version" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ConstraintRef.schema.json", + "title": "ConstraintRef", + "definitions": { + "ConstraintRef": { + "$id": "#ConstraintRef", + "type": "object", + "description": "Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.", + "properties": { + "@referredType": { + "type": "string", + "description": "The (class) type of the referred constraint" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to the target constraint" + }, + "id": { + "type": "string", + "description": "reference id to the target constraint" + }, + "name": { + "type": "string", + "description": "Name given to the constraint" + }, + "version": { + "type": "string", + "description": "constraint version" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Common/ContactMedium.schema.json b/Common/ContactMedium.schema.json index d97fe581..ff799c11 100644 --- a/Common/ContactMedium.schema.json +++ b/Common/ContactMedium.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ContactMedium.schema.json", - "title": "ContactMedium", - "definitions": { - "ContactMedium": { - "$id": "#ContactMedium", - "description": "Indicates the contact medium that could be used to contact the party.", - "type": "object", - "properties": { - "preferred": { - "type": "boolean", - "description": "If true, indicates that is the preferred contact medium" - }, - "mediumType": { - "type": "string", - "description": "Type of the contact medium, such as: email address, telephone number, postal address" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The time period that the contact medium is valid for" - }, - "characteristic": { - "$ref": "MediumCharacteristic.schema.json#MediumCharacteristic", - "description": "Any additional characteristic(s) of this contact medium" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ContactMedium.schema.json", + "title": "ContactMedium", + "definitions": { + "ContactMedium": { + "$id": "#ContactMedium", + "description": "Indicates the contact medium that could be used to contact the party.", + "type": "object", + "properties": { + "preferred": { + "type": "boolean", + "description": "If true, indicates that is the preferred contact medium" + }, + "mediumType": { + "type": "string", + "description": "Type of the contact medium, such as: email address, telephone number, postal address" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The time period that the contact medium is valid for" + }, + "characteristic": { + "$ref": "MediumCharacteristic.schema.json#MediumCharacteristic", + "description": "Any additional characteristic(s) of this contact medium" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Document.schema.json b/Common/Document.schema.json index b19375b0..47fdacdd 100644 --- a/Common/Document.schema.json +++ b/Common/Document.schema.json @@ -1,97 +1,97 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Document.schema.json", - "title": "Document", - "definitions": { - "Document": { - "$id": "#Document", - "description": "Document is a tangible output from an activity", - "type": "object", - "properties": { - "creationDate": { - "type": "string", - "format": "date-time", - "description": "The date and time the document was created. A date and time formatted in compliance with the ISO8601 standard must be used." - }, - "description": { - "type": "string", - "description": "Free-text description of the document" - }, - "href": { - "type": "string", - "format": "uri", - "description": "The URI for the object itself" - }, - "id": { - "type": "string", - "description": "Identifier of an instance of the document. Required to be unique within the document type. Used in URIs as the identifier for specific instances of a type." - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "The date and time the document was last modified. A date and time formatted in compliance with the ISO8601 standard must be used." - }, - "lifecycleState": { - "type": "string", - "description": "The life cycle state of the document" - }, - "name": { - "type": "string", - "description": "A string used to give a name to the document" - }, - "documentType": { - "type": "string", - "description": "The specific type of this document" - }, - "version": { - "type": "string", - "description": "A particular form or variety of an artefact that is different from others or from the original. The form represents differences in properties that characterize an artefact, that are not enough to warrant creating a new artefact" - }, - "characteristic": { - "type": "array", - "description": "Any additional characteristic(s) specific to this Document", - "items": { - "$ref": "DocumentCharacteristic.schema.json#DocumentCharacteristic" - } - }, - "relatedParty": { - "type": "array", - "description": "Any Parties related to this Document (eg: author)", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "documentSpecification": { - "description": "The specification or this Document", - "$ref": "DocumentSpecification.schema.json#DocumentSpecification" - }, - "binaryAttachment": { - "type": "array", - "items": { - "$ref": "DocumentAttachment.schema.json#DocumentAttachment" - } - }, - "category": { - "type": "array", - "items": { - "$ref": "../Product/CategoryRef.schema.json#CategoryRef" - } - }, - "documentRelationship": { - "type": "array", - "items": { - "$ref": "DocumentRelationship.schema.json#DocumentRelationship" - } - }, - "relatedObject": { - "$ref": "RelatedObject.schema.json#RelatedObject" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Document.schema.json", + "title": "Document", + "definitions": { + "Document": { + "$id": "#Document", + "description": "Document is a tangible output from an activity", + "type": "object", + "properties": { + "creationDate": { + "type": "string", + "format": "date-time", + "description": "The date and time the document was created. A date and time formatted in compliance with the ISO8601 standard must be used." + }, + "description": { + "type": "string", + "description": "Free-text description of the document" + }, + "href": { + "type": "string", + "format": "uri", + "description": "The URI for the object itself" + }, + "id": { + "type": "string", + "description": "Identifier of an instance of the document. Required to be unique within the document type. Used in URIs as the identifier for specific instances of a type." + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "The date and time the document was last modified. A date and time formatted in compliance with the ISO8601 standard must be used." + }, + "lifecycleState": { + "type": "string", + "description": "The life cycle state of the document" + }, + "name": { + "type": "string", + "description": "A string used to give a name to the document" + }, + "documentType": { + "type": "string", + "description": "The specific type of this document" + }, + "version": { + "type": "string", + "description": "A particular form or variety of an artefact that is different from others or from the original. The form represents differences in properties that characterize an artefact, that are not enough to warrant creating a new artefact" + }, + "characteristic": { + "type": "array", + "description": "Any additional characteristic(s) specific to this Document", + "items": { + "$ref": "DocumentCharacteristic.schema.json#DocumentCharacteristic" + } + }, + "relatedParty": { + "type": "array", + "description": "Any Parties related to this Document (eg: author)", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "documentSpecification": { + "description": "The specification or this Document", + "$ref": "DocumentSpecification.schema.json#DocumentSpecification" + }, + "binaryAttachment": { + "type": "array", + "items": { + "$ref": "DocumentAttachment.schema.json#DocumentAttachment" + } + }, + "category": { + "type": "array", + "items": { + "$ref": "../Product/CategoryRef.schema.json#CategoryRef" + } + }, + "documentRelationship": { + "type": "array", + "items": { + "$ref": "DocumentRelationship.schema.json#DocumentRelationship" + } + }, + "relatedObject": { + "$ref": "RelatedObject.schema.json#RelatedObject" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/DocumentAttachment.schema.json b/Common/DocumentAttachment.schema.json index 0446d62a..2a799b39 100644 --- a/Common/DocumentAttachment.schema.json +++ b/Common/DocumentAttachment.schema.json @@ -1,56 +1,56 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DocumentAttachment.schema.json", - "title": "DocumentAttachment", - "definitions": { - "DocumentAttachment": { - "$id": "#DocumentAttachment", - "description": "Attachment refers to extensions or additional parts that is or may be attached to something (agreements, contracts, appointments) to perform a particular function. They can be communication attachments, documents and other.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description of the binary attachment" - }, - "id": { - "type": "string", - "description": "Identifier of the binary attachment" - }, - "mimeType": { - "type": "string", - "description": "mimeType of the Attachment, such as: application/pdf" - }, - "name": { - "type": "string", - "description": "Name of the binary attachment" - }, - "size": { - "type": "integer", - "description": "The size of the document or attachment. If this component contains the embedded data then the size is the size of the embedded data; if it is a reference without the data then it is the size of the referenced document" - }, - "sizeUnit": { - "type": "string", - "description": "The unit of measure for the size" - }, - "attachmentType": { - "type": "string", - "description": "Identifies the sub-type of the instance of binary attachment" - }, - "URL": { - "type": "string", - "format": "uri", - "description": "URL of the Attachment" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "Validity period of the Attachment" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DocumentAttachment.schema.json", + "title": "DocumentAttachment", + "definitions": { + "DocumentAttachment": { + "$id": "#DocumentAttachment", + "description": "Attachment refers to extensions or additional parts that is or may be attached to something (agreements, contracts, appointments) to perform a particular function. They can be communication attachments, documents and other.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of the binary attachment" + }, + "id": { + "type": "string", + "description": "Identifier of the binary attachment" + }, + "mimeType": { + "type": "string", + "description": "mimeType of the Attachment, such as: application/pdf" + }, + "name": { + "type": "string", + "description": "Name of the binary attachment" + }, + "size": { + "type": "integer", + "description": "The size of the document or attachment. If this component contains the embedded data then the size is the size of the embedded data; if it is a reference without the data then it is the size of the referenced document" + }, + "sizeUnit": { + "type": "string", + "description": "The unit of measure for the size" + }, + "attachmentType": { + "type": "string", + "description": "Identifies the sub-type of the instance of binary attachment" + }, + "URL": { + "type": "string", + "format": "uri", + "description": "URL of the Attachment" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "Validity period of the Attachment" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/DocumentCharacteristic.schema.json b/Common/DocumentCharacteristic.schema.json index da2ac610..c962d3f1 100644 --- a/Common/DocumentCharacteristic.schema.json +++ b/Common/DocumentCharacteristic.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DocumentCharacteristic.schema.json", - "title": "DocumentCharacteristic", - "definitions": { - "DocumentCharacteristic": { - "$id": "#DocumentCharacteristic", - "description": "is a list of name value pairs that define the document characteristics.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "name of the characteristic" - }, - "value": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DocumentCharacteristic.schema.json", + "title": "DocumentCharacteristic", + "definitions": { + "DocumentCharacteristic": { + "$id": "#DocumentCharacteristic", + "description": "is a list of name value pairs that define the document characteristics.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "name of the characteristic" + }, + "value": { + "type": "string" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/DocumentRef.schema.json b/Common/DocumentRef.schema.json index 49040d2a..5c885a70 100644 --- a/Common/DocumentRef.schema.json +++ b/Common/DocumentRef.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DocumentRef.schema.json", - "title": "DocumentRef", - "definitions": { - "DocumentRef": { - "$id": "#DocumentRef", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URI for the object itself." - }, - "id": { - "type": "string", - "description": "Identifier of the document" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DocumentRef.schema.json", + "title": "DocumentRef", + "definitions": { + "DocumentRef": { + "$id": "#DocumentRef", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URI for the object itself." + }, + "id": { + "type": "string", + "description": "Identifier of the document" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/DocumentSpecification.schema.json b/Common/DocumentSpecification.schema.json index c6aceb6b..fd1df4c4 100644 --- a/Common/DocumentSpecification.schema.json +++ b/Common/DocumentSpecification.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DocumentSpecification.schema.json", - "title": "DocumentSpecification", - "definitions": { - "DocumentSpecification": { - "$id": "#DocumentSpecification", - "description": "A document specification reference", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URI for the object itself." - }, - "id": { - "type": "string", - "description": "Identifier of the DocumentSpecification" - }, - "name": { - "type": "string", - "description": "a String. Name of the DocumentSpecification" - }, - "URL": { - "type": "string", - "format": "uri", - "description": "URL of the Document Specification" - }, - "version": { - "type": "string", - "description": "A string, a version of the DocumentSpecification." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DocumentSpecification.schema.json", + "title": "DocumentSpecification", + "definitions": { + "DocumentSpecification": { + "$id": "#DocumentSpecification", + "description": "A document specification reference", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URI for the object itself." + }, + "id": { + "type": "string", + "description": "Identifier of the DocumentSpecification" + }, + "name": { + "type": "string", + "description": "a String. Name of the DocumentSpecification" + }, + "URL": { + "type": "string", + "format": "uri", + "description": "URL of the Document Specification" + }, + "version": { + "type": "string", + "description": "A string, a version of the DocumentSpecification." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Duration.schema.json b/Common/Duration.schema.json index 4523aeac..13823d25 100644 --- a/Common/Duration.schema.json +++ b/Common/Duration.schema.json @@ -1,23 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Duration.schema.json", - "title": "Duration", - "definitions": { - "Duration": { - "$id": "#Duration", - "type": "object", - "description": "A time interval in a given unit of time", - "properties": { - "amount": { - "type": "integer", - "description": "Time interval (number of seconds, minutes, hours, etc.)" - }, - "units": { - "type": "string", - "description": "Unit of time (seconds, minutes, hours, etc.)" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Duration.schema.json", + "title": "Duration", + "definitions": { + "Duration": { + "$id": "#Duration", + "type": "object", + "description": "A time interval in a given unit of time", + "properties": { + "amount": { + "type": "integer", + "description": "Time interval (number of seconds, minutes, hours, etc.)" + }, + "units": { + "type": "string", + "description": "Unit of time (seconds, minutes, hours, etc.)" } + } } -} - + } +} \ No newline at end of file diff --git a/Common/Entity.schema.json b/Common/Entity.schema.json index b123a465..1a03c6cd 100644 --- a/Common/Entity.schema.json +++ b/Common/Entity.schema.json @@ -1,45 +1,45 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Entity.schema.json", - "title": "Entity", - "definitions": { - "Entity": { - "$id": "#Entity", - "type": "object", - "description": "Base entity schema for use in TMForum Open-APIs", - "discriminator":"@type", - "properties": { - "@schemaLocation": { - "type": "string", - "format": "uri", - "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", - "examples": [ - "http://host/schemas/Subclass.schema.json" - ] - }, - "@baseType": { - "type": "string", - "description": "When sub-classing, this defines the super-class", - "examples": [ - "Place", - "ServiceSpecification" - ] - }, - "@type": { - "type": "string", - "description": "When sub-classing, this defines the sub-class entity name", - "examples": [ - "VendorProductOffering", - "DroneServiceSpecification" - ] - } - }, - "dependencies": { - "@schemaLocation": [ - "@baseType", - "@type" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Entity.schema.json", + "title": "Entity", + "definitions": { + "Entity": { + "$id": "#Entity", + "type": "object", + "description": "Base entity schema for use in TMForum Open-APIs", + "discriminator": "@type", + "properties": { + "@schemaLocation": { + "type": "string", + "format": "uri", + "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", + "examples": [ + "http://host/schemas/Subclass.schema.json" + ] + }, + "@baseType": { + "type": "string", + "description": "When sub-classing, this defines the super-class", + "examples": [ + "Place", + "ServiceSpecification" + ] + }, + "@type": { + "type": "string", + "description": "When sub-classing, this defines the sub-class entity name", + "examples": [ + "VendorProductOffering", + "DroneServiceSpecification" + ] } + }, + "dependencies": { + "@schemaLocation": [ + "@baseType", + "@type" + ] + } } -} + } +} \ No newline at end of file diff --git a/Common/EntityAttachment.schema.json b/Common/EntityAttachment.schema.json index d367028f..17787e6a 100644 --- a/Common/EntityAttachment.schema.json +++ b/Common/EntityAttachment.schema.json @@ -1,48 +1,48 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntityAttachment.schema.json", - "title": "EntityAttachment", - "definitions": { - "EntityAttachment": { - "$id": "#EntityAttachment", - "description": "Complements the description of an entity through video, pictures...", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative text describing the content of the attachment" - }, - "href": { - "type": "string", - "description": "Reference of the attachment" - }, - "id": { - "type": "string", - "description": "Unique identifier of the attachment" - }, - "mimeType": { - "type": "string", - "description": "Attachment mime type such as extension file for video, picture and document" - }, - "name": { - "type": "string", - "description": "name given to the attachment" - }, - "uri": { - "type": "string", - "format": "uri", - "description": "Uniform Resource Identifier (URI) of the attachment" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which this attachment is valid" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntityAttachment.schema.json", + "title": "EntityAttachment", + "definitions": { + "EntityAttachment": { + "$id": "#EntityAttachment", + "description": "Complements the description of an entity through video, pictures...", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative text describing the content of the attachment" + }, + "href": { + "type": "string", + "description": "Reference of the attachment" + }, + "id": { + "type": "string", + "description": "Unique identifier of the attachment" + }, + "mimeType": { + "type": "string", + "description": "Attachment mime type such as extension file for video, picture and document" + }, + "name": { + "type": "string", + "description": "name given to the attachment" + }, + "uri": { + "type": "string", + "format": "uri", + "description": "Uniform Resource Identifier (URI) of the attachment" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which this attachment is valid" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/EntityCatalogItem.schema.json b/Common/EntityCatalogItem.schema.json index e755251e..e7e3b9a4 100644 --- a/Common/EntityCatalogItem.schema.json +++ b/Common/EntityCatalogItem.schema.json @@ -1,52 +1,52 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntityCatalogItem.schema.json", - "title": "EntityCatalogItem", - "definitions": { - "EntityCatalogItem": { - "$id": "#EntityCatalogItem", - "description": "An EntityCatalogItem is an entity that allows any ProductOffering, ServiceCandidate, ResourceCandidate, or even any object inheriting from RootEntity, to be available to a catalog. The CatalogSpecification and Policy of the catalog governs the content of the EntityCatalogItem. This API addresses only EntitySpecification items extended from RootEntity as EntityCatalogItem.\nThe EntityCatalogItem resource (JSON format) represents a set of characteristics that define the values given by the EntityCatalogItem.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of this REST resource" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to this REST resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of this REST resource" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update of this REST resource" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status of this catalog item" - }, - "name": { - "type": "string", - "description": "Name given to this REST resource" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which this REST resource is valid" - }, - "version": { - "type": "string", - "description": "EntityCatalogItem version" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntityCatalogItem.schema.json", + "title": "EntityCatalogItem", + "definitions": { + "EntityCatalogItem": { + "$id": "#EntityCatalogItem", + "description": "An EntityCatalogItem is an entity that allows any ProductOffering, ServiceCandidate, ResourceCandidate, or even any object inheriting from RootEntity, to be available to a catalog. The CatalogSpecification and Policy of the catalog governs the content of the EntityCatalogItem. This API addresses only EntitySpecification items extended from RootEntity as EntityCatalogItem.\nThe EntityCatalogItem resource (JSON format) represents a set of characteristics that define the values given by the EntityCatalogItem.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of this REST resource" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to this REST resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of this REST resource" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update of this REST resource" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status of this catalog item" + }, + "name": { + "type": "string", + "description": "Name given to this REST resource" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which this REST resource is valid" + }, + "version": { + "type": "string", + "description": "EntityCatalogItem version" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/EntityCatalogItemRef.schema.json b/Common/EntityCatalogItemRef.schema.json index 34a0ef62..e74688b7 100644 --- a/Common/EntityCatalogItemRef.schema.json +++ b/Common/EntityCatalogItemRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntityCatalogItemRef.schema.json", - "title": "EntityCatalogItemRef", - "definitions": { - "EntityCatalogItemRef": { - "$id": "#EntityCatalogItemRef", - "description": "reference to EntityCatalogItem object", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink reference to the target EntityCatalogItem" - }, - "id": { - "type": "string", - "description": "reference id to the target EntityCatalogItem" - }, - "name": { - "type": "string", - "description": "Name given to the EntityCatalogItem" - }, - "version": { - "type": "string", - "description": "EntityCatalogItem version" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntityCatalogItemRef.schema.json", + "title": "EntityCatalogItemRef", + "definitions": { + "EntityCatalogItemRef": { + "$id": "#EntityCatalogItemRef", + "description": "reference to EntityCatalogItem object", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink reference to the target EntityCatalogItem" + }, + "id": { + "type": "string", + "description": "reference id to the target EntityCatalogItem" + }, + "name": { + "type": "string", + "description": "Name given to the EntityCatalogItem" + }, + "version": { + "type": "string", + "description": "EntityCatalogItem version" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/EntityRef.schema.json b/Common/EntityRef.schema.json index 2e72a7f0..c0bd9213 100644 --- a/Common/EntityRef.schema.json +++ b/Common/EntityRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntityRef.schema.json", - "title": "EntityRef", - "definitions": { - "EntityRef": { - "$id": "#EntityRef", - "description": "Entity reference schema to be use for all entityRef class.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of a related entity." - }, - "href": { - "type": "string", - "description": "Reference of the related entity." - }, - "name": { - "type": "string", - "description": "Name of the related entity." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntityRef.schema.json", + "title": "EntityRef", + "definitions": { + "EntityRef": { + "$id": "#EntityRef", + "description": "Entity reference schema to be use for all entityRef class.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of a related entity." + }, + "href": { + "type": "string", + "description": "Reference of the related entity." + }, + "name": { + "type": "string", + "description": "Name of the related entity." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Common/EntitySchemaRef.schema.json b/Common/EntitySchemaRef.schema.json index 8946b51d..dc2a9c38 100644 --- a/Common/EntitySchemaRef.schema.json +++ b/Common/EntitySchemaRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntitySchemaRef.schema.json", - "title": "EntitySchemaRef", - "definitions": { - "EntitySchemaRef": { - "$id": "#EntitySchemaRef", - "description": "The reference object to the schema and type of target entity which is described by an entity specification", - "type": "object", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntitySchemaRef.schema.json", + "title": "EntitySchemaRef", + "definitions": { + "EntitySchemaRef": { + "$id": "#EntitySchemaRef", + "description": "The reference object to the schema and type of target entity which is described by an entity specification", + "type": "object", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/EntitySpecRelationship.schema.json b/Common/EntitySpecRelationship.schema.json index 919be2d8..97e5836a 100644 --- a/Common/EntitySpecRelationship.schema.json +++ b/Common/EntitySpecRelationship.schema.json @@ -1,46 +1,46 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntitySpecRelationship.schema.json", - "title": "EntitySpecRelationship", - "definitions": { - "EntitySpecRelationship": { - "$id": "#EntitySpecRelationship", - "description": "A migration, substitution, dependency or exclusivity relationship between/among entity specifications.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the target EntitySpecification" - }, - "id": { - "type": "string", - "description": "Unique identifier of target EntitySpecification" - }, - "name": { - "type": "string", - "description": "The name given to the target entity specification instance" - }, - "role": { - "type": "string", - "description": "The association role for this entity specification" - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship such as migration, substitution, dependency, exclusivity" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which the entitySpecRelationship is valid" - }, - "associationSpec": { - "$ref": "AssociationSpecRef.schema.json#AssociationSpecRef" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntitySpecRelationship.schema.json", + "title": "EntitySpecRelationship", + "definitions": { + "EntitySpecRelationship": { + "$id": "#EntitySpecRelationship", + "description": "A migration, substitution, dependency or exclusivity relationship between/among entity specifications.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the target EntitySpecification" + }, + "id": { + "type": "string", + "description": "Unique identifier of target EntitySpecification" + }, + "name": { + "type": "string", + "description": "The name given to the target entity specification instance" + }, + "role": { + "type": "string", + "description": "The association role for this entity specification" + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship such as migration, substitution, dependency, exclusivity" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which the entitySpecRelationship is valid" + }, + "associationSpec": { + "$ref": "AssociationSpecRef.schema.json#AssociationSpecRef" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/EntitySpecification.schema.json b/Common/EntitySpecification.schema.json index 9b73c2e8..4fd054af 100644 --- a/Common/EntitySpecification.schema.json +++ b/Common/EntitySpecification.schema.json @@ -1,73 +1,73 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntitySpecification.schema.json", - "title": "EntitySpecification", - "definitions": { - "EntitySpecification": { - "$id": "#EntitySpecification", - "description": "EntitySpecification is a class that offers characteristics to describe a type of entity. Entities are generic constructs that may be used to describe bespoke business entities that are not effectively covered by the existing SID model.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of this REST resource" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to this REST resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of this REST resource" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update of this REST resource" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status of this catalog item" - }, - "name": { - "type": "string", - "description": "Name given to this REST resource" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which this REST resource is valid" - }, - "version": { - "type": "string", - "description": "Entity specification version" - }, - "attachment": { - "type": "array", - "items": { - "$ref": "EntityAttachment.schema.json#EntityAttachment" - } - }, - "entitySchema": { - "$ref": "EntitySchemaRef.schema.json#EntitySchemaRef" - }, - "specCharacteristic": { - "type": "array", - "items": { - "$ref": "SpecCharacteristic.schema.json#SpecCharacteristic" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntitySpecification.schema.json", + "title": "EntitySpecification", + "definitions": { + "EntitySpecification": { + "$id": "#EntitySpecification", + "description": "EntitySpecification is a class that offers characteristics to describe a type of entity. Entities are generic constructs that may be used to describe bespoke business entities that are not effectively covered by the existing SID model.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of this REST resource" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to this REST resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of this REST resource" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update of this REST resource" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status of this catalog item" + }, + "name": { + "type": "string", + "description": "Name given to this REST resource" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which this REST resource is valid" + }, + "version": { + "type": "string", + "description": "Entity specification version" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "EntityAttachment.schema.json#EntityAttachment" + } + }, + "entitySchema": { + "$ref": "EntitySchemaRef.schema.json#EntitySchemaRef" + }, + "specCharacteristic": { + "type": "array", + "items": { + "$ref": "SpecCharacteristic.schema.json#SpecCharacteristic" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/EntitySpecificationRef.schema.json b/Common/EntitySpecificationRef.schema.json index 5eff1c93..580c884a 100644 --- a/Common/EntitySpecificationRef.schema.json +++ b/Common/EntitySpecificationRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntitySpecificationRef.schema.json", - "title": "EntitySpecificationRef", - "definitions": { - "EntitySpecificationRef": { - "$id": "#EntitySpecificationRef", - "description": "reference to an EntitySpecification object", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink reference to the target EntitySpecification" - }, - "id": { - "type": "string", - "description": "reference id to the target EntitySpecification" - }, - "name": { - "type": "string", - "description": "Name given to the EntitySpecification" - }, - "version": { - "type": "string", - "description": "EntitySpecification version" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntitySpecificationRef.schema.json", + "title": "EntitySpecificationRef", + "definitions": { + "EntitySpecificationRef": { + "$id": "#EntitySpecificationRef", + "description": "reference to an EntitySpecification object", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink reference to the target EntitySpecification" + }, + "id": { + "type": "string", + "description": "reference id to the target EntitySpecification" + }, + "name": { + "type": "string", + "description": "Name given to the EntitySpecification" + }, + "version": { + "type": "string", + "description": "EntitySpecification version" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Error.schema.json b/Common/Error.schema.json index 69a2c7d3..746c78ea 100644 --- a/Common/Error.schema.json +++ b/Common/Error.schema.json @@ -1,64 +1,64 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Error.schema.json", - "title": "Error", - "definitions": { - "Error": { - "$id": "#Error", - "description": "Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)", - "type": "object", - "required": [ - "code", - "reason" - ], - "properties": { - "code": { - "type": "integer", - "description": "Application relevant detail, defined in the API or a common list", - "examples": [ - "1", - "2" - ] - }, - "reason": { - "type": "string", - "description": "Explanation of the reason for the error which can be shown to a client user", - "examples": [ - "This customer does not exist", - "The service is not available at this location" - ] - }, - "message": { - "type": "string", - "description": "More details and corrective actions related to the error which can be shown to a client user", - "examples": [ - "Please use a valid password", - "Please enter a smaller quantity" - ] - }, - "status": { - "type": "string", - "description": "HTTP Error code extension", - "examples": [ - "400-2", - "500-4" - ] - }, - "referenceError": { - "type": "string", - "format": "uri", - "description": "URI of documentation describing the error", - "examples": [ - "https://docs.microsoft.com/en-us/windows/desktop/wmdm/error-codes", - "https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html" - ] - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Error.schema.json", + "title": "Error", + "definitions": { + "Error": { + "$id": "#Error", + "description": "Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)", + "type": "object", + "required": [ + "code", + "reason" + ], + "properties": { + "code": { + "type": "integer", + "description": "Application relevant detail, defined in the API or a common list", + "examples": [ + "1", + "2" + ] + }, + "reason": { + "type": "string", + "description": "Explanation of the reason for the error which can be shown to a client user", + "examples": [ + "This customer does not exist", + "The service is not available at this location" + ] + }, + "message": { + "type": "string", + "description": "More details and corrective actions related to the error which can be shown to a client user", + "examples": [ + "Please use a valid password", + "Please enter a smaller quantity" + ] + }, + "status": { + "type": "string", + "description": "HTTP Error code extension", + "examples": [ + "400-2", + "500-4" + ] + }, + "referenceError": { + "type": "string", + "format": "uri", + "description": "URI of documentation describing the error", + "examples": [ + "https://docs.microsoft.com/en-us/windows/desktop/wmdm/error-codes", + "https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html" + ] } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/EventRef.schema.json b/Common/EventRef.schema.json index c54cd1ec..be3eea47 100644 --- a/Common/EventRef.schema.json +++ b/Common/EventRef.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EventRef.schema.json", - "title": "EventRef", - "definitions": { - "EventRef": { - "$id": "#EventRef", - "type": "object", - "description": "Events linked with service problem", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "eventTime": { - "type": "string", - "format": "date-time", - "description": "Time the event occurred" - }, - "eventType": { - "type": "string", - "description": "Type of the event" - }, - "href": { - "type": "string", - "description": "event reference" - }, - "id": { - "type": "string", - "description": "ID of the event" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EventRef.schema.json", + "title": "EventRef", + "definitions": { + "EventRef": { + "$id": "#EventRef", + "type": "object", + "description": "Events linked with service problem", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "Time the event occurred" + }, + "eventType": { + "type": "string", + "description": "Type of the event" + }, + "href": { + "type": "string", + "description": "event reference" + }, + "id": { + "type": "string", + "description": "ID of the event" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/ExportJob.schema.json b/Common/ExportJob.schema.json index a2ed0b71..0ab5a450 100644 --- a/Common/ExportJob.schema.json +++ b/Common/ExportJob.schema.json @@ -1,62 +1,62 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ExportJob.schema.json", - "title": "ExportJob", - "definitions": { - "ExportJob": { - "$id": "#ExportJob", - "description": "Represents a task used to export resources to a file", - "type": "object", - "properties": { - "completionDate": { - "type": "string", - "format": "date-time", - "description": "Data at which the job was completed" - }, - "contentType": { - "type": "string", - "description": "The format of the exported data" - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the job was created" - }, - "errorLog": { - "type": "string", - "description": "Reason for failure" - }, - "href": { - "type": "string", - "description": "Reference of the export job" - }, - "id": { - "type": "string", - "description": "Identifier of the export job" - }, - "path": { - "type": "string", - "description": "URL of the root resource acting as the source for streaming content to the file specified by the export job" - }, - "query": { - "type": "string", - "description": "Used to scope the exported data" - }, - "status": { - "description": "Status of the export job (not started, running, succeeded, failed)", - "$ref": "JobStateType.schema.json#/definitions/JobStateType" - }, - "url": { - "type": "string", - "format": "uri", - "description": "URL of the file containing the data to be exported" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ExportJob.schema.json", + "title": "ExportJob", + "definitions": { + "ExportJob": { + "$id": "#ExportJob", + "description": "Represents a task used to export resources to a file", + "type": "object", + "properties": { + "completionDate": { + "type": "string", + "format": "date-time", + "description": "Data at which the job was completed" + }, + "contentType": { + "type": "string", + "description": "The format of the exported data" + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the job was created" + }, + "errorLog": { + "type": "string", + "description": "Reason for failure" + }, + "href": { + "type": "string", + "description": "Reference of the export job" + }, + "id": { + "type": "string", + "description": "Identifier of the export job" + }, + "path": { + "type": "string", + "description": "URL of the root resource acting as the source for streaming content to the file specified by the export job" + }, + "query": { + "type": "string", + "description": "Used to scope the exported data" + }, + "status": { + "description": "Status of the export job (not started, running, succeeded, failed)", + "$ref": "JobStateType.schema.json#JobStateType" + }, + "url": { + "type": "string", + "format": "uri", + "description": "URL of the file containing the data to be exported" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/FileDocument.schema.json b/Common/FileDocument.schema.json index c4f70c10..23a2325f 100644 --- a/Common/FileDocument.schema.json +++ b/Common/FileDocument.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "FileDocument.schema.json", - "title": "FileDocument", - "definitions": { - "FileDocument": { - "$id": "#FileDocument", - "description": "A document accompanying an entity", - "type": "object", - "properties": { - "downloadUrl": { - "type": "string", - "format": "uri", - "description": "URL where the document could be downloaded" - }, - "fileType": { - "type": "string", - "description": "Document file format of the file : csv, pdf, xls, txt... for example" - }, - "name": { - "type": "string", - "description": "Document name" - }, - "size": { - "type": "integer", - "description": "Document file size (by default in bytes)" - }, - "sizeUnit": { - "type": "integer", - "description": "Size unit (in bytes by default)" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "FileDocument.schema.json", + "title": "FileDocument", + "definitions": { + "FileDocument": { + "$id": "#FileDocument", + "description": "A document accompanying an entity", + "type": "object", + "properties": { + "downloadUrl": { + "type": "string", + "format": "uri", + "description": "URL where the document could be downloaded" + }, + "fileType": { + "type": "string", + "description": "Document file format of the file : csv, pdf, xls, txt... for example" + }, + "name": { + "type": "string", + "description": "Document name" + }, + "size": { + "type": "integer", + "description": "Document file size (by default in bytes)" + }, + "sizeUnit": { + "type": "integer", + "description": "Size unit (in bytes by default)" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/FloatCharacteristic.schema.json b/Common/FloatCharacteristic.schema.json index db4f24bc..37809ab0 100644 --- a/Common/FloatCharacteristic.schema.json +++ b/Common/FloatCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "FloatCharacteristic.schema.json", - "title": "FloatCharacteristic", - "definitions": { - "FloatCharacteristic": { - "$id": "#FloatCharacteristic", - "description": "A characteristic which value is a float number", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "valueType": { - "type": "string", - "description": "Data type of the value of the characteristic" - }, - "value": { - "type": "number", - "format": "float", - "description": "Value of the characteristic" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "FloatCharacteristic.schema.json", + "title": "FloatCharacteristic", + "definitions": { + "FloatCharacteristic": { + "$id": "#FloatCharacteristic", + "description": "A characteristic which value is a float number", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "valueType": { + "type": "string", + "description": "Data type of the value of the characteristic" + }, + "value": { + "type": "number", + "format": "float", + "description": "Value of the characteristic" } + } } -} + } +} \ No newline at end of file diff --git a/Common/GeographicAddress.schema.json b/Common/GeographicAddress.schema.json index 3717b77d..ed359378 100644 --- a/Common/GeographicAddress.schema.json +++ b/Common/GeographicAddress.schema.json @@ -1,76 +1,76 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicAddress.schema.json", - "title": "GeographicAddress", - "definitions": { - "GeographicAddress": { - "$id": "#GeographicAddress", - "description": "Structured textual way of describing how to find a Property in an urban area (country properties are often defined differently).\nNote : Address corresponds to SID UrbanPropertyAddress", - "type": "object", - "properties": { - "city": { - "type": "string", - "description": "City that the address is in" - }, - "country": { - "type": "string", - "description": "Country that the address is in" - }, - "locality": { - "type": "string", - "description": "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature. [ANZLIC-STREET], or a suburb, a bounded locality within a city, town or shire principally of urban character [ANZLICSTREET]" - }, - "postcode": { - "type": "string", - "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" - }, - "stateOrProvince": { - "type": "string", - "description": "the State or Province that the address is in" - }, - "streetName": { - "type": "string", - "description": "Name of the street or other street type" - }, - "streetNr": { - "type": "string", - "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" - }, - "streetNrLast": { - "type": "string", - "description": "Last number in a range of street numbers allocated to a property" - }, - "streetNrLastSuffix": { - "type": "string", - "description": "Last street number suffix for a ranged address" - }, - "streetNrSuffix": { - "type": "string", - "description": "the first street number suffix" - }, - "streetSuffix": { - "type": "string", - "description": "A modifier denoting a relative direction" - }, - "streetType": { - "type": "string", - "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf " - }, - "geographicLocation": { - "$ref": "GeographicLocation.schema.json#GeographicLocation" - }, - "geographicSubAddress": { - "type": "array", - "items": { - "$ref": "GeographicSubAddress.schema.json#GeographicSubAddress" - } - } - }, - "allOf": [ - { - "$ref": "Place.schema.json#Place" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicAddress.schema.json", + "title": "GeographicAddress", + "definitions": { + "GeographicAddress": { + "$id": "#GeographicAddress", + "description": "Structured textual way of describing how to find a Property in an urban area (country properties are often defined differently).\nNote : Address corresponds to SID UrbanPropertyAddress", + "type": "object", + "properties": { + "city": { + "type": "string", + "description": "City that the address is in" + }, + "country": { + "type": "string", + "description": "Country that the address is in" + }, + "locality": { + "type": "string", + "description": "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature. [ANZLIC-STREET], or a suburb, a bounded locality within a city, town or shire principally of urban character [ANZLICSTREET]" + }, + "postcode": { + "type": "string", + "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" + }, + "stateOrProvince": { + "type": "string", + "description": "the State or Province that the address is in" + }, + "streetName": { + "type": "string", + "description": "Name of the street or other street type" + }, + "streetNr": { + "type": "string", + "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" + }, + "streetNrLast": { + "type": "string", + "description": "Last number in a range of street numbers allocated to a property" + }, + "streetNrLastSuffix": { + "type": "string", + "description": "Last street number suffix for a ranged address" + }, + "streetNrSuffix": { + "type": "string", + "description": "the first street number suffix" + }, + "streetSuffix": { + "type": "string", + "description": "A modifier denoting a relative direction" + }, + "streetType": { + "type": "string", + "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf " + }, + "geographicLocation": { + "$ref": "GeographicLocation.schema.json#GeographicLocation" + }, + "geographicSubAddress": { + "type": "array", + "items": { + "$ref": "GeographicSubAddress.schema.json#GeographicSubAddress" + } } + }, + "allOf": [ + { + "$ref": "Place.schema.json#Place" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/GeographicAddressRef.schema.json b/Common/GeographicAddressRef.schema.json index 49884dd9..471071b1 100644 --- a/Common/GeographicAddressRef.schema.json +++ b/Common/GeographicAddressRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicAddressRef.schema.json", - "title": "GeographicAddressRef", - "definitions": { - "GeographicAddressRef": { - "$id": "#GeographicAddressRef", - "description": "The place at which the change request has occurred.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The detail address of the location." - }, - "id": { - "type": "string", - "description": "The post code of an address." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicAddressRef.schema.json", + "title": "GeographicAddressRef", + "definitions": { + "GeographicAddressRef": { + "$id": "#GeographicAddressRef", + "description": "The place at which the change request has occurred.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The detail address of the location." + }, + "id": { + "type": "string", + "description": "The post code of an address." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/GeographicAddressValidation.schema.json b/Common/GeographicAddressValidation.schema.json index f486777b..0a86a090 100644 --- a/Common/GeographicAddressValidation.schema.json +++ b/Common/GeographicAddressValidation.schema.json @@ -1,53 +1,53 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicAddressValidation.schema.json", - "title": "GeographicAddressValidation", - "definitions": { - "GeographicAddressValidation": { - "$id": "#GeographicAddressValidation", - "description": "This resource is used to manage address validation request and response", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "An URI used to access to the address validation resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Address Validation" - }, - "provideAlternative": { - "type": "boolean", - "description": "Indicator provided by the requester to specify if alternate addresses must be provided in case of partial or fail result." - }, - "status": { - "type": "string", - "description": "Status of the address validation (inProgress, terminatedWithError, done)" - }, - "validationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the address validation is performed" - }, - "validationResult": { - "type": "string", - "description": "Result of the address validation (success, partial, fail)" - }, - "validAddress": { - "$ref": "GeographicAddress.schema.json#GeographicAddress" - }, - "alternateGeographicAddress": { - "type": "array", - "items": { - "$ref": "GeographicAddress.schema.json#GeographicAddress" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicAddressValidation.schema.json", + "title": "GeographicAddressValidation", + "definitions": { + "GeographicAddressValidation": { + "$id": "#GeographicAddressValidation", + "description": "This resource is used to manage address validation request and response", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "An URI used to access to the address validation resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Address Validation" + }, + "provideAlternative": { + "type": "boolean", + "description": "Indicator provided by the requester to specify if alternate addresses must be provided in case of partial or fail result." + }, + "status": { + "type": "string", + "description": "Status of the address validation (inProgress, terminatedWithError, done)" + }, + "validationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the address validation is performed" + }, + "validationResult": { + "type": "string", + "description": "Result of the address validation (success, partial, fail)" + }, + "validAddress": { + "$ref": "GeographicAddress.schema.json#GeographicAddress" + }, + "alternateGeographicAddress": { + "type": "array", + "items": { + "$ref": "GeographicAddress.schema.json#GeographicAddress" + } } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/GeographicLocation.schema.json b/Common/GeographicLocation.schema.json index 2dd5ec64..27b937b7 100644 --- a/Common/GeographicLocation.schema.json +++ b/Common/GeographicLocation.schema.json @@ -1,36 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicLocation.schema.json", - "title": "GeographicLocation", - "definitions": { - "GeographicLocation": { - "$id": "#GeographicLocation", - "description": "A GeographicLocation allows to describe through coordinate(s) a point, a line or a space", - "type": "object", - "properties": { - "accuracy": { - "type": "string" - }, - "geometryType": { - "type": "string", - "description": "Type allows to describe the GeoLocation form: it could be a point, a line, a polygon, a cylinder, etc" - }, - - "spatialRef": { - "type": "string" - }, - "geometry": { - "type": "array", - "items": { - "$ref": "GeographicPoint.schema.json#GeographicPoint" - } - } - }, - "allOf": [ - { - "$ref": "Place.schema.json#Place" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicLocation.schema.json", + "title": "GeographicLocation", + "definitions": { + "GeographicLocation": { + "$id": "#GeographicLocation", + "description": "A GeographicLocation allows to describe through coordinate(s) a point, a line or a space", + "type": "object", + "properties": { + "accuracy": { + "type": "string" + }, + "geometryType": { + "type": "string", + "description": "Type allows to describe the GeoLocation form: it could be a point, a line, a polygon, a cylinder, etc" + }, + "spatialRef": { + "type": "string" + }, + "geometry": { + "type": "array", + "items": { + "$ref": "GeographicPoint.schema.json#GeographicPoint" + } } + }, + "allOf": [ + { + "$ref": "Place.schema.json#Place" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/GeographicLocationRef.schema.json b/Common/GeographicLocationRef.schema.json index a46ac26f..7f623e52 100644 --- a/Common/GeographicLocationRef.schema.json +++ b/Common/GeographicLocationRef.schema.json @@ -1,18 +1,17 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicLocationRef.schema.json", - "title": "GeographicLocationRef", - "definitions": { - "GeographicLocationRef": { - "$id": "#GeographicLocationRef", - "type": "object", - "properties": { - }, - "allOf": [ - { - "$ref": "PlaceRef.schema.json#PlaceRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicLocationRef.schema.json", + "title": "GeographicLocationRef", + "definitions": { + "GeographicLocationRef": { + "$id": "#GeographicLocationRef", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "PlaceRef.schema.json#PlaceRef" } + ] } -} + } +} \ No newline at end of file diff --git a/Common/GeographicSite.schema.json b/Common/GeographicSite.schema.json index 9f739ebb..b82f7930 100644 --- a/Common/GeographicSite.schema.json +++ b/Common/GeographicSite.schema.json @@ -1,70 +1,70 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicSite.schema.json", - "title": "GeographicSite", - "definitions": { - "GeographicSite": { - "$id": "#GeographicSite", - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "A code that may be used for some addressing schemes eg: [ANSI T1.253-1999]" - }, - "description": { - "type": "string", - "description": "Text describing additional information regarding the site" - }, - "href": { - "type": "string", - "description": "An URI used to access to the site" - }, - "id": { - "type": "string", - "description": "Unique identifier of the site within the server" - }, - "name": { - "type": "string", - "description": "The name that the site is known by" - }, - "status": { - "type": "string", - "description": "The condition of the GeographicSite, such as active, inactive, planned address" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "calendar": { - "type": "array", - "items": { - "$ref": "CalendarPeriod.schema.json#CalendarPeriod" - } - }, - "geographicLocation": { - "$ref": "GeographicLocation.schema.json#GeographicLocation" - }, - "address": { - "$ref": "GeographicAddress.schema.json#GeographicAddress" - }, - "siteRelationship": { - "type": "array", - "items": { - "$ref": "SiteRelationship.schema.json#SiteRelationship" - } - }, - "role": { - "type": "string", - "description": "Role of the place, such as: [home delivery], [shop retrieval])" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicSite.schema.json", + "title": "GeographicSite", + "definitions": { + "GeographicSite": { + "$id": "#GeographicSite", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "A code that may be used for some addressing schemes eg: [ANSI T1.253-1999]" + }, + "description": { + "type": "string", + "description": "Text describing additional information regarding the site" + }, + "href": { + "type": "string", + "description": "An URI used to access to the site" + }, + "id": { + "type": "string", + "description": "Unique identifier of the site within the server" + }, + "name": { + "type": "string", + "description": "The name that the site is known by" + }, + "status": { + "type": "string", + "description": "The condition of the GeographicSite, such as active, inactive, planned address" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "calendar": { + "type": "array", + "items": { + "$ref": "CalendarPeriod.schema.json#CalendarPeriod" + } + }, + "geographicLocation": { + "$ref": "GeographicLocation.schema.json#GeographicLocation" + }, + "address": { + "$ref": "GeographicAddress.schema.json#GeographicAddress" + }, + "siteRelationship": { + "type": "array", + "items": { + "$ref": "SiteRelationship.schema.json#SiteRelationship" + } + }, + "role": { + "type": "string", + "description": "Role of the place, such as: [home delivery], [shop retrieval])" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/GeographicSubAddress.schema.json b/Common/GeographicSubAddress.schema.json index 596b1d08..dd345c49 100644 --- a/Common/GeographicSubAddress.schema.json +++ b/Common/GeographicSubAddress.schema.json @@ -1,63 +1,63 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicSubAddress.schema.json", - "title": "GeographicSubAddress", - "definitions": { - "GeographicSubAddress": { - "$id": "#GeographicSubAddress", - "description": "Representation of a GeographicSubAddress \nIt is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.", - "type": "object", - "properties": { - "buildingName": { - "type": "string", - "description": "allows for buildings that have well-known names" - }, - "href": { - "type": "string", - "description": "Link to the subAddress" - }, - "id": { - "type": "string", - "description": "Unique Identifier of the subAddress" - }, - "levelNumber": { - "type": "string", - "description": "used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2" - }, - "levelType": { - "type": "string", - "description": "describes level types within a building" - }, - "name": { - "type": "string", - "description": "Name of the subAddress to identify it with a meaningful identification" - }, - "privateStreetName": { - "type": "string", - "description": "private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office." - }, - "privateStreetNumber": { - "type": "string", - "description": "private streets numbers internal to a private street" - }, - "subUnitNumber": { - "type": "string", - "description": "the discriminator used for the subunit\noften just a simple number e.g. FLAT 5, may also be a range" - }, - "subUnitType": { - "type": "string", - "description": "the type of subunit\ne.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF" - }, - "subAddressType": { - "type": "string", - "description": "Type of subAddress : it can be a subunit or a private street" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicSubAddress.schema.json", + "title": "GeographicSubAddress", + "definitions": { + "GeographicSubAddress": { + "$id": "#GeographicSubAddress", + "description": "Representation of a GeographicSubAddress \nIt is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.", + "type": "object", + "properties": { + "buildingName": { + "type": "string", + "description": "allows for buildings that have well-known names" + }, + "href": { + "type": "string", + "description": "Link to the subAddress" + }, + "id": { + "type": "string", + "description": "Unique Identifier of the subAddress" + }, + "levelNumber": { + "type": "string", + "description": "used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2" + }, + "levelType": { + "type": "string", + "description": "describes level types within a building" + }, + "name": { + "type": "string", + "description": "Name of the subAddress to identify it with a meaningful identification" + }, + "privateStreetName": { + "type": "string", + "description": "private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office." + }, + "privateStreetNumber": { + "type": "string", + "description": "private streets numbers internal to a private street" + }, + "subUnitNumber": { + "type": "string", + "description": "the discriminator used for the subunit\noften just a simple number e.g. FLAT 5, may also be a range" + }, + "subUnitType": { + "type": "string", + "description": "the type of subunit\ne.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF" + }, + "subAddressType": { + "type": "string", + "description": "Type of subAddress : it can be a subunit or a private street" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/HeaderItem.schema.json b/Common/HeaderItem.schema.json index cdad79d2..e75d42a2 100644 --- a/Common/HeaderItem.schema.json +++ b/Common/HeaderItem.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "HeaderItem.schema.json", - "title": "HeaderItem", - "definitions": { - "HeaderItem": { - "$id": "#HeaderItem", - "type": "object", - "description": "An item typically included in a request or response", - "properties": { - "name": { - "description": "The name of the header item, e.g. locale", - "type": "string" - }, - "value": { - "description": "The value of the header item, e.g. en-us", - "type": "string" - } - }, - "required": [ - "name", - "value" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "HeaderItem.schema.json", + "title": "HeaderItem", + "definitions": { + "HeaderItem": { + "$id": "#HeaderItem", + "type": "object", + "description": "An item typically included in a request or response", + "properties": { + "name": { + "description": "The name of the header item, e.g. locale", + "type": "string" + }, + "value": { + "description": "The value of the header item, e.g. en-us", + "type": "string" } + }, + "required": [ + "name", + "value" + ] } -} + } +} \ No newline at end of file diff --git a/Common/HourPeriod.schema.json b/Common/HourPeriod.schema.json index 4dc76268..9d61567e 100644 --- a/Common/HourPeriod.schema.json +++ b/Common/HourPeriod.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "HourPeriod.schema.json", - "title": "HourPeriod", - "definitions": { - "HourPeriod": { - "$id": "#HourPeriod", - "type": "object", - "properties": { - "endHour": { - "type": "string", - "description": "The time when the status ends applying" - }, - "startHour": { - "type": "string", - "description": "The time when the status starts applying" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "HourPeriod.schema.json", + "title": "HourPeriod", + "definitions": { + "HourPeriod": { + "$id": "#HourPeriod", + "type": "object", + "properties": { + "endHour": { + "type": "string", + "description": "The time when the status ends applying" + }, + "startHour": { + "type": "string", + "description": "The time when the status starts applying" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Hub.schema.json b/Common/Hub.schema.json index 2b6f6e7c..78bac7ce 100644 --- a/Common/Hub.schema.json +++ b/Common/Hub.schema.json @@ -1,46 +1,46 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Hub.schema.json", - "title": "Hub", - "definitions": { - "Hub": { - "$id": "#Hub", - "description": "A Hub is used to subscribe to an event notification", - "type": "object", - "required": [ - "id", - "callback" - ], - "properties": { - "id": { - "type": "string", - "description": "The unique-id for your subscription - referenced when updating or deleting a subscription", - "examples": [ - "4aafacbd-11ff-4dc8-b445-305f2215715f", - "2334bc59-726e-4d34-ab96-f50e0561412f" - ] - }, - "callback": { - "type": "string", - "format": "uri", - "description": "The URI that will be POSTed to when a notification is triggered", - "examples": [ - "http://host/resource/id/listener" - ] - }, - "query": { - "type": "string", - "description": "This is a query string used to filter notifications in the context of the notifier", - "examples": [ - "status=active" - ] - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Hub.schema.json", + "title": "Hub", + "definitions": { + "Hub": { + "$id": "#Hub", + "description": "A Hub is used to subscribe to an event notification", + "type": "object", + "required": [ + "id", + "callback" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique-id for your subscription - referenced when updating or deleting a subscription", + "examples": [ + "4aafacbd-11ff-4dc8-b445-305f2215715f", + "2334bc59-726e-4d34-ab96-f50e0561412f" + ] + }, + "callback": { + "type": "string", + "format": "uri", + "description": "The URI that will be POSTed to when a notification is triggered", + "examples": [ + "http://host/resource/id/listener" + ] + }, + "query": { + "type": "string", + "description": "This is a query string used to filter notifications in the context of the notifier", + "examples": [ + "status=active" + ] } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/ImpactEntityRef.schema.json b/Common/ImpactEntityRef.schema.json index ed17732e..4accb81d 100644 --- a/Common/ImpactEntityRef.schema.json +++ b/Common/ImpactEntityRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ImpactEntityRef.schema.json", - "title": "ImpactEntityRef", - "definitions": { - "ImpactEntityRef": { - "$id": "#ImpactEntityRef", - "description": "Defines the entities (product, service, resource, and other related objects) which will be impacted while the change \nrequest is executed.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description and analysis of the impact of the change request on the Product, Service or Resource." - }, - "href": { - "type": "string", - "description": "Hyperlink to access the impacted party, it could be a party reference or a party role reference." - }, - "id": { - "type": "string", - "description": "Identifier of impacted entity." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ImpactEntityRef.schema.json", + "title": "ImpactEntityRef", + "definitions": { + "ImpactEntityRef": { + "$id": "#ImpactEntityRef", + "description": "Defines the entities (product, service, resource, and other related objects) which will be impacted while the change \nrequest is executed.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description and analysis of the impact of the change request on the Product, Service or Resource." + }, + "href": { + "type": "string", + "description": "Hyperlink to access the impacted party, it could be a party reference or a party role reference." + }, + "id": { + "type": "string", + "description": "Identifier of impacted entity." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/ImportJob.schema.json b/Common/ImportJob.schema.json index d15e84cb..c027b329 100644 --- a/Common/ImportJob.schema.json +++ b/Common/ImportJob.schema.json @@ -1,58 +1,58 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ImportJob.schema.json", - "title": "ImportJob", - "definitions": { - "ImportJob": { - "$id": "#ImportJob", - "description": "Represents a task used to import resources from a file", - "type": "object", - "properties": { - "completionDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the job was completed" - }, - "contentType": { - "type": "string", - "description": "Indicates the format of the imported data" - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the job was created" - }, - "errorLog": { - "type": "string", - "description": "Reason for failure if status is failed" - }, - "href": { - "type": "string", - "description": "Reference of the import job" - }, - "id": { - "type": "string", - "description": "Identifier of the import job" - }, - "path": { - "type": "string", - "description": "URL of the root resource where the content of the file specified by the import job must be applied" - }, - "status": { - "description": "Status of the import job (not started, running, succeeded, failed)", - "$ref": "JobStateType.schema.json#/definitions/JobStateType" - }, - "url": { - "type": "string", - "format": "uri", - "description": "URL of the file containing the data to be imported" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ImportJob.schema.json", + "title": "ImportJob", + "definitions": { + "ImportJob": { + "$id": "#ImportJob", + "description": "Represents a task used to import resources from a file", + "type": "object", + "properties": { + "completionDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the job was completed" + }, + "contentType": { + "type": "string", + "description": "Indicates the format of the imported data" + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the job was created" + }, + "errorLog": { + "type": "string", + "description": "Reason for failure if status is failed" + }, + "href": { + "type": "string", + "description": "Reference of the import job" + }, + "id": { + "type": "string", + "description": "Identifier of the import job" + }, + "path": { + "type": "string", + "description": "URL of the root resource where the content of the file specified by the import job must be applied" + }, + "status": { + "description": "Status of the import job (not started, running, succeeded, failed)", + "$ref": "JobStateType.schema.json#JobStateType" + }, + "url": { + "type": "string", + "format": "uri", + "description": "URL of the file containing the data to be imported" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Incident.schema.json b/Common/Incident.schema.json index 6e1855dc..72e171f6 100644 --- a/Common/Incident.schema.json +++ b/Common/Incident.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Incident.schema.json", - "title": "Incident", - "definitions": { - "Incident": { - "$id": "#Incident", - "description": "An Incident is a record of an event that has altered the operational state of a entity (Resource, Service or Customers Product)", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description of the incident." - }, - "name": { - "type": "string", - "description": "The name of the incident." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Incident.schema.json", + "title": "Incident", + "definitions": { + "Incident": { + "$id": "#Incident", + "description": "An Incident is a record of an event that has altered the operational state of a entity (Resource, Service or Customers Product)", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of the incident." + }, + "name": { + "type": "string", + "description": "The name of the incident." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/IntegerCharacteristic.schema.json b/Common/IntegerCharacteristic.schema.json index e1e3f803..ba948af9 100644 --- a/Common/IntegerCharacteristic.schema.json +++ b/Common/IntegerCharacteristic.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "IntegerCharacteristic.schema.json", - "title": "IntegerCharacteristic", - "definitions": { - "IntegerCharacteristic": { - "$id": "#IntegerCharacteristic", - "description": "A characteristic which value is a integer number", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "valueType": { - "type": "string", - "description": "Data type of the value of the characteristic" - }, - "value": { - "type": "integer", - "description": "Value of the characteristic" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "IntegerCharacteristic.schema.json", + "title": "IntegerCharacteristic", + "definitions": { + "IntegerCharacteristic": { + "$id": "#IntegerCharacteristic", + "description": "A characteristic which value is a integer number", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "valueType": { + "type": "string", + "description": "Data type of the value of the characteristic" + }, + "value": { + "type": "integer", + "description": "Value of the characteristic" } + } } -} + } +} \ No newline at end of file diff --git a/Common/JobStateType.schema.json b/Common/JobStateType.schema.json index 53b5990c..6247d6f9 100644 --- a/Common/JobStateType.schema.json +++ b/Common/JobStateType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "JobStateType.schema.json", - "title": "JobStateType", - "definitions": { - "JobStateType": { - "$id": "#JobStateType", - "type": "string", - "description": "Valid values for the state of a batch job (e.g. catalog import)", - "enum": [ - "Not Started", - "Running", - "Succeeded", - "Failed" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "JobStateType.schema.json", + "title": "JobStateType", + "definitions": { + "JobStateType": { + "$id": "#JobStateType", + "type": "string", + "description": "Valid values for the state of a batch job (e.g. catalog import)", + "enum": [ + "Not Started", + "Running", + "Succeeded", + "Failed" + ] } -} + } +} \ No newline at end of file diff --git a/Common/LocationCharacteristic.schema.json b/Common/LocationCharacteristic.schema.json index 72978ea7..cfe35dd1 100644 --- a/Common/LocationCharacteristic.schema.json +++ b/Common/LocationCharacteristic.schema.json @@ -1,25 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LocationCharacteristic.schema.json", - "title": "LocationCharacteristic", - "definitions": { - "LocationCharacteristic": { - "$id": "#LocationCharacteristic", - "description": "Name/value pairs, used to extra characterized the Area (e.g. if a standard\ncode set has been defined for the GeographicArea type, etc.)", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LocationCharacteristic.schema.json", + "title": "LocationCharacteristic", + "definitions": { + "LocationCharacteristic": { + "$id": "#LocationCharacteristic", + "description": "Name/value pairs, used to extra characterized the Area (e.g. if a standard\ncode set has been defined for the GeographicArea type, etc.)", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/MediumCharacteristic.schema.json b/Common/MediumCharacteristic.schema.json index 1973e45a..debe6a28 100644 --- a/Common/MediumCharacteristic.schema.json +++ b/Common/MediumCharacteristic.schema.json @@ -1,62 +1,63 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "MediumCharacteristic.schema.json", - "title": "MediumCharacteristic", - "definitions": { - "MediumCharacteristic": { - "type": "object", - "description": "Describes the contact medium characteristics that could be used to contact a party (an individual or an organization)", - "properties": { - "city": { - "type": "string", - "description": "The city" - }, - "country": { - "type": "string", - "description": "The country" - }, - "emailAddress": { - "type": "string", - "description": "Full email address in standard format" - }, - "faxNumber": { - "type": "string", - "description": "The fax number of the contact" - }, - "contactType": { - "type": "string", - "description": "The type of contact, for example: phone number such as mobile, fixed home, fixed office. postal address such as shipping instalation…" - }, - "socialNetworkId": { - "type": "string", - "description": "Identifier as a member of a social network" - }, - "phoneNumber": { - "type": "string", - "description": "The primary phone number of the contact" - }, - "postCode": { - "type": "string", - "description": "Postcode" - }, - "stateOrProvince": { - "type": "string", - "description": "State or province" - }, - "street1": { - "type": "string", - "description": "Describes the street" - }, - "street2": { - "type": "string", - "description": "Complementary street description" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#/Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "MediumCharacteristic.schema.json", + "title": "MediumCharacteristic", + "definitions": { + "MediumCharacteristic": { + "$id": "#MediumCharacteristic", + "type": "object", + "description": "Describes the contact medium characteristics that could be used to contact a party (an individual or an organization)", + "properties": { + "city": { + "type": "string", + "description": "The city" + }, + "country": { + "type": "string", + "description": "The country" + }, + "emailAddress": { + "type": "string", + "description": "Full email address in standard format" + }, + "faxNumber": { + "type": "string", + "description": "The fax number of the contact" + }, + "contactType": { + "type": "string", + "description": "The type of contact, for example: phone number such as mobile, fixed home, fixed office. postal address such as shipping instalation…" + }, + "socialNetworkId": { + "type": "string", + "description": "Identifier as a member of a social network" + }, + "phoneNumber": { + "type": "string", + "description": "The primary phone number of the contact" + }, + "postCode": { + "type": "string", + "description": "Postcode" + }, + "stateOrProvince": { + "type": "string", + "description": "State or province" + }, + "street1": { + "type": "string", + "description": "Describes the street" + }, + "street2": { + "type": "string", + "description": "Complementary street description" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Common/Monitor.schema.json b/Common/Monitor.schema.json index 187bc51f..17f16d1a 100644 --- a/Common/Monitor.schema.json +++ b/Common/Monitor.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Monitor.schema.json", - "title": "Monitor", - "definitions": { - "Monitor": { - "$id": "#Monitor", - "type": "object", - "description": "Monitoring of resources", - "properties": { - "href": { - "type": "string", - "description": "reference to this monitor" - }, - "id": { - "type": "string", - "description": "Identifier of an instance of the monitor. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type" - }, - "request": { - "description": "Represents the request", - "$ref": "Request.schema.json#/definitions/Request" - }, - "response": { - "description": "Represents the response", - "$ref": "Response.schema.json#/definitions/Response" - }, - "sourceHref": { - "type": "string", - "description": "The monitored resource href" - }, - "state": { - "type": "string", - "description": "The Monitor state of the resource. InProgress, InError, Completed" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Monitor.schema.json", + "title": "Monitor", + "definitions": { + "Monitor": { + "$id": "#Monitor", + "type": "object", + "description": "Monitoring of resources", + "properties": { + "href": { + "type": "string", + "description": "reference to this monitor" + }, + "id": { + "type": "string", + "description": "Identifier of an instance of the monitor. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type" + }, + "request": { + "description": "Represents the request", + "$ref": "Request.schema.json#Request" + }, + "response": { + "description": "Represents the response", + "$ref": "Response.schema.json#Response" + }, + "sourceHref": { + "type": "string", + "description": "The monitored resource href" + }, + "state": { + "type": "string", + "description": "The Monitor state of the resource. InProgress, InError, Completed" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Note.schema.json b/Common/Note.schema.json index d8b74991..a74d713d 100644 --- a/Common/Note.schema.json +++ b/Common/Note.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Note.schema.json", - "title": "Note", - "definitions": { - "Note": { - "$id": "#Note", - "description": "Extra information about a given entity", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)" - }, - "author": { - "type": "string", - "description": "Author of the note" - }, - "date": { - "type": "string", - "format": "date-time", - "description": "Date of the note" - }, - "text": { - "type": "string", - "description": "Text of the note" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Note.schema.json", + "title": "Note", + "definitions": { + "Note": { + "$id": "#Note", + "description": "Extra information about a given entity", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)" + }, + "author": { + "type": "string", + "description": "Author of the note" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "Date of the note" + }, + "text": { + "type": "string", + "description": "Text of the note" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Notification.schema.json b/Common/Notification.schema.json index 43854074..9b115b1b 100644 --- a/Common/Notification.schema.json +++ b/Common/Notification.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Notification.schema.json", - "title": "Notification", - "definitions": { - "Notification": { - "$id": "#Notification", - "description": "The notification is sent to each listener who has subscribed to receive it.", - "type": "object", - "properties": { - "eventId": { - "type": "string", - "description": "Identifier of the event" - }, - "eventTime": { - "type": "string", - "format": "date-time", - "description": "Creation date of the event" - }, - "eventType": { - "type": "string", - "description": "Type of event" - }, - "fieldPath": { - "type": "string", - "description": "details which field is missing, its structure is quite similar to GET filter criteria" - }, - "resourcePath": { - "type": "string", - "description": "To indicate which entity is concerned" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Notification.schema.json", + "title": "Notification", + "definitions": { + "Notification": { + "$id": "#Notification", + "description": "The notification is sent to each listener who has subscribed to receive it.", + "type": "object", + "properties": { + "eventId": { + "type": "string", + "description": "Identifier of the event" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "Creation date of the event" + }, + "eventType": { + "type": "string", + "description": "Type of event" + }, + "fieldPath": { + "type": "string", + "description": "details which field is missing, its structure is quite similar to GET filter criteria" + }, + "resourcePath": { + "type": "string", + "description": "To indicate which entity is concerned" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Object.schema.json b/Common/Object.schema.json index dd6d65fc..190a688f 100644 --- a/Common/Object.schema.json +++ b/Common/Object.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Object.schema.json", - "title": "Object", - "definitions": { - "Object": { - "$id": "#Object", - "type": "object", - "properties": { - "objectType": { - "type": "string", - "description": "The type of object" - }, - "uri": { - "type": "string", - "format": "uri" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Object.schema.json", + "title": "Object", + "definitions": { + "Object": { + "$id": "#Object", + "type": "object", + "properties": { + "objectType": { + "type": "string", + "description": "The type of object" + }, + "uri": { + "type": "string", + "format": "uri" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/ObjectCharacteristic.schema.json b/Common/ObjectCharacteristic.schema.json index 950c012c..cf55ddbb 100644 --- a/Common/ObjectCharacteristic.schema.json +++ b/Common/ObjectCharacteristic.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ObjectCharacteristic.schema.json", - "title": "ObjectCharacteristic", - "definitions": { - "ObjectCharacteristic": { - "$id": "ObjectCharacteristic", - "description": "A characteristic which value is an object", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "valueType": { - "type": "string", - "description": "Data type of the value of the characteristic" - }, - "value": { - "type": "string", - "description": "Value of the characteristic" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ObjectCharacteristic.schema.json", + "title": "ObjectCharacteristic", + "definitions": { + "ObjectCharacteristic": { + "$id": "#ObjectCharacteristic", + "description": "A characteristic which value is an object", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "valueType": { + "type": "string", + "description": "Data type of the value of the characteristic" + }, + "value": { + "type": "string", + "description": "Value of the characteristic" } + } } -} + } +} \ No newline at end of file diff --git a/Common/Place.schema.json b/Common/Place.schema.json index a09b1b50..9eeff0c7 100644 --- a/Common/Place.schema.json +++ b/Common/Place.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Place.schema.json", - "title": "Place", - "definitions": { - "Place": { - "$id": "#Place", - "description": "Place reference. Place defines the places where the products are sold or delivered.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Unique reference of the place" - }, - "id": { - "type": "string", - "description": "Unique identifier of the place" - }, - "name": { - "type": "string", - "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Place.schema.json", + "title": "Place", + "definitions": { + "Place": { + "$id": "#Place", + "description": "Place reference. Place defines the places where the products are sold or delivered.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Unique reference of the place" + }, + "id": { + "type": "string", + "description": "Unique identifier of the place" + }, + "name": { + "type": "string", + "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/PlaceRef.schema.json b/Common/PlaceRef.schema.json index 5df39046..10b98a40 100644 --- a/Common/PlaceRef.schema.json +++ b/Common/PlaceRef.schema.json @@ -1,19 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PlaceRef.schema.json", - "title": "PlaceRef", - "definitions": { - "PlaceRef": { - "$id": "#PlaceRef", - "description": "Place reference. PlaceRef defines the placeRefs where the products are sold or delivered.", - "type": "object", - "properties": { - }, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PlaceRef.schema.json", + "title": "PlaceRef", + "definitions": { + "PlaceRef": { + "$id": "#PlaceRef", + "description": "Place reference. PlaceRef defines the placeRefs where the products are sold or delivered.", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "EntityRef.schema.json#EntityRef" } + ] } -} + } +} \ No newline at end of file diff --git a/Common/ProcessFlow.schema.json b/Common/ProcessFlow.schema.json index 0e66d799..6424622e 100644 --- a/Common/ProcessFlow.schema.json +++ b/Common/ProcessFlow.schema.json @@ -1,73 +1,74 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProcessFlow.schema.json", - "title": "ProcessFlow", - "definitions": { - "ProcessFlow": { - "type": "object", - "properties": { - "channel": { - "type": "array", - "items": { - "$ref": "ChannelRef.schema.json#/definitions/ChannelRef" - }, - "description": "A list of channel(s) where this processFlow is executed" - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "Characteristic.schema.json#/definitions/Characteristic" - }, - "description": "A list of characteristic(s) associated to this processFlow" - }, - "href": { - "type": "string", - "description": "Reference of the ProcessFlow" - }, - "id": { - "type": "string", - "description": "Identifier of the Process flow" - }, - "processFlowDate": { - "type": "string", - "format": "date-time", - "description": "Is the date when the processFlow was created in basse (timestamp)" - }, - "processFlowSpecification": { - "type": "string", - "description": "Specification of the processFlow." - }, - "relatedEntity": { - "type": "array", - "items": { - "$ref": "RelatedEntity.schema.json#/definitions/RelatedEntity" - }, - "description": "A list of related entity(ies) to this processFlow" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#/definitions/RelatedParty" - }, - "description": "A list of related party(ies) to this processFlow" - }, - "state": { - "$ref": "ProcessFlowStateType.schema.json#/definitions/ProcessFlowStateType", - "description": "State of the ProcessFlow: described in the state machine diagram." - }, - "taskFlow": { - "type": "array", - "items": { - "$ref": "TaskFlowRef.schema.json#/definitions/TaskFlowRef" - }, - "description": "A list of taskflow related to this processFlow" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#/Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProcessFlow.schema.json", + "title": "ProcessFlow", + "definitions": { + "ProcessFlow": { + "$id": "#ProcessFlow", + "type": "object", + "properties": { + "channel": { + "type": "array", + "items": { + "$ref": "ChannelRef.schema.json#ChannelRef" + }, + "description": "A list of channel(s) where this processFlow is executed" + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "Characteristic.schema.json#Characteristic" + }, + "description": "A list of characteristic(s) associated to this processFlow" + }, + "href": { + "type": "string", + "description": "Reference of the ProcessFlow" + }, + "id": { + "type": "string", + "description": "Identifier of the Process flow" + }, + "processFlowDate": { + "type": "string", + "format": "date-time", + "description": "Is the date when the processFlow was created in basse (timestamp)" + }, + "processFlowSpecification": { + "type": "string", + "description": "Specification of the processFlow." + }, + "relatedEntity": { + "type": "array", + "items": { + "$ref": "RelatedEntity.schema.json#RelatedEntity" + }, + "description": "A list of related entity(ies) to this processFlow" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "A list of related party(ies) to this processFlow" + }, + "state": { + "$ref": "ProcessFlowStateType.schema.json#ProcessFlowStateType", + "description": "State of the ProcessFlow: described in the state machine diagram." + }, + "taskFlow": { + "type": "array", + "items": { + "$ref": "TaskFlowRef.schema.json#TaskFlowRef" + }, + "description": "A list of taskflow related to this processFlow" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Common/ProcessFlowRef.schema.json b/Common/ProcessFlowRef.schema.json index 90fdf747..73c6dab9 100644 --- a/Common/ProcessFlowRef.schema.json +++ b/Common/ProcessFlowRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProcessFlowRef.schema.json", - "title": "ProcessFlowRef", - "definitions": { - "ProcessFlowRef": { - "$id": "#ProcessFlowRef", - "description": "Process Flow ref class is used to provide process main information from Task sub resource.", - "type": "object", - "properties": { - "state": { - "description": "The life cycle state of the processFlow", - "$ref": "ProcessFlowStateType.schema.json#/definitions/ProcessFlowStateType" - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProcessFlowRef.schema.json", + "title": "ProcessFlowRef", + "definitions": { + "ProcessFlowRef": { + "$id": "#ProcessFlowRef", + "description": "Process Flow ref class is used to provide process main information from Task sub resource.", + "type": "object", + "properties": { + "state": { + "description": "The life cycle state of the processFlow", + "$ref": "ProcessFlowStateType.schema.json#ProcessFlowStateType" + } + }, + "allOf": [ + { + "$ref": "EntityRef.schema.json#EntityRef" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/ProcessFlowStateType.schema.json b/Common/ProcessFlowStateType.schema.json index 756574e0..1a3552aa 100644 --- a/Common/ProcessFlowStateType.schema.json +++ b/Common/ProcessFlowStateType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProcessFlowStateType.schema.json", - "title": "ProcessFlowStateType", - "definitions": { - "ProcessFlowStateType": { - "$id": "#ProcessFlowStateType", - "type": "string", - "description": "Valid values for the lifecycle state of the processFlow", - "enum": [ - "active", - "cancelled", - "hold", - "completed" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProcessFlowStateType.schema.json", + "title": "ProcessFlowStateType", + "definitions": { + "ProcessFlowStateType": { + "$id": "#ProcessFlowStateType", + "type": "string", + "description": "Valid values for the lifecycle state of the processFlow", + "enum": [ + "active", + "cancelled", + "hold", + "completed" + ] } -} + } +} \ No newline at end of file diff --git a/Common/QualificationRef.schema.json b/Common/QualificationRef.schema.json index 243090d2..4af9c2e1 100644 --- a/Common/QualificationRef.schema.json +++ b/Common/QualificationRef.schema.json @@ -1,22 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QualificationRef.schema.json", - "title": "QualificationRef", - "definitions": { - "QualificationRef": { - "type": "object", - "description": "It could be a serviceQualification or a productOfferingQualification that has been executed previously and captured in the productOrder to provide eligibility information", - "properties": { - "qualificationItemId": { - "type": "string", - "description": "Id of an item of a qualification" - } - }, - "allOf": [ - { - "$ref": "EntityRef.schema.json#/EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QualificationRef.schema.json", + "title": "QualificationRef", + "definitions": { + "QualificationRef": { + "$id": "#QualificationRef", + "type": "object", + "description": "It could be a serviceQualification or a productOfferingQualification that has been executed previously and captured in the productOrder to provide eligibility information", + "properties": { + "qualificationItemId": { + "type": "string", + "description": "Id of an item of a qualification" } + }, + "allOf": [ + { + "$ref": "EntityRef.schema.json#EntityRef" + } + ] } + } } \ No newline at end of file diff --git a/Common/Quantity.schema.json b/Common/Quantity.schema.json index 0dbbb17d..31947f52 100644 --- a/Common/Quantity.schema.json +++ b/Common/Quantity.schema.json @@ -1,24 +1,24 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Quantity.schema.json", - "title": "Quantity", - "definitions": { - "Quantity": { - "$id": "#Quantity", - "type": "object", - "description": "An amount in a given unit", - "properties": { - "amount": { - "type": "number", - "format": "float", - "default": 1, - "description": "Numeric value in a given unit" - }, - "units": { - "type": "string", - "description": "Unit" - } - } - } - } -} +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Quantity.schema.json", + "title": "Quantity", + "definitions": { + "Quantity": { + "$id": "#Quantity", + "type": "object", + "description": "An amount in a given unit", + "properties": { + "amount": { + "type": "number", + "format": "float", + "default": 1, + "description": "Numeric value in a given unit" + }, + "units": { + "type": "string", + "description": "Unit" + } + } + } + } +} \ No newline at end of file diff --git a/Common/QuantityType.schema.json b/Common/QuantityType.schema.json index f21022ae..a24291a3 100644 --- a/Common/QuantityType.schema.json +++ b/Common/QuantityType.schema.json @@ -1,25 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuantityType.schema.json", - "title": "QuantityType", - "definitions": { - "QuantityType": { - "description": "Representation of a quantity of something. I can also be used to represent a quantity range", - "properties": { - "amount": { - "type": "number", - "format": "decimal", - "description": "Measured amount" - }, - "units": { - "type": "string", - "description": "Units the quantity is measured in" - } - }, - "required": [ - "units", - "amount" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuantityType.schema.json", + "title": "QuantityType", + "definitions": { + "QuantityType": { + "$id": "#QuantityType", + "description": "Representation of a quantity of something. I can also be used to represent a quantity range", + "properties": { + "amount": { + "type": "number", + "format": "decimal", + "description": "Measured amount" + }, + "units": { + "type": "string", + "description": "Units the quantity is measured in" } + }, + "required": [ + "units", + "amount" + ], + "type": "object" } + } } \ No newline at end of file diff --git a/Common/RatedProductUsage.schema.json b/Common/RatedProductUsage.schema.json index 1d0837c4..ca2a91f4 100644 --- a/Common/RatedProductUsage.schema.json +++ b/Common/RatedProductUsage.schema.json @@ -1,72 +1,72 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RatedProductUsage.schema.json", - "title": "RatedProductUsage", - "definitions": { - "RatedProductUsage": { - "$id": "#RatedProductUsage", - "description": "An occurrence of employing a product for its intended purpose with all rating details", - "type": "object", - "properties": { - "bucketValueConvertedInAmount": { - "type": "number", - "format": "float", - "description": "Monetary value of bucket" - }, - "currencyCode": { - "type": "string", - "description": "A string used as a code for specifying the currency associated to the given amounts. The ISO4217 norm uses 3 letters to define the currency (for example USD for US dollar or EUR for Euro)" - }, - "isBilled": { - "type": "boolean", - "description": "Boolean indicating if usage have been billed or not" - }, - "isTaxExempt": { - "type": "boolean", - "description": "Indicates if the rated amount is exempt of tax" - }, - "offerTariffType": { - "type": "string", - "description": "Type of tariff applied" - }, - "productRef": { - "type": "string", - "description": "Reference of product specification" - }, - "ratingAmountType": { - "type": "string", - "description": "Type of amount" - }, - "ratingDate": { - "type": "string", - "format": "date-time", - "description": "Date of usage rating" - }, - "taxExcludedRatingAmount": { - "type": "number", - "format": "float", - "description": "All taxes excluded rated amount" - }, - "taxIncludedRatingAmount": { - "type": "number", - "format": "float", - "description": "All taxes included rated amount" - }, - "taxRate": { - "type": "number", - "format": "float", - "description": "Tax rate" - }, - "usageRatingTag": { - "type": "string", - "description": "Tag value: [usage]: the usage is always rated outside a usage bundle\n[included usage]: the usage is rated inside a usage bundle\n[non included usage]: the usage bundle is exhausted. The usage is rated outside the usage bundle" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RatedProductUsage.schema.json", + "title": "RatedProductUsage", + "definitions": { + "RatedProductUsage": { + "$id": "#RatedProductUsage", + "description": "An occurrence of employing a product for its intended purpose with all rating details", + "type": "object", + "properties": { + "bucketValueConvertedInAmount": { + "type": "number", + "format": "float", + "description": "Monetary value of bucket" + }, + "currencyCode": { + "type": "string", + "description": "A string used as a code for specifying the currency associated to the given amounts. The ISO4217 norm uses 3 letters to define the currency (for example USD for US dollar or EUR for Euro)" + }, + "isBilled": { + "type": "boolean", + "description": "Boolean indicating if usage have been billed or not" + }, + "isTaxExempt": { + "type": "boolean", + "description": "Indicates if the rated amount is exempt of tax" + }, + "offerTariffType": { + "type": "string", + "description": "Type of tariff applied" + }, + "productRef": { + "type": "string", + "description": "Reference of product specification" + }, + "ratingAmountType": { + "type": "string", + "description": "Type of amount" + }, + "ratingDate": { + "type": "string", + "format": "date-time", + "description": "Date of usage rating" + }, + "taxExcludedRatingAmount": { + "type": "number", + "format": "float", + "description": "All taxes excluded rated amount" + }, + "taxIncludedRatingAmount": { + "type": "number", + "format": "float", + "description": "All taxes included rated amount" + }, + "taxRate": { + "type": "number", + "format": "float", + "description": "Tax rate" + }, + "usageRatingTag": { + "type": "string", + "description": "Tag value: [usage]: the usage is always rated outside a usage bundle\n[included usage]: the usage is rated inside a usage bundle\n[non included usage]: the usage bundle is exhausted. The usage is rated outside the usage bundle" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Receiver.schema.json b/Common/Receiver.schema.json index a63ed526..03687cf8 100644 --- a/Common/Receiver.schema.json +++ b/Common/Receiver.schema.json @@ -1,46 +1,46 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Receiver.schema.json", - "title": "Receiver", - "definitions": { - "Receiver": { - "$id": "#Receiver", - "description": "Receivers of the communication message.", - "type": "object", - "properties": { - "appUserId": { - "type": "string", - "description": "ID of the mobile app user" - }, - "email": { - "type": "string", - "description": "Receiver address of email, if the communication type is email" - }, - "id": { - "type": "string", - "description": "ID of the receiver" - }, - "ip": { - "type": "string", - "description": "IP address of the receiver" - }, - "name": { - "type": "string", - "description": "Name of the receiver" - }, - "phoneNumber": { - "type": "string", - "description": "Phone number of the receiver, if the communication type is SMS." - }, - "party": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Receiver.schema.json", + "title": "Receiver", + "definitions": { + "Receiver": { + "$id": "#Receiver", + "description": "Receivers of the communication message.", + "type": "object", + "properties": { + "appUserId": { + "type": "string", + "description": "ID of the mobile app user" + }, + "email": { + "type": "string", + "description": "Receiver address of email, if the communication type is email" + }, + "id": { + "type": "string", + "description": "ID of the receiver" + }, + "ip": { + "type": "string", + "description": "IP address of the receiver" + }, + "name": { + "type": "string", + "description": "Name of the receiver" + }, + "phoneNumber": { + "type": "string", + "description": "Phone number of the receiver, if the communication type is SMS." + }, + "party": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/ReceiverRef.schema.json b/Common/ReceiverRef.schema.json index 000c8fd5..4dd7bd25 100644 --- a/Common/ReceiverRef.schema.json +++ b/Common/ReceiverRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ReceiverRef.schema.json", - "title": "ReceiverRef", - "definitions": { - "ReceiverRef": { - "$id": "#ReceiverRef", - "description": "Receiver reference. The receiver is the party role who will receive the settlement note.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the receiver" - }, - "id": { - "type": "string", - "description": "Identifier of the receiver" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ReceiverRef.schema.json", + "title": "ReceiverRef", + "definitions": { + "ReceiverRef": { + "$id": "#ReceiverRef", + "description": "Receiver reference. The receiver is the party role who will receive the settlement note.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the receiver" + }, + "id": { + "type": "string", + "description": "Identifier of the receiver" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Record.schema.json b/Common/Record.schema.json index fc85ff89..bde25712 100644 --- a/Common/Record.schema.json +++ b/Common/Record.schema.json @@ -1,32 +1,32 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Record.schema.json", - "title": "Record", - "definitions": { - "Record": { - "$id": "#Record", - "description": "A record in a worklog.", - "type": "object", - "properties": { - "dateTime": { - "type": "string", - "format": "date-time", - "description": "The date time that a record is generated." - }, - "description": { - "type": "string", - "description": "The detail description in a record." - }, - "supportPerson": { - "type": "string", - "description": "The person who logged that record." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Record.schema.json", + "title": "Record", + "definitions": { + "Record": { + "$id": "#Record", + "description": "A record in a worklog.", + "type": "object", + "properties": { + "dateTime": { + "type": "string", + "format": "date-time", + "description": "The date time that a record is generated." + }, + "description": { + "type": "string", + "description": "The detail description in a record." + }, + "supportPerson": { + "type": "string", + "description": "The person who logged that record." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/RelatedChangeRequestRef.schema.json b/Common/RelatedChangeRequestRef.schema.json index a64e4c15..9e446655 100644 --- a/Common/RelatedChangeRequestRef.schema.json +++ b/Common/RelatedChangeRequestRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedChangeRequestRef.schema.json", - "title": "RelatedChangeRequestRef", - "definitions": { - "RelatedChangeRequestRef": { - "$id": "#RelatedChangeRequestRef", - "description": "An existing Change Request that has some form of correlation with the given Change Request.", - "type": "object", - "properties": { - "correlation": { - "type": "string", - "description": "The correlation between two change requests" - }, - "description": { - "type": "string", - "description": "Description of a change request." - }, - "href": { - "type": "string", - "description": "Hyper link to access a change request." - }, - "id": { - "type": "string", - "description": "Identifier of an Change Request" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedChangeRequestRef.schema.json", + "title": "RelatedChangeRequestRef", + "definitions": { + "RelatedChangeRequestRef": { + "$id": "#RelatedChangeRequestRef", + "description": "An existing Change Request that has some form of correlation with the given Change Request.", + "type": "object", + "properties": { + "correlation": { + "type": "string", + "description": "The correlation between two change requests" + }, + "description": { + "type": "string", + "description": "Description of a change request." + }, + "href": { + "type": "string", + "description": "Hyper link to access a change request." + }, + "id": { + "type": "string", + "description": "Identifier of an Change Request" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/RelatedChannel.schema.json b/Common/RelatedChannel.schema.json index 7210b623..ef4b080f 100644 --- a/Common/RelatedChannel.schema.json +++ b/Common/RelatedChannel.schema.json @@ -1,26 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedChannel.schema.json", - "title": "RelatedChannel", - "definitions": { - "RelatedChannel": { - "type": "object", - "description": "Related channel to another entity. May be online web, mobile app, social ,etc.", - "properties": { - "name": { - "type": "string", - "description": "Name of the channel." - }, - "role": { - "type": "string", - "description": "Role playing by the channel." - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#/EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedChannel.schema.json", + "title": "RelatedChannel", + "definitions": { + "RelatedChannel": { + "$id": "#RelatedChannel", + "type": "object", + "description": "Related channel to another entity. May be online web, mobile app, social ,etc.", + "properties": { + "name": { + "type": "string", + "description": "Name of the channel." + }, + "role": { + "type": "string", + "description": "Role playing by the channel." } + }, + "allOf": [ + { + "$ref": "EntityRef.schema.json#EntityRef" + } + ] } + } } \ No newline at end of file diff --git a/Common/RelatedEntity.schema.json b/Common/RelatedEntity.schema.json index 3e844982..b8dcac70 100644 --- a/Common/RelatedEntity.schema.json +++ b/Common/RelatedEntity.schema.json @@ -1,28 +1,28 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedEntity.schema.json", - "title": "RelatedEntity", - "definitions": { - "RelatedEntity": { - "$id": "#RelatedEntity", - "description": "A reference to an entity, where the type of the entity is not known in advance.", - "type": "object", - "required" : [ - "id", - "role", - "@referredType" - ], - "properties": { - "role": { - "type": "string", - "description": "The role of an entity." - } - }, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedEntity.schema.json", + "title": "RelatedEntity", + "definitions": { + "RelatedEntity": { + "$id": "#RelatedEntity", + "description": "A reference to an entity, where the type of the entity is not known in advance.", + "type": "object", + "required": [ + "id", + "role", + "@referredType" + ], + "properties": { + "role": { + "type": "string", + "description": "The role of an entity." } + }, + "allOf": [ + { + "$ref": "EntityRef.schema.json#EntityRef" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/RelatedEntityRef.schema.json b/Common/RelatedEntityRef.schema.json index 71b9b2ea..d64ea908 100644 --- a/Common/RelatedEntityRef.schema.json +++ b/Common/RelatedEntityRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedEntityRef.schema.json", - "title": "RelatedEntityRef", - "definitions": { - "RelatedEntityRef": { - "$id": "#RelatedEntityRef", - "description": "A reference to an entity, where the type of the entity is not known in advance.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The hyperlink to access an entity." - }, - "id": { - "type": "string", - "description": "The identifier of an entity." - }, - "name": { - "type": "string", - "description": "The name of an entity." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedEntityRef.schema.json", + "title": "RelatedEntityRef", + "definitions": { + "RelatedEntityRef": { + "$id": "#RelatedEntityRef", + "description": "A reference to an entity, where the type of the entity is not known in advance.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The hyperlink to access an entity." + }, + "id": { + "type": "string", + "description": "The identifier of an entity." + }, + "name": { + "type": "string", + "description": "The name of an entity." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/RelatedGeographicLocationRefOrValue.schema.json b/Common/RelatedGeographicLocationRefOrValue.schema.json index b621c6d8..d28e6ba4 100644 --- a/Common/RelatedGeographicLocationRefOrValue.schema.json +++ b/Common/RelatedGeographicLocationRefOrValue.schema.json @@ -1,32 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedGeographicLocationRefOrValue.schema.json", - "title": "RelatedGeographicLocationRefOrValue", - "definitions": { - "RelatedGeographicLocationRefOrValue": { - "discriminator": "isRef", - "$id": "#RelatedGeographicLocationRefOrValue", - "description": "#TODO", - "type": "object", - "properties": { - "isRef": { - "type": "boolean", - "default": true - - }, - "role":{ - "type": "string" - } - }, - "required": [ - "role" - ], - "allOf": [ - { - "$ref": "RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" - } - - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedGeographicLocationRefOrValue.schema.json", + "title": "RelatedGeographicLocationRefOrValue", + "definitions": { + "RelatedGeographicLocationRefOrValue": { + "discriminator": "isRef", + "$id": "#RelatedGeographicLocationRefOrValue", + "description": "#TODO", + "type": "object", + "properties": { + "isRef": { + "type": "boolean", + "default": true + }, + "role": { + "type": "string" } + }, + "required": [ + "role" + ], + "allOf": [ + { + "$ref": "RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" + } + ] } - } \ No newline at end of file + } +} \ No newline at end of file diff --git a/Common/RelatedObject.schema.json b/Common/RelatedObject.schema.json index 51e905e1..fe941c74 100644 --- a/Common/RelatedObject.schema.json +++ b/Common/RelatedObject.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedObject.schema.json", - "title": "RelatedObject", - "definitions": { - "RelatedObject": { - "$id": "#RelatedObject", - "description": "Defines objects linked with trouble ticket.", - "type": "object", - "properties": { - "involvement": { - "type": "string", - "description": "Consequence of the ticket on the related object (for instance disputed, adjusted...)" - }, - "reference": { - "type": "string", - "description": "Reference of object" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedObject.schema.json", + "title": "RelatedObject", + "definitions": { + "RelatedObject": { + "$id": "#RelatedObject", + "description": "Defines objects linked with trouble ticket.", + "type": "object", + "properties": { + "involvement": { + "type": "string", + "description": "Consequence of the ticket on the related object (for instance disputed, adjusted...)" + }, + "reference": { + "type": "string", + "description": "Reference of object" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/RelatedPlace.schema.json b/Common/RelatedPlace.schema.json index e291ad1c..e02be4b3 100644 --- a/Common/RelatedPlace.schema.json +++ b/Common/RelatedPlace.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedPlace.schema.json", - "title": "RelatedPlace", - "definitions": { - "RelatedPlace": { - "$id": "#RelatedPlace", - "description": "A Place and an associated role as installation adress, delivery address, etc....", - "type": "object", - "properties": { - "role": { - "type": "string", - "description": "Role of the place, such as: [home delivery], [shop retrieval])" - }, - "href": { - "type": "string", - "description": "Unique reference of the place" - }, - "id": { - "type": "string", - "description": "Unique identifier of the place" - }, - "name": { - "type": "string", - "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedPlace.schema.json", + "title": "RelatedPlace", + "definitions": { + "RelatedPlace": { + "$id": "#RelatedPlace", + "description": "A Place and an associated role as installation adress, delivery address, etc....", + "type": "object", + "properties": { + "role": { + "type": "string", + "description": "Role of the place, such as: [home delivery], [shop retrieval])" + }, + "href": { + "type": "string", + "description": "Unique reference of the place" + }, + "id": { + "type": "string", + "description": "Unique identifier of the place" + }, + "name": { + "type": "string", + "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Request.schema.json b/Common/Request.schema.json index 3a78932c..dbc629f0 100644 --- a/Common/Request.schema.json +++ b/Common/Request.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Request.schema.json", - "title": "Request", - "definitions": { - "Request": { - "$id": "#Request", - "type": "object", - "description": "A response to a request", - "properties": { - "body": { - "description": "The body of the request. For example for an HTTP request might contain content of a form .", - "type": "string" - }, - "header": { - "type": "array", - "description": "Items included in the header of the request. For example for an HTTP request might contain requested locale, basic authentication.", - "items": { - "$ref": "HeaderItem.schema.json#/definitions/HeaderItem" - }, - "title": "header" - }, - "method": { - "description": "The protocol of the request, e.g. http", - "type": "string" - }, - "to": { - "description": "The target of the request, e.g. a URL for an HTTP request", - "type": "string" - } - }, - "required": [ - "body", - "header" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Request.schema.json", + "title": "Request", + "definitions": { + "Request": { + "$id": "#Request", + "type": "object", + "description": "A response to a request", + "properties": { + "body": { + "description": "The body of the request. For example for an HTTP request might contain content of a form .", + "type": "string" + }, + "header": { + "type": "array", + "description": "Items included in the header of the request. For example for an HTTP request might contain requested locale, basic authentication.", + "items": { + "$ref": "HeaderItem.schema.json#HeaderItem" + }, + "title": "header" + }, + "method": { + "description": "The protocol of the request, e.g. http", + "type": "string" + }, + "to": { + "description": "The target of the request, e.g. a URL for an HTTP request", + "type": "string" } + }, + "required": [ + "body", + "header" + ] } -} + } +} \ No newline at end of file diff --git a/Common/Resolution.schema.json b/Common/Resolution.schema.json index 217492ec..0d9ccddf 100644 --- a/Common/Resolution.schema.json +++ b/Common/Resolution.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Resolution.schema.json", - "title": "Resolution", - "definitions": { - "Resolution": { - "$id": "#Resolution", - "description": "The way one or more change request has been implementation through a direct remedy or task", - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The resolutions code, it can be configured as a multiple level hierarchy" - }, - "description": { - "type": "string", - "description": "The description of the resolution" - }, - "name": { - "type": "string", - "description": "The name of the resolution" - }, - "task": { - "type": "array", - "items": { - "$ref": "Task.schema.json#Task" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Resolution.schema.json", + "title": "Resolution", + "definitions": { + "Resolution": { + "$id": "#Resolution", + "description": "The way one or more change request has been implementation through a direct remedy or task", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The resolutions code, it can be configured as a multiple level hierarchy" + }, + "description": { + "type": "string", + "description": "The description of the resolution" + }, + "name": { + "type": "string", + "description": "The name of the resolution" + }, + "task": { + "type": "array", + "items": { + "$ref": "Task.schema.json#Task" + } } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Response.schema.json b/Common/Response.schema.json index 79adcf5e..44014a32 100644 --- a/Common/Response.schema.json +++ b/Common/Response.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Response.schema.json", - "title": "Response", - "definitions": { - "Response": { - "$id": "#Response", - "type": "object", - "description": "A response to a request", - "properties": { - "body": { - "description": "The body of the response. For example for an HTTP response might contain HTML for rendering.", - "type": "string" - }, - "header": { - "description": "Items included in the header of the response. For example for an HTTP response might contain negotiated locale.", - "type": "array", - "items": { - "$ref": "HeaderItem.schema.json#/definitions/HeaderItem" - }, - "title": "header" - }, - "statusCode": { - "description": "The status of the response. For example for an HTTP response would be codes such as 200, 400, etc.", - "type": "string" - } - }, - "required": [ - "body", - "header" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Response.schema.json", + "title": "Response", + "definitions": { + "Response": { + "$id": "#Response", + "type": "object", + "description": "A response to a request", + "properties": { + "body": { + "description": "The body of the response. For example for an HTTP response might contain HTML for rendering.", + "type": "string" + }, + "header": { + "description": "Items included in the header of the response. For example for an HTTP response might contain negotiated locale.", + "type": "array", + "items": { + "$ref": "HeaderItem.schema.json#HeaderItem" + }, + "title": "header" + }, + "statusCode": { + "description": "The status of the response. For example for an HTTP response would be codes such as 200, 400, etc.", + "type": "string" } + }, + "required": [ + "body", + "header" + ] } -} + } +} \ No newline at end of file diff --git a/Common/RetrieveGeographicLocation.schema.json b/Common/RetrieveGeographicLocation.schema.json index 39a55cbe..8e09cc7b 100644 --- a/Common/RetrieveGeographicLocation.schema.json +++ b/Common/RetrieveGeographicLocation.schema.json @@ -1,41 +1,41 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RetrieveGeographicLocation.schema.json", - "title": "RetrieveGeographicLocation", - "definitions": { - "RetrieveGeographicLocation": { - "$id": "#RetrieveGeographicLocation", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "id": { - "type": "string" - }, - "requestedAccuracy": { - "type": "number", - "format": "float" - }, - "status": { - "type": "string" - }, - "time": { - "type": "string", - "format": "date-time" - }, - "geographicLocation": { - "$ref": "GeographicLocation.schema.json#GeographicLocation" - }, - "thing": { - "$ref": "Object.schema.json#Object" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RetrieveGeographicLocation.schema.json", + "title": "RetrieveGeographicLocation", + "definitions": { + "RetrieveGeographicLocation": { + "$id": "#RetrieveGeographicLocation", + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "id": { + "type": "string" + }, + "requestedAccuracy": { + "type": "number", + "format": "float" + }, + "status": { + "type": "string" + }, + "time": { + "type": "string", + "format": "date-time" + }, + "geographicLocation": { + "$ref": "GeographicLocation.schema.json#GeographicLocation" + }, + "thing": { + "$ref": "Object.schema.json#Object" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/RetrieveLocationRelation.schema.json b/Common/RetrieveLocationRelation.schema.json index 1b5c53f6..667b9ee1 100644 --- a/Common/RetrieveLocationRelation.schema.json +++ b/Common/RetrieveLocationRelation.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RetrieveLocationRelation.schema.json", - "title": "RetrieveLocationRelation", - "definitions": { - "RetrieveLocationRelation": { - "$id": "#RetrieveLocationRelation", - "type": "object", - "properties": { - "distance": { - "type": "string" - }, - "href": { - "type": "string" - }, - "id": { - "type": "string" - }, - "status": { - "type": "string" - }, - "time": { - "type": "string", - "format": "date-time" - }, - "intersection": { - "type": "array", - "items": { - "$ref": "GeographicLocation.schema.json#GeographicLocation" - } - }, - "location": { - "$ref": "GeographicLocationRef.schema.json#GeographicLocationRef" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RetrieveLocationRelation.schema.json", + "title": "RetrieveLocationRelation", + "definitions": { + "RetrieveLocationRelation": { + "$id": "#RetrieveLocationRelation", + "type": "object", + "properties": { + "distance": { + "type": "string" + }, + "href": { + "type": "string" + }, + "id": { + "type": "string" + }, + "status": { + "type": "string" + }, + "time": { + "type": "string", + "format": "date-time" + }, + "intersection": { + "type": "array", + "items": { + "$ref": "GeographicLocation.schema.json#GeographicLocation" + } + }, + "location": { + "$ref": "GeographicLocationRef.schema.json#GeographicLocationRef" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Sender.schema.json b/Common/Sender.schema.json index b5f0d6a5..500c4049 100644 --- a/Common/Sender.schema.json +++ b/Common/Sender.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Sender.schema.json", - "title": "Sender", - "definitions": { - "Sender": { - "$id": "#Sender", - "description": "Sender of the communication message.", - "type": "object", - "properties": { - "email": { - "type": "string", - "description": "Sender address of email, if the communication type is email" - }, - "id": { - "type": "string", - "description": "ID of the sender" - }, - "name": { - "type": "string", - "description": "Name of the sender" - }, - "phoneNumber": { - "type": "string", - "description": "Phone number of the sender, if the communication type is SMS." - }, - "party": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Sender.schema.json", + "title": "Sender", + "definitions": { + "Sender": { + "$id": "#Sender", + "description": "Sender of the communication message.", + "type": "object", + "properties": { + "email": { + "type": "string", + "description": "Sender address of email, if the communication type is email" + }, + "id": { + "type": "string", + "description": "ID of the sender" + }, + "name": { + "type": "string", + "description": "Name of the sender" + }, + "phoneNumber": { + "type": "string", + "description": "Phone number of the sender, if the communication type is SMS." + }, + "party": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/SiteRelationship.schema.json b/Common/SiteRelationship.schema.json index ef328a2e..92fd3be6 100644 --- a/Common/SiteRelationship.schema.json +++ b/Common/SiteRelationship.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SiteRelationship.schema.json", - "title": "SiteRelationship", - "definitions": { - "SiteRelationship": { - "$id": "#SiteRelationship", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the related site" - }, - "id": { - "type": "string", - "description": "Unique identifier of the related site entity within the server" - }, - "role": { - "type": "string", - "description": "Role of the related site in the relationship" - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "Validity for the relationship" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SiteRelationship.schema.json", + "title": "SiteRelationship", + "definitions": { + "SiteRelationship": { + "$id": "#SiteRelationship", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the related site" + }, + "id": { + "type": "string", + "description": "Unique identifier of the related site entity within the server" + }, + "role": { + "type": "string", + "description": "Role of the related site in the relationship" + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "Validity for the relationship" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/SpecCharRelationship.schema.json b/Common/SpecCharRelationship.schema.json index cd47a1cd..828f907c 100644 --- a/Common/SpecCharRelationship.schema.json +++ b/Common/SpecCharRelationship.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SpecCharRelationship.schema.json", - "title": "SpecCharRelationship", - "definitions": { - "SpecCharRelationship": { - "$id": "#SpecCharRelationship", - "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink reference to the target entity specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the target entity specification" - }, - "name": { - "type": "string", - "description": "Name of the target specCharacteristic" - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which the SpecCharRelationship is valid" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SpecCharRelationship.schema.json", + "title": "SpecCharRelationship", + "definitions": { + "SpecCharRelationship": { + "$id": "#SpecCharRelationship", + "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink reference to the target entity specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the target entity specification" + }, + "name": { + "type": "string", + "description": "Name of the target specCharacteristic" + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which the SpecCharRelationship is valid" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/SpecCharacteristic.schema.json b/Common/SpecCharacteristic.schema.json index 044a8d0c..7875d3ee 100644 --- a/Common/SpecCharacteristic.schema.json +++ b/Common/SpecCharacteristic.schema.json @@ -1,51 +1,51 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SpecCharacteristic.schema.json", - "title": "SpecCharacteristic", - "definitions": { - "SpecCharacteristic": { - "$id": "#SpecCharacteristic", - "description": "A characteristic quality or distinctive feature of a Specification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", - "type": "object", - "properties": { - "configurable": { - "type": "boolean", - "description": "If true, the Boolean indicates that the SpecCharacteristic is configurable" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the SpecCharacteristic is" - }, - "name": { - "type": "string", - "description": "Name of the SpecCharacteristic" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productSpecCharacteristic is valid" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" - }, - "specCharacteristicValue": { - "type": "array", - "items": { - "$ref": "SpecCharacteristicValue.schema.json#SpecCharacteristicValue" - } - }, - "specCharRelationship": { - "type": "array", - "items": { - "$ref": "SpecCharRelationship.schema.json#SpecCharRelationship" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SpecCharacteristic.schema.json", + "title": "SpecCharacteristic", + "definitions": { + "SpecCharacteristic": { + "$id": "#SpecCharacteristic", + "description": "A characteristic quality or distinctive feature of a Specification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", + "type": "object", + "properties": { + "configurable": { + "type": "boolean", + "description": "If true, the Boolean indicates that the SpecCharacteristic is configurable" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the SpecCharacteristic is" + }, + "name": { + "type": "string", + "description": "Name of the SpecCharacteristic" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productSpecCharacteristic is valid" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" + }, + "specCharacteristicValue": { + "type": "array", + "items": { + "$ref": "SpecCharacteristicValue.schema.json#SpecCharacteristicValue" + } + }, + "specCharRelationship": { + "type": "array", + "items": { + "$ref": "SpecCharRelationship.schema.json#SpecCharRelationship" + } } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/SpecCharacteristicValue.schema.json b/Common/SpecCharacteristicValue.schema.json index 3f53c434..3bb3d55f 100644 --- a/Common/SpecCharacteristicValue.schema.json +++ b/Common/SpecCharacteristicValue.schema.json @@ -1,55 +1,55 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SpecCharacteristicValue.schema.json", - "title": "SpecCharacteristicValue", - "definitions": { - "SpecCharacteristicValue": { - "$id": "#SpecCharacteristicValue", - "description": "A number or text that can be assigned to a SpecCharacteristic", - "type": "object", - "properties": { - "isDefault": { - "type": "boolean", - "description": "If true, the Boolean Indicates if the value is the default value for a characteristic" - }, - "rangeInterval": { - "type": "string", - "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." - }, - "regex": { - "type": "string", - "description": "A regular expression constraint for given value" - }, - "unitOfMeasure": { - "type": "string", - "description": "unit of measure for the valueCould be minutes, GB, etc" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which this object is valid" - }, - "value": { - "$ref": "Object.schema.json#Object", - "description": "the value that the characteristic can take on." - }, - "valueFrom": { - "type": "integer", - "description": "The low range value that a characteristic can take on" - }, - "valueTo": { - "type": "integer", - "description": "The upper range value that a characteristic can take on" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic value can take on, such as numeric, text and so forth" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SpecCharacteristicValue.schema.json", + "title": "SpecCharacteristicValue", + "definitions": { + "SpecCharacteristicValue": { + "$id": "#SpecCharacteristicValue", + "description": "A number or text that can be assigned to a SpecCharacteristic", + "type": "object", + "properties": { + "isDefault": { + "type": "boolean", + "description": "If true, the Boolean Indicates if the value is the default value for a characteristic" + }, + "rangeInterval": { + "type": "string", + "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." + }, + "regex": { + "type": "string", + "description": "A regular expression constraint for given value" + }, + "unitOfMeasure": { + "type": "string", + "description": "unit of measure for the valueCould be minutes, GB, etc" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which this object is valid" + }, + "value": { + "$ref": "Object.schema.json#Object", + "description": "the value that the characteristic can take on." + }, + "valueFrom": { + "type": "integer", + "description": "The low range value that a characteristic can take on" + }, + "valueTo": { + "type": "integer", + "description": "The upper range value that a characteristic can take on" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic value can take on, such as numeric, text and so forth" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/StatusChange.schema.json b/Common/StatusChange.schema.json index 7e56a88c..f2d23f89 100644 --- a/Common/StatusChange.schema.json +++ b/Common/StatusChange.schema.json @@ -1,32 +1,32 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "StatusChange.schema.json", - "title": "StatusChange", - "definitions": { - "StatusChange": { - "type": "object", - "description": "Holds the status notification reasons and associated date the status changed, populated by the server", - "properties": { - - "changeDate": { - "type": "string", - "format": "date-time", - "description": "The date and time the status changed." - }, - "changeReason": { - "type": "string", - "description": "The reason why the status changed." - }, - "status": { - "type": "string", - "description": "The status of the trouble ticket" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#/Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "StatusChange.schema.json", + "title": "StatusChange", + "definitions": { + "StatusChange": { + "$id": "#StatusChange", + "type": "object", + "description": "Holds the status notification reasons and associated date the status changed, populated by the server", + "properties": { + "changeDate": { + "type": "string", + "format": "date-time", + "description": "The date and time the status changed." + }, + "changeReason": { + "type": "string", + "description": "The reason why the status changed." + }, + "status": { + "type": "string", + "description": "The status of the trouble ticket" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Street.schema.json b/Common/Street.schema.json index 76079cc7..a9f08b34 100644 --- a/Common/Street.schema.json +++ b/Common/Street.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Street.schema.json", - "title": "Street", - "definitions": { - "Street": { - "$id": "#Street", - "description": "A street is a road in a city or locality that has buildings that are usually close together along one or both sides", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the Street" - }, - "name": { - "type": "string", - "description": "The defined name of the street" - }, - "streetType": { - "type": "string", - "description": "Alley, avenue, etc." - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "LocationCharacteristic.schema.json#LocationCharacteristic" - } - }, - "address": { - "type": "array", - "items": { - "$ref": "AddressRef.schema.json#AddressRef" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Street.schema.json", + "title": "Street", + "definitions": { + "Street": { + "$id": "#Street", + "description": "A street is a road in a city or locality that has buildings that are usually close together along one or both sides", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the Street" + }, + "name": { + "type": "string", + "description": "The defined name of the street" + }, + "streetType": { + "type": "string", + "description": "Alley, avenue, etc." + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "LocationCharacteristic.schema.json#LocationCharacteristic" + } + }, + "address": { + "type": "array", + "items": { + "$ref": "AddressRef.schema.json#AddressRef" + } } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/StreetSegment.schema.json b/Common/StreetSegment.schema.json index 3a0789b3..5e770d09 100644 --- a/Common/StreetSegment.schema.json +++ b/Common/StreetSegment.schema.json @@ -1,42 +1,42 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "StreetSegment.schema.json", - "title": "StreetSegment", - "definitions": { - "StreetSegment": { - "$id": "#StreetSegment", - "description": "StreetSegment corresponds to a part of a street referenced by a number or a set of number. Sometimes a suffix is added.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the Street Segment" - }, - "number": { - "type": "string", - "description": "number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" - }, - "numberLast": { - "type": "string", - "description": "the last number in a range of street numbers allocated to a property" - }, - "numberLastSuffix": { - "type": "string", - "description": "the last street number suffix for a ranged address" - }, - "numberSuffix": { - "type": "string", - "description": "the first street number suffix" - }, - "address": { - "$ref": "AddressRef.schema.json#AddressRef" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "StreetSegment.schema.json", + "title": "StreetSegment", + "definitions": { + "StreetSegment": { + "$id": "#StreetSegment", + "description": "StreetSegment corresponds to a part of a street referenced by a number or a set of number. Sometimes a suffix is added.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the Street Segment" + }, + "number": { + "type": "string", + "description": "number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" + }, + "numberLast": { + "type": "string", + "description": "the last number in a range of street numbers allocated to a property" + }, + "numberLastSuffix": { + "type": "string", + "description": "the last street number suffix for a ranged address" + }, + "numberSuffix": { + "type": "string", + "description": "the first street number suffix" + }, + "address": { + "$ref": "AddressRef.schema.json#AddressRef" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/SubAddress.schema.json b/Common/SubAddress.schema.json index a3876c51..11340c5a 100644 --- a/Common/SubAddress.schema.json +++ b/Common/SubAddress.schema.json @@ -1,62 +1,62 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SubAddress.schema.json", - "title": "SubAddress", - "definitions": { - "SubAddress": { - "$id": "#SubAddress", - "description": "Representation of a SubAddress \nIt is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.", - "type": "object", - "properties": { - "buildingName": { - "type": "string", - "description": "Allows for buildings that have well-known names" - }, - "href": { - "type": "string" - }, - "id": { - "type": "string", - "description": "Unique ID for this SubAddress" - }, - "levelNumber": { - "type": "string", - "description": "Used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2" - }, - "levelType": { - "type": "string", - "description": "Describes level types within a building" - }, - "name": { - "type": "string", - "description": "Name of the subAddress to identify it with a meaningful identification" - }, - "privateStreetName": { - "type": "string", - "description": "Private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office." - }, - "privateStreetNumber": { - "type": "string", - "description": "Private streets numbers internal to a private street" - }, - "subUnitNumber": { - "type": "string", - "description": "The discriminator of the subunit, often just a simple number e.g. FLAT 5, may also be a range" - }, - "subUnitType": { - "type": "string", - "description": "The type of subunit, such as BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF" - }, - "subAddressType": { - "type": "string", - "description": "The type of subaddress : it can be a subunit or a private street" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SubAddress.schema.json", + "title": "SubAddress", + "definitions": { + "SubAddress": { + "$id": "#SubAddress", + "description": "Representation of a SubAddress \nIt is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.", + "type": "object", + "properties": { + "buildingName": { + "type": "string", + "description": "Allows for buildings that have well-known names" + }, + "href": { + "type": "string" + }, + "id": { + "type": "string", + "description": "Unique ID for this SubAddress" + }, + "levelNumber": { + "type": "string", + "description": "Used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2" + }, + "levelType": { + "type": "string", + "description": "Describes level types within a building" + }, + "name": { + "type": "string", + "description": "Name of the subAddress to identify it with a meaningful identification" + }, + "privateStreetName": { + "type": "string", + "description": "Private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office." + }, + "privateStreetNumber": { + "type": "string", + "description": "Private streets numbers internal to a private street" + }, + "subUnitNumber": { + "type": "string", + "description": "The discriminator of the subunit, often just a simple number e.g. FLAT 5, may also be a range" + }, + "subUnitType": { + "type": "string", + "description": "The type of subunit, such as BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF" + }, + "subAddressType": { + "type": "string", + "description": "The type of subaddress : it can be a subunit or a private street" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/TargetEntityRef.schema.json b/Common/TargetEntityRef.schema.json index 2f24a9e0..801abf74 100644 --- a/Common/TargetEntityRef.schema.json +++ b/Common/TargetEntityRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TargetEntityRef.schema.json", - "title": "TargetEntityRef", - "definitions": { - "TargetEntityRef": { - "$id": "#TargetEntityRef", - "description": "The entity which will be changed or configured while the change request is executed.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description to the related party." - }, - "href": { - "type": "string", - "description": "Hyperlink to access the target entity." - }, - "id": { - "type": "string", - "description": "Identifier of target entity" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TargetEntityRef.schema.json", + "title": "TargetEntityRef", + "definitions": { + "TargetEntityRef": { + "$id": "#TargetEntityRef", + "description": "The entity which will be changed or configured while the change request is executed.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description to the related party." + }, + "href": { + "type": "string", + "description": "Hyperlink to access the target entity." + }, + "id": { + "type": "string", + "description": "Identifier of target entity" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/Task.schema.json b/Common/Task.schema.json index a35f46e4..579300e3 100644 --- a/Common/Task.schema.json +++ b/Common/Task.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Task.schema.json", - "title": "Task", - "definitions": { - "Task": { - "$id": "#Task", - "description": "A step or task along in the process of implementation a Change Request.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description of the task." - }, - "name": { - "type": "string", - "description": "The name of the task." - }, - "state": { - "type": "string", - "description": "The state of the task." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Task.schema.json", + "title": "Task", + "definitions": { + "Task": { + "$id": "#Task", + "description": "A step or task along in the process of implementation a Change Request.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of the task." + }, + "name": { + "type": "string", + "description": "The name of the task." + }, + "state": { + "type": "string", + "description": "The state of the task." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/TaskFlow.schema.json b/Common/TaskFlow.schema.json index fe51d7ad..9b88998c 100644 --- a/Common/TaskFlow.schema.json +++ b/Common/TaskFlow.schema.json @@ -1,84 +1,85 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaskFlow.schema.json", - "title": "TaskFlow", - "definitions": { - "TaskFlow": { - "type": "object", - "properties": { - "channel": { - "type": "array", - "items": { - "$ref": "ChannelRef.schema.json#/definitions/ChannelRef" - }, - "description": "A list of channel(s) where this taskFlow is executed" - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "Characteristic.schema.json#/definitions/Characteristic" - }, - "description": "A list of characteristic(s) associated to this taskFlow" - }, - "completionMethod": { - "type": "string", - "description": "TaskFlow completion method." - }, - "href": { - "type": "string", - "description": "Reference of the taskFlow" - }, - "id": { - "type": "string", - "description": "Identifier of the taskFlow" - }, - "isMandatory": { - "type": "boolean", - "description": "Indicate mandatory TaskFlow." - }, - "priority": { - "type": "integer", - "description": "TaskFlow priority." - }, - "processFlowId": { - "type": "string", - "description": "Identifier of the processFlow" - }, - "relatedEntity": { - "type": "array", - "items": { - "$ref": "RelatedEntity.schema.json#/definitions/RelatedEntity" - }, - "description": "A list of related entity(ies) to this taskFlow" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#/definitions/RelatedParty" - }, - "description": "A list of related party(ies) to this task" - }, - "state": { - "$ref": "TaskFlowStateType.schema.json#/definitions/TaskFlowStateType", - "description": "State of the taskFlow: described in the state machine diagram." - }, - "taskFlowRelationship": { - "type": "array", - "items": { - "$ref": "TaskFlowRelationship.schema.json#/definitions/TaskFlowRelationship" - }, - "description": "A list of taskFlows related to this taskFlow" - }, - "taskFlowSpecification": { - "type": "string", - "description": "Specification of the taskFlow." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#/Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaskFlow.schema.json", + "title": "TaskFlow", + "definitions": { + "TaskFlow": { + "$id": "#TaskFlow", + "type": "object", + "properties": { + "channel": { + "type": "array", + "items": { + "$ref": "ChannelRef.schema.json#ChannelRef" + }, + "description": "A list of channel(s) where this taskFlow is executed" + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "Characteristic.schema.json#Characteristic" + }, + "description": "A list of characteristic(s) associated to this taskFlow" + }, + "completionMethod": { + "type": "string", + "description": "TaskFlow completion method." + }, + "href": { + "type": "string", + "description": "Reference of the taskFlow" + }, + "id": { + "type": "string", + "description": "Identifier of the taskFlow" + }, + "isMandatory": { + "type": "boolean", + "description": "Indicate mandatory TaskFlow." + }, + "priority": { + "type": "integer", + "description": "TaskFlow priority." + }, + "processFlowId": { + "type": "string", + "description": "Identifier of the processFlow" + }, + "relatedEntity": { + "type": "array", + "items": { + "$ref": "RelatedEntity.schema.json#RelatedEntity" + }, + "description": "A list of related entity(ies) to this taskFlow" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "A list of related party(ies) to this task" + }, + "state": { + "$ref": "TaskFlowStateType.schema.json#TaskFlowStateType", + "description": "State of the taskFlow: described in the state machine diagram." + }, + "taskFlowRelationship": { + "type": "array", + "items": { + "$ref": "TaskFlowRelationship.schema.json#TaskFlowRelationship" + }, + "description": "A list of taskFlows related to this taskFlow" + }, + "taskFlowSpecification": { + "type": "string", + "description": "Specification of the taskFlow." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Common/TaskFlowRef.schema.json b/Common/TaskFlowRef.schema.json index b6b06618..d3711a7a 100644 --- a/Common/TaskFlowRef.schema.json +++ b/Common/TaskFlowRef.schema.json @@ -1,29 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaskFlowRef.schema.json", - "title": "TaskFlowRef", - "definitions": { - "TaskFlowRef": { - "type": "object", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "href": { - "type": "string", - "description": "Reference of the related entity." - }, - "id": { - "type": "string", - "description": "Unique identifier of a related entity." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#/Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaskFlowRef.schema.json", + "title": "TaskFlowRef", + "definitions": { + "TaskFlowRef": { + "$id": "#TaskFlowRef", + "type": "object", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "href": { + "type": "string", + "description": "Reference of the related entity." + }, + "id": { + "type": "string", + "description": "Unique identifier of a related entity." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Common/TaskFlowRelationship.schema.json b/Common/TaskFlowRelationship.schema.json index 5ded0424..0ecc084b 100644 --- a/Common/TaskFlowRelationship.schema.json +++ b/Common/TaskFlowRelationship.schema.json @@ -1,23 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaskFlowRelationship.schema.json", - "title": "TaskFlowRelationship", - "definitions": { - "TaskFlowRelationship": { - "$id": "#TaskFlowRelationship", - "description": "Describes relationship between taskFlow", - "type": "object", - "required": ["relationshipType", "taskFlow"], - "properties": { - "relationshipType": { - "type": "string", - "description": "The type of taskFlow relationship (requires, triggers, etc.)" - }, - "taskFlow": { - "description": "The taskFlow being referred to", - "$ref": "TaskFlowRef.schema.json#TaskFlowRef" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaskFlowRelationship.schema.json", + "title": "TaskFlowRelationship", + "definitions": { + "TaskFlowRelationship": { + "$id": "#TaskFlowRelationship", + "description": "Describes relationship between taskFlow", + "type": "object", + "required": [ + "relationshipType", + "taskFlow" + ], + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of taskFlow relationship (requires, triggers, etc.)" + }, + "taskFlow": { + "description": "The taskFlow being referred to", + "$ref": "TaskFlowRef.schema.json#TaskFlowRef" } + } } -} + } +} \ No newline at end of file diff --git a/Common/TaskFlowStateType.schema.json b/Common/TaskFlowStateType.schema.json index 223793b9..c6b640da 100644 --- a/Common/TaskFlowStateType.schema.json +++ b/Common/TaskFlowStateType.schema.json @@ -1,19 +1,19 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaskFlowStateType.schema.json", - "title": "TaskFlowStateType", - "definitions": { - "TaskFlowStateType": { - "$id": "#TaskFlowStateType", - "type": "string", - "description": "Valid values for the lifecycle state of the taskFlow", - "enum": [ - "new", - "active", - "hold", - "cancelled", - "completed" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaskFlowStateType.schema.json", + "title": "TaskFlowStateType", + "definitions": { + "TaskFlowStateType": { + "$id": "#TaskFlowStateType", + "type": "string", + "description": "Valid values for the lifecycle state of the taskFlow", + "enum": [ + "new", + "active", + "hold", + "cancelled", + "completed" + ] } -} + } +} \ No newline at end of file diff --git a/Common/TaskStateType.schema.json b/Common/TaskStateType.schema.json index dffc65b4..ccd74dd2 100644 --- a/Common/TaskStateType.schema.json +++ b/Common/TaskStateType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaskStateType.schema.json", - "title": "TaskStateType", - "definitions": { - "TaskStateType": { - "$id": "#TaskStateType", - "type": "string", - "description": "Possible values for the state of a task", - "enum": [ - "acknowledged", - "terminatedWithError", - "inProgress", - "done" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaskStateType.schema.json", + "title": "TaskStateType", + "definitions": { + "TaskStateType": { + "$id": "#TaskStateType", + "type": "string", + "description": "Possible values for the state of a task", + "enum": [ + "acknowledged", + "terminatedWithError", + "inProgress", + "done" + ] } -} + } +} \ No newline at end of file diff --git a/Common/TaxDefinition.schema.json b/Common/TaxDefinition.schema.json index 34ea0536..73ea2b02 100644 --- a/Common/TaxDefinition.schema.json +++ b/Common/TaxDefinition.schema.json @@ -1,34 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaxDefinition.schema.json", - "title": "TaxDefinition", - "definitions": { - "TaxDefinition": { - "type": "object", - "description": "Reference of a tax definition. A tax is levied by an authorized tax jurisdiction. There are many different types of tax (Federal Tax levied by the US Government, State Tax levied by the State of California,…).", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "id": { - "type": "string", - "description": "Unique identifier of the tax." - }, - "name": { - "type": "string", - "description": "Tax name." - }, - "taxType": { - "type": "string", - "description": "Type of the tax." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#/Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaxDefinition.schema.json", + "title": "TaxDefinition", + "definitions": { + "TaxDefinition": { + "$id": "#TaxDefinition", + "type": "object", + "description": "Reference of a tax definition. A tax is levied by an authorized tax jurisdiction. There are many different types of tax (Federal Tax levied by the US Government, State Tax levied by the State of California,…).", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "id": { + "type": "string", + "description": "Unique identifier of the tax." + }, + "name": { + "type": "string", + "description": "Tax name." + }, + "taxType": { + "type": "string", + "description": "Type of the tax." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Common/Ticket.schema.json b/Common/Ticket.schema.json index 12674962..7afa7946 100644 --- a/Common/Ticket.schema.json +++ b/Common/Ticket.schema.json @@ -1,96 +1,96 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Ticket.schema.json", - "title": "Ticket", - "definitions": { - "Ticket": { - "$id": "#Ticket", - "description": "A trouble ticket represents a record used for reporting and managing the resolution of resource problems", - "type": "object", - "properties": { - "correlationId": { - "type": "string", - "description": "Additional identifier coming from an external system" - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "The date on which the trouble was discovered" - }, - "description": { - "type": "string", - "description": "Description of the trouble" - }, - "href": { - "type": "string", - "description": "Reference of the trouble ticket" - }, - "id": { - "type": "string", - "description": "Unique identifier of the trouble ticket" - }, - "resolutionDate": { - "type": "string", - "format": "date-time", - "description": "The date on which the service was brought back to its original condition" - }, - "severity": { - "type": "string", - "description": "The severity of the trouble. It can be for example : minor, major, critical" - }, - "status": { - "type": "string", - "description": "The current status of the Trouble Ticket" - }, - "statusChangeDate": { - "type": "string", - "format": "date-time", - "description": "The date of state change" - }, - "statusChangeReason": { - "type": "string", - "description": "The reason of state change" - }, - "subStatus": { - "type": "string", - "description": "The current sub status of the Trouble Ticket" - }, - "targetResolutionDate": { - "type": "string", - "format": "date-time", - "description": "Foreseen trouble resolution date" - }, - "ticketType": { - "type": "string", - "description": "Type of trouble ticket" - }, - "relatedObject": { - "type": "array", - "description": "Any object(s) associated with this trouble ticket", - "items": { - "$ref": "RelatedObject.schema.json#RelatedObject" - } - }, - "note": { - "type": "array", - "description": "Any note(s) associated with this trouble ticket", - "items": { - "$ref": "Note.schema.json#Note" - } - }, - "relatedParty": { - "type": "array", - "description": "Any Party/Parties associated with this trouble ticket", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Ticket.schema.json", + "title": "Ticket", + "definitions": { + "Ticket": { + "$id": "#Ticket", + "description": "A trouble ticket represents a record used for reporting and managing the resolution of resource problems", + "type": "object", + "properties": { + "correlationId": { + "type": "string", + "description": "Additional identifier coming from an external system" + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "The date on which the trouble was discovered" + }, + "description": { + "type": "string", + "description": "Description of the trouble" + }, + "href": { + "type": "string", + "description": "Reference of the trouble ticket" + }, + "id": { + "type": "string", + "description": "Unique identifier of the trouble ticket" + }, + "resolutionDate": { + "type": "string", + "format": "date-time", + "description": "The date on which the service was brought back to its original condition" + }, + "severity": { + "type": "string", + "description": "The severity of the trouble. It can be for example : minor, major, critical" + }, + "status": { + "type": "string", + "description": "The current status of the Trouble Ticket" + }, + "statusChangeDate": { + "type": "string", + "format": "date-time", + "description": "The date of state change" + }, + "statusChangeReason": { + "type": "string", + "description": "The reason of state change" + }, + "subStatus": { + "type": "string", + "description": "The current sub status of the Trouble Ticket" + }, + "targetResolutionDate": { + "type": "string", + "format": "date-time", + "description": "Foreseen trouble resolution date" + }, + "ticketType": { + "type": "string", + "description": "Type of trouble ticket" + }, + "relatedObject": { + "type": "array", + "description": "Any object(s) associated with this trouble ticket", + "items": { + "$ref": "RelatedObject.schema.json#RelatedObject" + } + }, + "note": { + "type": "array", + "description": "Any note(s) associated with this trouble ticket", + "items": { + "$ref": "Note.schema.json#Note" + } + }, + "relatedParty": { + "type": "array", + "description": "Any Party/Parties associated with this trouble ticket", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/TicketRelationship.schema.json b/Common/TicketRelationship.schema.json index 25776fcf..988d3aa9 100644 --- a/Common/TicketRelationship.schema.json +++ b/Common/TicketRelationship.schema.json @@ -1,25 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TicketRelationship.schema.json", - "title": "TicketRelationship", - "definitions": { - "TicketRelationship": { - "type": "object", - "description": "Represents a relationship between trouble tickets", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of the trouble ticket relationship can be isChiled, dependent etc..." - }, - "product": { - "$ref": "TroubleTicketRef.schema.json#TroubleTicketRef" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#/Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TicketRelationship.schema.json", + "title": "TicketRelationship", + "definitions": { + "TicketRelationship": { + "$id": "#TicketRelationship", + "type": "object", + "description": "Represents a relationship between trouble tickets", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of the trouble ticket relationship can be isChiled, dependent etc..." + }, + "product": { + "$ref": "TroubleTicketRef.schema.json#TroubleTicketRef" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Common/TimePeriodType.schema.json b/Common/TimePeriodType.schema.json index 9c01dc3c..56316c0b 100644 --- a/Common/TimePeriodType.schema.json +++ b/Common/TimePeriodType.schema.json @@ -1,25 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TimePeriodType.schema.json", - "title": "TimePeriodType", - "definitions": { - "TimePeriodType": { - "description": "Representation of a time period", - "properties": { - "endDateTime": { - "type": "string", - "format": "date-time", - "description": "End date of the period" - }, - "startDateTime": { - "type": "string", - "format": "date-time", - "description": "Start date of the period" - } - }, - "required": [ - "startDateTime" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TimePeriodType.schema.json", + "title": "TimePeriodType", + "definitions": { + "TimePeriodType": { + "$id": "#TimePeriodType", + "description": "Representation of a time period", + "properties": { + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "End date of the period" + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Start date of the period" } + }, + "required": [ + "startDateTime" + ], + "type": "object" } + } } \ No newline at end of file diff --git a/Common/TroubleTicket.schema.json b/Common/TroubleTicket.schema.json index 65e2e91c..58c6e711 100755 --- a/Common/TroubleTicket.schema.json +++ b/Common/TroubleTicket.schema.json @@ -1,134 +1,135 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TroubleTicket.schema.json", - "title": "TroubleTicket", - "definitions": { - "TroubleTicket": { - "type": "object", - "description": "A trouble ticket is a record of an issue that is created, tracked, and managed by a trouble ticket management system", - "properties": { - "attachment": { - "type": "array", - "items": { - "$ref": "AttachmentRefOrValue.schema.json#/definitions/AttachmentRefOrValue" - }, - "description": "File(s) attached to the trouble ticket. e.g. pictur of broken device, scaning of a bill or charge" - }, - "channel": { - "$ref": "ChannelRef.schema.json#/definitions/ChannelRef", - "description": "The channel that origin the trouble ticket" - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "The date on which the trouble ticket was created" - }, - "description": { - "type": "string", - "description": "Description of the trouble or issue" - }, - "expectedResolutionDate": { - "type": "string", - "format": "date-time", - "description": "The expected resolution date determined by the trouble ticket system" - }, - "externalId": { - "type": "string", - "description": "Additional identifier coming from an external system" - }, - "href": { - "type": "string", - "description": "Hyperlink, a reference to the trouble ticket entity" - }, - "id": { - "type": "string", - "description": "Unique identifier of the trouble ticket" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "The date and time that the trouble ticked was last updated" - }, - "name": { - "type": "string", - "description": "Name of the trouble ticket, typically a short description provided by the user that create the ticket" - }, - "note": { - "type": "array", - "items": { - "$ref": "Note.schema.json#/definitions/Note" - }, - "description": "The note(s) that are associated to the ticket." - }, - "priority": { - "type": "string", - "description": "The priority of the trouble ticket and how quickly the issue should be resolved. Example: Critical, High, Medium, Low. The value is set by the ticket management system considering the severity, ticket type etc..." - }, - "relatedEntity": { - "type": "array", - "items": { - "$ref": "RelatedEntity.schema.json#/definitions/RelatedEntity" - }, - "description": "An entity that is related to the ticket such as a bill, a product, etc. The entity against which the ticket is associated." - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#/definitions/RelatedParty" - }, - "description": "The related party(ies) that are associated to the ticket." - }, - "requestedResolutionDate": { - "type": "string", - "format": "date-time", - "description": "The resolution date requested by the user" - }, - "resolutionDate": { - "type": "string", - "format": "date-time", - "description": "The date and time the trouble ticket was resolved" - }, - "severity": { - "type": "string", - "description": "The severity of the issue. Indicate the implication of the issue on the expected functionality e.g. of a system, application, service etc.. \nSeverity values can be for example : Critical, Major, Minor" - }, - "status": { - "$ref": "TroubleTicketStatusType.schema.json#/definitions/TroubleTicketStatusType", - "description": "The current status of the trouble ticket" - }, - "statusChange": { - "type": "array", - "items": { - "$ref": "StatusChange.schema.json#/definitions/StatusChange" - }, - "description": "The status change history that are associated to the ticket.Populated by the server" - }, - "statusChangeDate": { - "type": "string", - "format": "date-time", - "description": "The date and time the status changed." - }, - "statusChangeReason": { - "type": "string", - "description": "The reason for changing the status" - }, - "troubleTicketRelationship": { - "type": "array", - "items": { - "$ref": "TroubleTicketRelationship.schema.json#/definitions/TroubleTicketRelationship" - }, - "description": "A list of trouble ticket relationships (TroubleTicketRelationship [*]). Represents a relationship between trouble tickets" - }, - "ticketType": { - "type": "string", - "description": "represent a business type of the trouble ticket e.g. incident, complain, request" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#/Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TroubleTicket.schema.json", + "title": "TroubleTicket", + "definitions": { + "TroubleTicket": { + "$id": "#TroubleTicket", + "type": "object", + "description": "A trouble ticket is a record of an issue that is created, tracked, and managed by a trouble ticket management system", + "properties": { + "attachment": { + "type": "array", + "items": { + "$ref": "AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + }, + "description": "File(s) attached to the trouble ticket. e.g. pictur of broken device, scaning of a bill or charge" + }, + "channel": { + "$ref": "ChannelRef.schema.json#ChannelRef", + "description": "The channel that origin the trouble ticket" + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "The date on which the trouble ticket was created" + }, + "description": { + "type": "string", + "description": "Description of the trouble or issue" + }, + "expectedResolutionDate": { + "type": "string", + "format": "date-time", + "description": "The expected resolution date determined by the trouble ticket system" + }, + "externalId": { + "type": "string", + "description": "Additional identifier coming from an external system" + }, + "href": { + "type": "string", + "description": "Hyperlink, a reference to the trouble ticket entity" + }, + "id": { + "type": "string", + "description": "Unique identifier of the trouble ticket" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "The date and time that the trouble ticked was last updated" + }, + "name": { + "type": "string", + "description": "Name of the trouble ticket, typically a short description provided by the user that create the ticket" + }, + "note": { + "type": "array", + "items": { + "$ref": "Note.schema.json#Note" + }, + "description": "The note(s) that are associated to the ticket." + }, + "priority": { + "type": "string", + "description": "The priority of the trouble ticket and how quickly the issue should be resolved. Example: Critical, High, Medium, Low. The value is set by the ticket management system considering the severity, ticket type etc..." + }, + "relatedEntity": { + "type": "array", + "items": { + "$ref": "RelatedEntity.schema.json#RelatedEntity" + }, + "description": "An entity that is related to the ticket such as a bill, a product, etc. The entity against which the ticket is associated." + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "The related party(ies) that are associated to the ticket." + }, + "requestedResolutionDate": { + "type": "string", + "format": "date-time", + "description": "The resolution date requested by the user" + }, + "resolutionDate": { + "type": "string", + "format": "date-time", + "description": "The date and time the trouble ticket was resolved" + }, + "severity": { + "type": "string", + "description": "The severity of the issue. Indicate the implication of the issue on the expected functionality e.g. of a system, application, service etc.. \nSeverity values can be for example : Critical, Major, Minor" + }, + "status": { + "$ref": "TroubleTicketStatusType.schema.json#TroubleTicketStatusType", + "description": "The current status of the trouble ticket" + }, + "statusChange": { + "type": "array", + "items": { + "$ref": "StatusChange.schema.json#StatusChange" + }, + "description": "The status change history that are associated to the ticket.Populated by the server" + }, + "statusChangeDate": { + "type": "string", + "format": "date-time", + "description": "The date and time the status changed." + }, + "statusChangeReason": { + "type": "string", + "description": "The reason for changing the status" + }, + "troubleTicketRelationship": { + "type": "array", + "items": { + "$ref": "TroubleTicketRelationship.schema.json#TroubleTicketRelationship" + }, + "description": "A list of trouble ticket relationships (TroubleTicketRelationship [*]). Represents a relationship between trouble tickets" + }, + "ticketType": { + "type": "string", + "description": "represent a business type of the trouble ticket e.g. incident, complain, request" } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Common/TroubleTicketRef.schema.json b/Common/TroubleTicketRef.schema.json index af4647ef..5f78ab44 100644 --- a/Common/TroubleTicketRef.schema.json +++ b/Common/TroubleTicketRef.schema.json @@ -1,19 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TroubleTicketRef.schema.json", - "title": "TroubleTicketRef", - "definitions": { - "TroubleTicketRef": { - "$id": "#TroubleTicketRef", - "description": "TroubleTicket reference, for when a Trouble Ticket is used by other entities", - "type": "object", - "properties": { - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TroubleTicketRef.schema.json", + "title": "TroubleTicketRef", + "definitions": { + "TroubleTicketRef": { + "$id": "#TroubleTicketRef", + "description": "TroubleTicket reference, for when a Trouble Ticket is used by other entities", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "EntityRef.schema.json#EntityRef" } + ] } -} + } +} \ No newline at end of file diff --git a/Common/TroubleTicketRelationship.schema.json b/Common/TroubleTicketRelationship.schema.json index 97d38d10..c69a74b9 100755 --- a/Common/TroubleTicketRelationship.schema.json +++ b/Common/TroubleTicketRelationship.schema.json @@ -1,25 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TroubleTicketRelationship.schema.json", - "title": "TroubleTicketRelationship", - "definitions": { - "TroubleTicketRelationship": { - "type": "object", - "description": "Represents a relationship between trouble TroubleTickets", - "properties": { - "troubleTicket": { - "$ref": "TroubleTicketRef.schema.json#/definitions/TroubleTicketRef" - }, - "relationshipType": { - "type": "string", - "description": "Type of the Trouble Ticket relationship can be isChiled, dependent etc..." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#/Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TroubleTicketRelationship.schema.json", + "title": "TroubleTicketRelationship", + "definitions": { + "TroubleTicketRelationship": { + "$id": "#TroubleTicketRelationship", + "type": "object", + "description": "Represents a relationship between trouble TroubleTickets", + "properties": { + "troubleTicket": { + "$ref": "TroubleTicketRef.schema.json#TroubleTicketRef" + }, + "relationshipType": { + "type": "string", + "description": "Type of the Trouble Ticket relationship can be isChiled, dependent etc..." } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Common/TroubleTicketStatusType.schema.json b/Common/TroubleTicketStatusType.schema.json index a4a99ede..b40e201a 100644 --- a/Common/TroubleTicketStatusType.schema.json +++ b/Common/TroubleTicketStatusType.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TroubleTicketStatusType.schema.json", - "title": "TroubleTicketStatusType", - "definitions": { - "TroubleTicketStatusType": { - "$id": "#TroubleTicketStatusType", - "type": "string", - "description": "Possible values for the status of the trouble ticket", - "enum": [ - "acknowledged", - "rejected", - "pending", - "held", - "inProgress", - "cancelled", - "closed", - "resolved" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TroubleTicketStatusType.schema.json", + "title": "TroubleTicketStatusType", + "definitions": { + "TroubleTicketStatusType": { + "$id": "#TroubleTicketStatusType", + "type": "string", + "description": "Possible values for the status of the trouble ticket", + "enum": [ + "acknowledged", + "rejected", + "pending", + "held", + "inProgress", + "cancelled", + "closed", + "resolved" + ] } -} + } +} \ No newline at end of file diff --git a/Common/Value.schema.json b/Common/Value.schema.json index 5f834f5c..2075d2ad 100644 --- a/Common/Value.schema.json +++ b/Common/Value.schema.json @@ -1,17 +1,17 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Value.schema.json", - "title": "Value", - "definitions": { - "Value": { - "$id": "#Value", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Value.schema.json", + "title": "Value", + "definitions": { + "Value": { + "$id": "#Value", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" } + ] } -} + } +} \ No newline at end of file diff --git a/Common/WorkLog.schema.json b/Common/WorkLog.schema.json index a9845b55..b8579373 100644 --- a/Common/WorkLog.schema.json +++ b/Common/WorkLog.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "WorkLog.schema.json", - "title": "WorkLog", - "definitions": { - "WorkLog": { - "$id": "#WorkLog", - "description": "A record of the work performed on the change request during the investigation and resolution process.", - "type": "object", - "properties": { - "createDateTime": { - "type": "string", - "format": "date-time", - "description": "Date and time of worklog generated." - }, - "description": { - "type": "string", - "description": "The description of the worklog." - }, - "lastUpdateDateTime": { - "type": "string", - "description": "Date and time when the worklog updated." - }, - "record": { - "type": "array", - "items": { - "$ref": "Record.schema.json#Record" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "WorkLog.schema.json", + "title": "WorkLog", + "definitions": { + "WorkLog": { + "$id": "#WorkLog", + "description": "A record of the work performed on the change request during the investigation and resolution process.", + "type": "object", + "properties": { + "createDateTime": { + "type": "string", + "format": "date-time", + "description": "Date and time of worklog generated." + }, + "description": { + "type": "string", + "description": "The description of the worklog." + }, + "lastUpdateDateTime": { + "type": "string", + "description": "Date and time when the worklog updated." + }, + "record": { + "type": "array", + "items": { + "$ref": "Record.schema.json#Record" + } } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/AccumulatedBalance.schema.json b/Customer/AccumulatedBalance.schema.json index 24bca28e..cb50b070 100644 --- a/Customer/AccumulatedBalance.schema.json +++ b/Customer/AccumulatedBalance.schema.json @@ -1,58 +1,60 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccumulatedBalance.schema.json", - "title": "AccumulatedBalance", - "definitions": { - "AccumulatedBalance": { - "description": "Represents and tracks the aggregated amount remained or owed in certain account which is owned by certain customer for a set of buckets.", - "properties": { - "bucket": { - "type": "array", - "items": { - "$ref": "BucketBalanceRef.schema.json#/definitions/BucketBalanceRef" - }, - "description": "A reference to the buckets involved in the aggregation" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the aggregated balance" - }, - "name": { - "type": "string", - "description": "Friendly name to identify the aggregated balance" - }, - "partyAccount": { - "type": "array", - "items": { - "$ref": "PartyAccountRef.schema.json#/definitions/PartyAccountRef" - }, - "description": "A reference to the account that owns the buckets aggregated" - }, - "product": { - "type": "array", - "items": { - "$ref": "ProductRef.schema.json#/definitions/ProductRef" - }, - "description": "A reference to the product whose consumption is managed by the bucket . This is an array to allow scenarios where a buckets are shared between different products" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#/definitions/RelatedParty" - }, - "description": "Used to provide information about any other entity with relation to the balance, for instance to define customer hierarchy for the balance (e.g.: customerId, userId, )" - }, - "totalBalance": { - "description": "Aggregated for a set of prepay balance buckets associated to the product", - "$ref": "QuantityType.schema.json#/definitions/QuantityType" - } - }, - "required": [ - "name", - "totalBalance", - "bucket", - "product" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccumulatedBalance.schema.json", + "title": "AccumulatedBalance", + "definitions": { + "AccumulatedBalance": { + "$id": "#AccumulatedBalance", + "description": "Represents and tracks the aggregated amount remained or owed in certain account which is owned by certain customer for a set of buckets.", + "properties": { + "bucket": { + "type": "array", + "items": { + "$ref": "BucketBalanceRef.schema.json#BucketBalanceRef" + }, + "description": "A reference to the buckets involved in the aggregation" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the aggregated balance" + }, + "name": { + "type": "string", + "description": "Friendly name to identify the aggregated balance" + }, + "partyAccount": { + "type": "array", + "items": { + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "description": "A reference to the account that owns the buckets aggregated" + }, + "product": { + "type": "array", + "items": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "description": "A reference to the product whose consumption is managed by the bucket . This is an array to allow scenarios where a buckets are shared between different products" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "Used to provide information about any other entity with relation to the balance, for instance to define customer hierarchy for the balance (e.g.: customerId, userId, )" + }, + "totalBalance": { + "description": "Aggregated for a set of prepay balance buckets associated to the product", + "$ref": "../Common/QuantityType.schema.json#QuantityType" } + }, + "required": [ + "name", + "totalBalance", + "bucket", + "product" + ], + "type": "object" } -} + } +} \ No newline at end of file diff --git a/Customer/AppliedBillingRate.schema.json b/Customer/AppliedBillingRate.schema.json index a897241a..6cbf430b 100644 --- a/Customer/AppliedBillingRate.schema.json +++ b/Customer/AppliedBillingRate.schema.json @@ -1,67 +1,67 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppliedBillingRate.schema.json", - "title": "AppliedBillingRate", - "definitions": { - "AppliedBillingRate": { - "$id": "#AppliedBillingRate", - "description": "An applied billing rate presented on a bill. It is created before or during the billing process", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time", - "description": "Creation date of the applied billing charge" - }, - "description": { - "type": "string", - "description": "Additional data to be displayed on the bill for this applied billing charge" - }, - "href": { - "type": "string", - "description": "Reference of the applied billing charge" - }, - "id": { - "type": "string", - "description": "Unique identifier of the applied billing charge" - }, - "name": { - "type": "string", - "description": "Name of the applied billing rate" - }, - "taxExcludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Tax excluded amount to be charged on the bill (expresses in the given currency) for this applied billing rate" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "All taxes included amount to be charged on the bill (expressed in the given currency) for this applied billing rate" - }, - "rateType": { - "type": "string", - "description": "Type of the applied billing rate : appliedBillingCharge (any kind of charge except taxation charges : recurringCharge, oneTimeCharge, usageCharge), appliedBillingCredit (any kind of credit : rebate or productAlteration) or appliedPenaltyCharge (penalty charges such as late fees, payment rejection fees,...)" - }, - "appliedTax": { - "type": "array", - "items": { - "$ref": "AppliedBillingTaxRate.schema.json#AppliedBillingTaxRate" - } - }, - "bill": { - "$ref": "BillRef.schema.json#BillRef" - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "AppliedBillingRateCharacteristic.schema.json#AppliedBillingRateCharacteristic" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppliedBillingRate.schema.json", + "title": "AppliedBillingRate", + "definitions": { + "AppliedBillingRate": { + "$id": "#AppliedBillingRate", + "description": "An applied billing rate presented on a bill. It is created before or during the billing process", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "Creation date of the applied billing charge" + }, + "description": { + "type": "string", + "description": "Additional data to be displayed on the bill for this applied billing charge" + }, + "href": { + "type": "string", + "description": "Reference of the applied billing charge" + }, + "id": { + "type": "string", + "description": "Unique identifier of the applied billing charge" + }, + "name": { + "type": "string", + "description": "Name of the applied billing rate" + }, + "taxExcludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Tax excluded amount to be charged on the bill (expresses in the given currency) for this applied billing rate" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "All taxes included amount to be charged on the bill (expressed in the given currency) for this applied billing rate" + }, + "rateType": { + "type": "string", + "description": "Type of the applied billing rate : appliedBillingCharge (any kind of charge except taxation charges : recurringCharge, oneTimeCharge, usageCharge), appliedBillingCredit (any kind of credit : rebate or productAlteration) or appliedPenaltyCharge (penalty charges such as late fees, payment rejection fees,...)" + }, + "appliedTax": { + "type": "array", + "items": { + "$ref": "AppliedBillingTaxRate.schema.json#AppliedBillingTaxRate" + } + }, + "bill": { + "$ref": "BillRef.schema.json#BillRef" + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "AppliedBillingRateCharacteristic.schema.json#AppliedBillingRateCharacteristic" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/AppliedBillingRateCharacteristic.schema.json b/Customer/AppliedBillingRateCharacteristic.schema.json index 1eb9d3b6..be09ed7b 100644 --- a/Customer/AppliedBillingRateCharacteristic.schema.json +++ b/Customer/AppliedBillingRateCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppliedBillingRateCharacteristic.schema.json", - "title": "AppliedBillingRateCharacteristic", - "definitions": { - "AppliedBillingRateCharacteristic": { - "$id": "#AppliedBillingRateCharacteristic", - "description": "An applied billing rate has dynamic characteristics according to the its type (characteristics are based on the service type, line of business or on others parameters)", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Characteristic name" - }, - "value": { - "type": "string", - "description": "Value affected to the characteristic" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppliedBillingRateCharacteristic.schema.json", + "title": "AppliedBillingRateCharacteristic", + "definitions": { + "AppliedBillingRateCharacteristic": { + "$id": "#AppliedBillingRateCharacteristic", + "description": "An applied billing rate has dynamic characteristics according to the its type (characteristics are based on the service type, line of business or on others parameters)", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Characteristic name" + }, + "value": { + "type": "string", + "description": "Value affected to the characteristic" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/AppliedBillingTaxRate.schema.json b/Customer/AppliedBillingTaxRate.schema.json index 0b3395ac..517aa462 100644 --- a/Customer/AppliedBillingTaxRate.schema.json +++ b/Customer/AppliedBillingTaxRate.schema.json @@ -1,32 +1,32 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppliedBillingTaxRate.schema.json", - "title": "AppliedBillingTaxRate", - "definitions": { - "AppliedBillingTaxRate": { - "$id": "#AppliedBillingTaxRate", - "description": "The applied billing tax rate represents taxes applied billing rate it refers to. It is calculated during the billing process.", - "type": "object", - "properties": { - "taxAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Tax amount expressed in the given currency" - }, - "taxCategory": { - "type": "string", - "description": "A categorization of the tax rate" - }, - "taxRate": { - "type": "number", - "format": "float", - "description": "Applied rate" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppliedBillingTaxRate.schema.json", + "title": "AppliedBillingTaxRate", + "definitions": { + "AppliedBillingTaxRate": { + "$id": "#AppliedBillingTaxRate", + "description": "The applied billing tax rate represents taxes applied billing rate it refers to. It is calculated during the billing process.", + "type": "object", + "properties": { + "taxAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Tax amount expressed in the given currency" + }, + "taxCategory": { + "type": "string", + "description": "A categorization of the tax rate" + }, + "taxRate": { + "type": "number", + "format": "float", + "description": "Applied rate" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/AppliedCustomerBillingRate.schema.json b/Customer/AppliedCustomerBillingRate.schema.json index ec1f7507..ef423d7e 100644 --- a/Customer/AppliedCustomerBillingRate.schema.json +++ b/Customer/AppliedCustomerBillingRate.schema.json @@ -1,67 +1,67 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppliedCustomerBillingRate.schema.json", - "title": "AppliedCustomerBillingRate", - "definitions": { - "AppliedCustomerBillingRate": { - "$id": "#AppliedCustomerBillingRate", - "description": "An applied billing rate presented on a customer bill. It is created before or during the billing process.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time", - "description": "Creation date of the applied billing charge" - }, - "description": { - "type": "string", - "description": "Additional data to be displayed on the bill for this applied billing charge" - }, - "href": { - "type": "string", - "description": "Reference of the applied billing charge" - }, - "id": { - "type": "string", - "description": "Unique identifier of the applied billing charge" - }, - "name": { - "type": "string", - "description": "Name of the applied billing rate" - }, - "taxExcludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Tax excluded amount to be charged on the bill (expresses in the given currency) for this applied billing rate" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "All taxes included amount to be charged on the bill (expressed in the given currency) for this applied billing rate" - }, - "rateType": { - "type": "string", - "description": "Type of the applied billing rate : appliedBillingCharge (any kind of charge except taxation charges : recurringCharge, oneTimeCharge, usageCharge), appliedBillingCredit (any kind of credit : rebate or productAlteration) or appliedPenaltyCharge (penalty charges such as late fees, payment rejection fees,...)" - }, - "appliedTax": { - "type": "array", - "items": { - "$ref": "AppliedBillingTaxRate.schema.json#AppliedBillingTaxRate" - } - }, - "bill": { - "$ref": "BillRef.schema.json#BillRef" - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "AppliedBillingRateCharacteristic.schema.json#AppliedBillingRateCharacteristic" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppliedCustomerBillingRate.schema.json", + "title": "AppliedCustomerBillingRate", + "definitions": { + "AppliedCustomerBillingRate": { + "$id": "#AppliedCustomerBillingRate", + "description": "An applied billing rate presented on a customer bill. It is created before or during the billing process.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "Creation date of the applied billing charge" + }, + "description": { + "type": "string", + "description": "Additional data to be displayed on the bill for this applied billing charge" + }, + "href": { + "type": "string", + "description": "Reference of the applied billing charge" + }, + "id": { + "type": "string", + "description": "Unique identifier of the applied billing charge" + }, + "name": { + "type": "string", + "description": "Name of the applied billing rate" + }, + "taxExcludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Tax excluded amount to be charged on the bill (expresses in the given currency) for this applied billing rate" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "All taxes included amount to be charged on the bill (expressed in the given currency) for this applied billing rate" + }, + "rateType": { + "type": "string", + "description": "Type of the applied billing rate : appliedBillingCharge (any kind of charge except taxation charges : recurringCharge, oneTimeCharge, usageCharge), appliedBillingCredit (any kind of credit : rebate or productAlteration) or appliedPenaltyCharge (penalty charges such as late fees, payment rejection fees,...)" + }, + "appliedTax": { + "type": "array", + "items": { + "$ref": "AppliedBillingTaxRate.schema.json#AppliedBillingTaxRate" + } + }, + "bill": { + "$ref": "BillRef.schema.json#BillRef" + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "AppliedBillingRateCharacteristic.schema.json#AppliedBillingRateCharacteristic" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/AppliedPartyBillingRate.schema.json b/Customer/AppliedPartyBillingRate.schema.json index b7801c78..a8c57f88 100644 --- a/Customer/AppliedPartyBillingRate.schema.json +++ b/Customer/AppliedPartyBillingRate.schema.json @@ -1,67 +1,67 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppliedPartyBillingRate.schema.json", - "title": "AppliedPartyBillingRate", - "definitions": { - "AppliedPartyBillingRate": { - "$id": "#AppliedPartyBillingRate", - "description": "An applied billing rate presented on a party bill. It is created before or during the billing process.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time", - "description": "Creation date of the applied billing charge" - }, - "description": { - "type": "string", - "description": "Additional data to be displayed on the bill for this applied billing charge" - }, - "href": { - "type": "string", - "description": "Reference of the applied billing charge" - }, - "id": { - "type": "string", - "description": "Unique identifier of the applied billing charge" - }, - "name": { - "type": "string", - "description": "Name of the applied billing rate" - }, - "taxExcludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Tax excluded amount to be charged on the bill (expresses in the given currency) for this applied billing rate" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "All taxes included amount to be charged on the bill (expressed in the given currency) for this applied billing rate" - }, - "rateType": { - "type": "string", - "description": "Type of the applied billing rate : appliedBillingCharge (any kind of charge except taxation charges : recurringCharge, oneTimeCharge, usageCharge), appliedBillingCredit (any kind of credit : rebate or productAlteration) or appliedPenaltyCharge (penalty charges such as late fees, payment rejection fees,...)" - }, - "appliedTax": { - "type": "array", - "items": { - "$ref": "AppliedBillingTaxRate.schema.json#AppliedBillingTaxRate" - } - }, - "bill": { - "$ref": "BillRef.schema.json#BillRef" - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "AppliedBillingRateCharacteristic.schema.json#AppliedBillingRateCharacteristic" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppliedPartyBillingRate.schema.json", + "title": "AppliedPartyBillingRate", + "definitions": { + "AppliedPartyBillingRate": { + "$id": "#AppliedPartyBillingRate", + "description": "An applied billing rate presented on a party bill. It is created before or during the billing process.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "Creation date of the applied billing charge" + }, + "description": { + "type": "string", + "description": "Additional data to be displayed on the bill for this applied billing charge" + }, + "href": { + "type": "string", + "description": "Reference of the applied billing charge" + }, + "id": { + "type": "string", + "description": "Unique identifier of the applied billing charge" + }, + "name": { + "type": "string", + "description": "Name of the applied billing rate" + }, + "taxExcludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Tax excluded amount to be charged on the bill (expresses in the given currency) for this applied billing rate" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "All taxes included amount to be charged on the bill (expressed in the given currency) for this applied billing rate" + }, + "rateType": { + "type": "string", + "description": "Type of the applied billing rate : appliedBillingCharge (any kind of charge except taxation charges : recurringCharge, oneTimeCharge, usageCharge), appliedBillingCredit (any kind of credit : rebate or productAlteration) or appliedPenaltyCharge (penalty charges such as late fees, payment rejection fees,...)" + }, + "appliedTax": { + "type": "array", + "items": { + "$ref": "AppliedBillingTaxRate.schema.json#AppliedBillingTaxRate" + } + }, + "bill": { + "$ref": "BillRef.schema.json#BillRef" + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "AppliedBillingRateCharacteristic.schema.json#AppliedBillingRateCharacteristic" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/Appointment.schema.json b/Customer/Appointment.schema.json index dd3ed59f..73a8daf3 100644 --- a/Customer/Appointment.schema.json +++ b/Customer/Appointment.schema.json @@ -1,95 +1,96 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Appointment.schema.json", - "title": "Appointment", - "definitions": { - "Appointment": { - "type": "object", - "description": "An Appointment is an arrangement to do something or meet someone at a particular time, at a place (for face to face appointment) or in a contact medium (for phone appointment).", - "properties": { - "attachment": { - "type": "array", - "items": { - "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" - } - }, - "calendarEvent": { - "$ref": "../Common/CalendarEventRef.schema.json#CalendarEventRef", - "description" : "A calendar event reference (CalendarEventRef). The appointment is associated with a calendar event (an happening at a point of time) associated to a calendar entry." - }, - "category": { - "type": "string", - "description": "Business category : intervention for example or to be more precise after SalesIntervention, orderDeliveryIntervention,..." - }, - "contactMedium": { - "type": "array", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "Appointment creation date" - }, - "description": { - "type": "string", - "description": "Short free text describing the appointment" - }, - "externalId": { - "type": "string", - "description": "External reference known by the customer" - }, - "href": { - "type": "string", - "description": "Unique URI used to access to the appointment resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of the appointment" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date of last appointment update" - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "relatedPlace": { - "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue", - "description": "Related place defines (by reference or value) the place where the appointment will take place." - }, - "relatedEntity": { - "type": "array", - "items": { - "$ref": "../Common/RelatedEntity.schema.json#RelatedEntity" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "status": { - "$ref": "AppointmentStateType.schema.json#/definitions/AppointmentStateType" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ], - "required": [ - "validFor" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Appointment.schema.json", + "title": "Appointment", + "definitions": { + "Appointment": { + "$id": "#Appointment", + "type": "object", + "description": "An Appointment is an arrangement to do something or meet someone at a particular time, at a place (for face to face appointment) or in a contact medium (for phone appointment).", + "properties": { + "attachment": { + "type": "array", + "items": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + } + }, + "calendarEvent": { + "$ref": "../Common/CalendarEventRef.schema.json#CalendarEventRef", + "description": "A calendar event reference (CalendarEventRef). The appointment is associated with a calendar event (an happening at a point of time) associated to a calendar entry." + }, + "category": { + "type": "string", + "description": "Business category : intervention for example or to be more precise after SalesIntervention, orderDeliveryIntervention,..." + }, + "contactMedium": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "Appointment creation date" + }, + "description": { + "type": "string", + "description": "Short free text describing the appointment" + }, + "externalId": { + "type": "string", + "description": "External reference known by the customer" + }, + "href": { + "type": "string", + "description": "Unique URI used to access to the appointment resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of the appointment" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date of last appointment update" + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "relatedPlace": { + "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue", + "description": "Related place defines (by reference or value) the place where the appointment will take place." + }, + "relatedEntity": { + "type": "array", + "items": { + "$ref": "../Common/RelatedEntity.schema.json#RelatedEntity" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "status": { + "$ref": "AppointmentStateType.schema.json#AppointmentStateType" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ], + "required": [ + "validFor" + ] } + } } \ No newline at end of file diff --git a/Customer/AppointmentRef.schema.json b/Customer/AppointmentRef.schema.json index c21ca622..4a0452a9 100644 --- a/Customer/AppointmentRef.schema.json +++ b/Customer/AppointmentRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppointmentRef.schema.json", - "title": "AppointmentRef", - "definitions": { - "AppointmentRef": { - "$id": "#AppointmentRef", - "description": "Refers an appointment, such as a Customer presentation or internal meeting or site visit", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "An explanatory text regarding the appointment made with a party" - }, - "href": { - "type": "string", - "description": "The reference of the appointment" - }, - "id": { - "type": "string", - "description": "The identifier of the referred appointment" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppointmentRef.schema.json", + "title": "AppointmentRef", + "definitions": { + "AppointmentRef": { + "$id": "#AppointmentRef", + "description": "Refers an appointment, such as a Customer presentation or internal meeting or site visit", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "An explanatory text regarding the appointment made with a party" + }, + "href": { + "type": "string", + "description": "The reference of the appointment" + }, + "id": { + "type": "string", + "description": "The identifier of the referred appointment" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/AppointmentStateType.schema.json b/Customer/AppointmentStateType.schema.json index 3775c312..fde1bca9 100644 --- a/Customer/AppointmentStateType.schema.json +++ b/Customer/AppointmentStateType.schema.json @@ -1,19 +1,19 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppointmentStateType.schema.json", - "title": "AppointmentStateType", - "definitions": { - "AppointmentStateType": { - "$id": "#AppointmentStateType", - "type": "string", - "description": "Valid values for the lifecycle state of the appointment", - "enum": [ - "initialized", - "confirmed", - "cancelled", - "completed", - "failed" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppointmentStateType.schema.json", + "title": "AppointmentStateType", + "definitions": { + "AppointmentStateType": { + "$id": "#AppointmentStateType", + "type": "string", + "description": "Valid values for the lifecycle state of the appointment", + "enum": [ + "initialized", + "confirmed", + "cancelled", + "completed", + "failed" + ] } + } } \ No newline at end of file diff --git a/Customer/AppointmentStateValues.schema.json b/Customer/AppointmentStateValues.schema.json index 6462bf47..c86fe500 100644 --- a/Customer/AppointmentStateValues.schema.json +++ b/Customer/AppointmentStateValues.schema.json @@ -1,18 +1,19 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppointmentStateValues.schema.json", - "title": "AppointmentStateValues", - "definitions": { - "AppointmentStateValues": { - "type": "string", - "description": "", - "enum": [ - "initialized", - "confirmed", - "cancelled", - "completed", - "failed" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppointmentStateValues.schema.json", + "title": "AppointmentStateValues", + "definitions": { + "AppointmentStateValues": { + "$id": "#AppointmentStateValues", + "type": "string", + "description": "", + "enum": [ + "initialized", + "confirmed", + "cancelled", + "completed", + "failed" + ] } + } } \ No newline at end of file diff --git a/Customer/Authorization.schema.json b/Customer/Authorization.schema.json index 3d3a1f8c..cda02c4d 100644 --- a/Customer/Authorization.schema.json +++ b/Customer/Authorization.schema.json @@ -1,47 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Authorization.schema.json", - "title": "Authorization", - "definitions": { - "Authorization": { - "$id": "#Authorization", - "description": "If special discount or special product offering price or specific condition need an approval for ISP sale representative it is described here.", - "type": "object", - "properties": { - "givenDate": { - "type": "string", - "format" : "date-time", - "description": "Date when the authorization (approved or declined) was done" - }, - "name": { - "type": "string", - "description": "Name of the required authorization" - }, - "requestedDate": { - "type": "string", - "format" : "date-time", - "description": "Date when the authorization is requested for" - }, - "signatureRepresentation": { - "type": "string", - "description": "To describe a digital or manual signature" - }, - "state": { - "type": "string", - "description": "State of the authorization, such as: approved or declined" - }, - "approver": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Authorization.schema.json", + "title": "Authorization", + "definitions": { + "Authorization": { + "$id": "#Authorization", + "description": "If special discount or special product offering price or specific condition need an approval for ISP sale representative it is described here.", + "type": "object", + "properties": { + "givenDate": { + "type": "string", + "format": "date-time", + "description": "Date when the authorization (approved or declined) was done" + }, + "name": { + "type": "string", + "description": "Name of the required authorization" + }, + "requestedDate": { + "type": "string", + "format": "date-time", + "description": "Date when the authorization is requested for" + }, + "signatureRepresentation": { + "type": "string", + "description": "To describe a digital or manual signature" + }, + "state": { + "type": "string", + "description": "State of the authorization, such as: approved or declined" + }, + "approver": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/BalanceActionRequestRef.schema.json b/Customer/BalanceActionRequestRef.schema.json index 03c184eb..480d28f8 100644 --- a/Customer/BalanceActionRequestRef.schema.json +++ b/Customer/BalanceActionRequestRef.schema.json @@ -1,24 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceActionRequestRef.schema.json", - "title": "BalanceActionRequestRef", - "definitions": { - "BalanceActionRequestRef": { - "description": "link to the resource that holds balance-related request information", - "properties": { - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the request information for the balance-related action" - }, - "id": { - "type": "string", - "description": "Unique identifier for the balance related action request" - } - }, - "required": [ - "id", - "href" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceActionRequestRef.schema.json", + "title": "BalanceActionRequestRef", + "definitions": { + "BalanceActionRequestRef": { + "$id": "#BalanceActionRequestRef", + "description": "link to the resource that holds balance-related request information", + "properties": { + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the request information for the balance-related action" + }, + "id": { + "type": "string", + "description": "Unique identifier for the balance related action request" } + }, + "required": [ + "id", + "href" + ], + "type": "object" } -} + } +} \ No newline at end of file diff --git a/Customer/BalanceActivity.schema.json b/Customer/BalanceActivity.schema.json index f7af0f37..ca857b79 100644 --- a/Customer/BalanceActivity.schema.json +++ b/Customer/BalanceActivity.schema.json @@ -1,63 +1,65 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceActivity.schema.json", - "title": "BalanceActivity", - "definitions": { - "BalanceActivity": { - "description": "The BalanceActivity resource is a detailed description of a specific balance-related action that has happened over a given bucket balance. Typically a recharge/transfer/adjustment request creates one activity, but a request for an auto-topup operation actually triggers multiple periodic balance-related activities.", - "properties": { - "action": { - "description": "A reference to the balance-related operation that triggered the action", - "$ref": "BalanceActionRequestRef.schema.json#/definitions/BalanceActionRequestRef" - }, - "amount": { - "description": "Amount (can be monetary or non-monetary) that was involved in the balance operation", - "$ref": "QuantityType.schema.json#/definitions/QuantityType" - }, - "amountAfter": { - "description": "Remained amount in the bucket involved in the operation after it took place", - "$ref": "QuantityType.schema.json#/definitions/QuantityType" - }, - "amountBefore": { - "description": "Remained amount in the bucket involved in the operation before it took place", - "$ref": "QuantityType.schema.json#/definitions/QuantityType" - }, - "bucketBalance": { - "description": "A reference to the bucket involved in the balance-related operation", - "$ref": "BucketBalanceRef.schema.json#/definitions/BucketBalanceRef" - }, - "date": { - "type": "string", - "description": "Date when the balance related operation took place" - }, - "partyAccount": { - "description": "A reference to the account that owns the bucket impacted by the balance activity", - "$ref": "PartyAccountRef.schema.json#/definitions/PartyAccountRef" - }, - "product": { - "description": "A reference to the product related to the bucket that is impacted by the balance activity", - "$ref": "ProductRef.schema.json#/definitions/ProductRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedPartyRef.schema.json#/definitions/RelatedPartyRef" - }, - "description": "Used to provide information about any other entity with relation to the balance activity" - }, - "type": { - "type": "string", - "description": "A preconfigured value that describes a type of balance-related performed (topup, transfer, adjustment)" - } - }, - "required": [ - "type", - "date", - "action", - "amount", - "bucketBalance", - "product" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceActivity.schema.json", + "title": "BalanceActivity", + "definitions": { + "BalanceActivity": { + "$id": "#BalanceActivity", + "description": "The BalanceActivity resource is a detailed description of a specific balance-related action that has happened over a given bucket balance. Typically a recharge/transfer/adjustment request creates one activity, but a request for an auto-topup operation actually triggers multiple periodic balance-related activities.", + "properties": { + "action": { + "description": "A reference to the balance-related operation that triggered the action", + "$ref": "BalanceActionRequestRef.schema.json#BalanceActionRequestRef" + }, + "amount": { + "description": "Amount (can be monetary or non-monetary) that was involved in the balance operation", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "amountAfter": { + "description": "Remained amount in the bucket involved in the operation after it took place", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "amountBefore": { + "description": "Remained amount in the bucket involved in the operation before it took place", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "bucketBalance": { + "description": "A reference to the bucket involved in the balance-related operation", + "$ref": "BucketBalanceRef.schema.json#BucketBalanceRef" + }, + "date": { + "type": "string", + "description": "Date when the balance related operation took place" + }, + "partyAccount": { + "description": "A reference to the account that owns the bucket impacted by the balance activity", + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "product": { + "description": "A reference to the product related to the bucket that is impacted by the balance activity", + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "description": "Used to provide information about any other entity with relation to the balance activity" + }, + "type": { + "type": "string", + "description": "A preconfigured value that describes a type of balance-related performed (topup, transfer, adjustment)" } + }, + "required": [ + "type", + "date", + "action", + "amount", + "bucketBalance", + "product" + ], + "type": "object" } -} + } +} \ No newline at end of file diff --git a/Customer/BalanceAdjustment.schema.json b/Customer/BalanceAdjustment.schema.json index ddcbb57c..8fbb5bd8 100644 --- a/Customer/BalanceAdjustment.schema.json +++ b/Customer/BalanceAdjustment.schema.json @@ -1,10 +1,12 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceAdjustment.schema.json", - "title": "BalanceAdjustment", - "definitions": { - "BalanceAdjustment": { - "description": "#TODO" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceAdjustment.schema.json", + "title": "BalanceAdjustment", + "definitions": { + "BalanceAdjustment": { + "$id": "#BalanceAdjustment", + "description": "#TODO", + "type": "object" } + } } \ No newline at end of file diff --git a/Customer/BalanceAdjustmentBody.schema.json b/Customer/BalanceAdjustmentBody.schema.json index 0bafed72..ad25e35d 100644 --- a/Customer/BalanceAdjustmentBody.schema.json +++ b/Customer/BalanceAdjustmentBody.schema.json @@ -1,32 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceAdjustmentBody.schema.json", - "title": "BalanceAdjustmentBody", - "definitions": { - "BalanceAdjustmentBody": { - "properties": { - "amount": { - "description": "Amount (can be monetary or non-monetary) to be recharged in the bucket. It could refer to positive (increment) or negative (decrement) values", - "$ref": "QuantityType.schema.json#/definitions/QuantityType" - }, - "product": { - "description": "A reference to the product related to the bucket that is impacted by the balance related operation", - "$ref": "ProductRef.schema.json#/definitions/ProductRef" - }, - "reason": { - "type": "string", - "description": "Text describing the reason for the adjustment" - }, - "type": { - "type": "string", - "description": "A preconfigured value that describes a TopUp type which determines the prepay balance bucket in which the top-up is done (national-voice, roaming-voice, promotional-voice, data, ....)" - } - }, - "required": [ - "type", - "reason", - "amount" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceAdjustmentBody.schema.json", + "title": "BalanceAdjustmentBody", + "definitions": { + "BalanceAdjustmentBody": { + "$id": "#BalanceAdjustmentBody", + "properties": { + "amount": { + "description": "Amount (can be monetary or non-monetary) to be recharged in the bucket. It could refer to positive (increment) or negative (decrement) values", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "product": { + "description": "A reference to the product related to the bucket that is impacted by the balance related operation", + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "reason": { + "type": "string", + "description": "Text describing the reason for the adjustment" + }, + "type": { + "type": "string", + "description": "A preconfigured value that describes a TopUp type which determines the prepay balance bucket in which the top-up is done (national-voice, roaming-voice, promotional-voice, data, ....)" } + }, + "required": [ + "type", + "reason", + "amount" + ], + "type": "object" } -} + } +} \ No newline at end of file diff --git a/Customer/BalanceAdjustmentRequest.schema.json b/Customer/BalanceAdjustmentRequest.schema.json index 8eebb1e2..e6725fc9 100644 --- a/Customer/BalanceAdjustmentRequest.schema.json +++ b/Customer/BalanceAdjustmentRequest.schema.json @@ -1,62 +1,64 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceAdjustmentRequest.schema.json", - "title": "BalanceAdjustmentRequest", - "definitions": { - "BalanceAdjustmentRequest": { - "description": "the BalanceAdjustment resource is a detailed description of credit adjustment operation erformed on a given bucket (defined by a specific product or reference to a product (i.e.: a commercial id such as an msisidn) and a service type)", - "properties": { - "bucket": { - "description": "A reference to the bucket impacted by the request. This is used in scenarios where the requestor knows beforehand the bucket that is going to be impacted instead of just referring to the commercial identifier of the impacted product and the type of bucket created under that product", - "$ref": "BucketBalanceRef.schema.json#/definitions/BucketBalanceRef" - }, - "description": { - "type": "string", - "description": "Description of the recharge operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information. This is typically the resource url to retrieve individual top-up operation details" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the balance adjustment operation request" - }, - "partyAccount": { - "description": "A reference to the account that owns the bucket impacted by the balance related operation", - "$ref": "PartyAccountRef.schema.json#/definitions/PartyAccountRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedPartyRef.schema.json#/definitions/RelatedPartyRef" - }, - "description": "Used to provide information about any other entity with relation to the operation" - }, - "requestedDate": { - "type": "string", - "description": "Date when the top-up request was received in the server" - }, - "requestor": { - "description": "Identifier for the user/customer/entity that performs the top-up action. This can be used to indicate the identifier of an agent that performs the operation on behalf of a user via a customer service channel. Structure including at least attributes \ufffdrole\ufffd and \ufffdname\ufffd.", - "$ref": "RelatedPartyRef.schema.json#/definitions/RelatedPartyRef" - }, - "validFor": { - "description": "The period defined for the adjusted amount to be part of the prepay balance. This could be used to define expiration times to remove balance not consumed.", - "$ref": "TimePeriodType.schema.json#/definitions/TimePeriodType" - } - }, - "allOf": [ - { - "$ref": "BalanceAdjustmentBody.schema.json#/definitions/BalanceAdjustmentBody" - } - ], - "required": [ - "id", - "href", - "requestedDate", - "product" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceAdjustmentRequest.schema.json", + "title": "BalanceAdjustmentRequest", + "definitions": { + "BalanceAdjustmentRequest": { + "$id": "#BalanceAdjustmentRequest", + "description": "the BalanceAdjustment resource is a detailed description of credit adjustment operation erformed on a given bucket (defined by a specific product or reference to a product (i.e.: a commercial id such as an msisidn) and a service type)", + "properties": { + "bucket": { + "description": "A reference to the bucket impacted by the request. This is used in scenarios where the requestor knows beforehand the bucket that is going to be impacted instead of just referring to the commercial identifier of the impacted product and the type of bucket created under that product", + "$ref": "BucketBalanceRef.schema.json#BucketBalanceRef" + }, + "description": { + "type": "string", + "description": "Description of the recharge operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information. This is typically the resource url to retrieve individual top-up operation details" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the balance adjustment operation request" + }, + "partyAccount": { + "description": "A reference to the account that owns the bucket impacted by the balance related operation", + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "description": "Used to provide information about any other entity with relation to the operation" + }, + "requestedDate": { + "type": "string", + "description": "Date when the top-up request was received in the server" + }, + "requestor": { + "description": "Identifier for the user/customer/entity that performs the top-up action. This can be used to indicate the identifier of an agent that performs the operation on behalf of a user via a customer service channel. Structure including at least attributes �role� and �name�.", + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "validFor": { + "description": "The period defined for the adjusted amount to be part of the prepay balance. This could be used to define expiration times to remove balance not consumed.", + "$ref": "../Common/TimePeriodType.schema.json#TimePeriodType" } + }, + "allOf": [ + { + "$ref": "BalanceAdjustmentBody.schema.json#BalanceAdjustmentBody" + } + ], + "required": [ + "id", + "href", + "requestedDate", + "product" + ], + "type": "object" } -} + } +} \ No newline at end of file diff --git a/Customer/BalanceDeduct.schema.json b/Customer/BalanceDeduct.schema.json index 412da80c..640058f2 100644 --- a/Customer/BalanceDeduct.schema.json +++ b/Customer/BalanceDeduct.schema.json @@ -1,64 +1,64 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceDeduct.schema.json", - "title": "BalanceDeduct", - "definitions": { - "BalanceDeduct": { - "$id": "#BalanceDeduct", - "description": "The Balance Deduct task resource is a detailed description of deduction operation. If balanceReserve Resource ID is contained in the deduct request message, the reserved balance will be performed deduct operation (if part of the reserved balance is deducted, the remain amount will be released); if balanceReserve Resource ID is not contained in the deduct request message, the balance will be deducted directly.", - "type": "object", - "properties": { - "confirmationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the deduction was confirmed in the server" - }, - "description": { - "type": "string", - "description": "Description of the deduct operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a deduction" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the deduction operation request" - }, - "requestedDate": { - "type": "string", - "format": "date-time", - "description": "Date when the deduction request was received in the server" - }, - "status": { - "type": "string", - "description": "Status of the deduction operation" - }, - "deductType": { - "type": "string", - "description": "A preconfigured value that describes a deduct type which determines the prepay balance bucket in which the deduct is done" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "product": { - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "balanceReserve": { - "$ref": "BalanceReserveRef.schema.json#BalanceReserveRef" - }, - "requestor": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "partyAccount": { - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceDeduct.schema.json", + "title": "BalanceDeduct", + "definitions": { + "BalanceDeduct": { + "$id": "#BalanceDeduct", + "description": "The Balance Deduct task resource is a detailed description of deduction operation. If balanceReserve Resource ID is contained in the deduct request message, the reserved balance will be performed deduct operation (if part of the reserved balance is deducted, the remain amount will be released); if balanceReserve Resource ID is not contained in the deduct request message, the balance will be deducted directly.", + "type": "object", + "properties": { + "confirmationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the deduction was confirmed in the server" + }, + "description": { + "type": "string", + "description": "Description of the deduct operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a deduction" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the deduction operation request" + }, + "requestedDate": { + "type": "string", + "format": "date-time", + "description": "Date when the deduction request was received in the server" + }, + "status": { + "type": "string", + "description": "Status of the deduction operation" + }, + "deductType": { + "type": "string", + "description": "A preconfigured value that describes a deduct type which determines the prepay balance bucket in which the deduct is done" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "product": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "balanceReserve": { + "$ref": "BalanceReserveRef.schema.json#BalanceReserveRef" + }, + "requestor": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "partyAccount": { + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/BalanceDeductRef.schema.json b/Customer/BalanceDeductRef.schema.json index 8c0ab7cc..1b1fa6fd 100644 --- a/Customer/BalanceDeductRef.schema.json +++ b/Customer/BalanceDeductRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceDeductRef.schema.json", - "title": "BalanceDeductRef", - "definitions": { - "BalanceDeductRef": { - "$id": "#BalanceDeductRef", - "description": "the resource that deduct balance information", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the balance information for a subscription" - }, - "id": { - "type": "string", - "description": "Unique identifier for the balancededuct entity" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceDeductRef.schema.json", + "title": "BalanceDeductRef", + "definitions": { + "BalanceDeductRef": { + "$id": "#BalanceDeductRef", + "description": "the resource that deduct balance information", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the balance information for a subscription" + }, + "id": { + "type": "string", + "description": "Unique identifier for the balancededuct entity" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/BalanceDeductRollback.schema.json b/Customer/BalanceDeductRollback.schema.json index 5506fc53..c1d9660f 100644 --- a/Customer/BalanceDeductRollback.schema.json +++ b/Customer/BalanceDeductRollback.schema.json @@ -1,55 +1,55 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceDeductRollback.schema.json", - "title": "BalanceDeductRollback", - "definitions": { - "BalanceDeductRollback": { - "$id": "#BalanceDeductRollback", - "description": "The Rollback Balance Deduct task resource is a detailed description of rollback deduction", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the rollback deduct operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a rollback deduction" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the rollback deduction operation request" - }, - "requestedDate": { - "type": "string", - "format": "date-time", - "description": "Date when the rollback deduction request was received in the server" - }, - "status": { - "type": "string", - "description": "Status of the rollback deduction operation" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "product": { - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "partyAccount": { - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - }, - "balanceDeduct": { - "$ref": "BalanceDeductRef.schema.json#BalanceDeductRef" - }, - "requestor": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceDeductRollback.schema.json", + "title": "BalanceDeductRollback", + "definitions": { + "BalanceDeductRollback": { + "$id": "#BalanceDeductRollback", + "description": "The Rollback Balance Deduct task resource is a detailed description of rollback deduction", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the rollback deduct operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a rollback deduction" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the rollback deduction operation request" + }, + "requestedDate": { + "type": "string", + "format": "date-time", + "description": "Date when the rollback deduction request was received in the server" + }, + "status": { + "type": "string", + "description": "Status of the rollback deduction operation" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "product": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "partyAccount": { + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "balanceDeduct": { + "$ref": "BalanceDeductRef.schema.json#BalanceDeductRef" + }, + "requestor": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/BalanceReserve.schema.json b/Customer/BalanceReserve.schema.json index 1f6cb6ca..b6ec7b23 100644 --- a/Customer/BalanceReserve.schema.json +++ b/Customer/BalanceReserve.schema.json @@ -1,79 +1,79 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceReserve.schema.json", - "title": "BalanceReserve", - "definitions": { - "BalanceReserve": { - "$id": "#BalanceReserve", - "description": "The Balance Reserve Operation resource is a detailed description of a balance reserve operation requested over a subscription", - "type": "object", - "properties": { - "confirmationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the reserve request was confirmed in the server" - }, - "description": { - "type": "string", - "description": "Description of the reserve operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a reserve" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the reserve operation request" - }, - "isAutoDeduct": { - "type": "boolean", - "description": "Indicates if the reserved balance is auto deducted after a time period" - }, - "remainedAmount": { - "type": "number", - "format": "float", - "description": "Amount (can be monetary or non-monetary) to be remained in the bucket" - }, - "requestedDate": { - "type": "string", - "format": "date-time", - "description": "Date when the reserve request was received in the server" - }, - "reservedAmount": { - "type": "number", - "format": "float", - "description": "Amount (can be monetary or non-monetary) to be reserved in the bucket" - }, - "status": { - "type": "string", - "description": "Status of the reserve operation" - }, - "reserveType": { - "type": "string", - "description": "A preconfigured value that describes a reserve type which determines the prepay balance bucket in which the reserve is done" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Indicates if the reserved balance is auto deducted after a time period" - }, - "requestor": { - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - }, - "product": { - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "partyAccount": { - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceReserve.schema.json", + "title": "BalanceReserve", + "definitions": { + "BalanceReserve": { + "$id": "#BalanceReserve", + "description": "The Balance Reserve Operation resource is a detailed description of a balance reserve operation requested over a subscription", + "type": "object", + "properties": { + "confirmationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the reserve request was confirmed in the server" + }, + "description": { + "type": "string", + "description": "Description of the reserve operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a reserve" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the reserve operation request" + }, + "isAutoDeduct": { + "type": "boolean", + "description": "Indicates if the reserved balance is auto deducted after a time period" + }, + "remainedAmount": { + "type": "number", + "format": "float", + "description": "Amount (can be monetary or non-monetary) to be remained in the bucket" + }, + "requestedDate": { + "type": "string", + "format": "date-time", + "description": "Date when the reserve request was received in the server" + }, + "reservedAmount": { + "type": "number", + "format": "float", + "description": "Amount (can be monetary or non-monetary) to be reserved in the bucket" + }, + "status": { + "type": "string", + "description": "Status of the reserve operation" + }, + "reserveType": { + "type": "string", + "description": "A preconfigured value that describes a reserve type which determines the prepay balance bucket in which the reserve is done" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Indicates if the reserved balance is auto deducted after a time period" + }, + "requestor": { + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "product": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "partyAccount": { + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/BalanceReserveRef.schema.json b/Customer/BalanceReserveRef.schema.json index 5c19a470..466fbc8d 100644 --- a/Customer/BalanceReserveRef.schema.json +++ b/Customer/BalanceReserveRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceReserveRef.schema.json", - "title": "BalanceReserveRef", - "definitions": { - "BalanceReserveRef": { - "$id": "#BalanceReserveRef", - "description": "the resource that holds reserved balance information", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the balance information for a subscription" - }, - "id": { - "type": "string", - "description": "Unique identifier for the balancereserve entity" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceReserveRef.schema.json", + "title": "BalanceReserveRef", + "definitions": { + "BalanceReserveRef": { + "$id": "#BalanceReserveRef", + "description": "the resource that holds reserved balance information", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the balance information for a subscription" + }, + "id": { + "type": "string", + "description": "Unique identifier for the balancereserve entity" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/BalanceTopup.schema.json b/Customer/BalanceTopup.schema.json index bf9d6f48..1ca77014 100644 --- a/Customer/BalanceTopup.schema.json +++ b/Customer/BalanceTopup.schema.json @@ -1,10 +1,12 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTopup.schema.json", - "title": "BalanceTopup", - "definitions": { - "BalanceTopup": { - "description": "#TODO" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTopup.schema.json", + "title": "BalanceTopup", + "definitions": { + "BalanceTopup": { + "$id": "#BalanceTopup", + "description": "#TODO", + "type": "object" } + } } \ No newline at end of file diff --git a/Customer/BalanceTopupBody.schema.json b/Customer/BalanceTopupBody.schema.json index 54ff59e4..bc3a800e 100644 --- a/Customer/BalanceTopupBody.schema.json +++ b/Customer/BalanceTopupBody.schema.json @@ -1,32 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTopupBody.schema.json", - "title": "BalanceTopupBody", - "definitions": { - "BalanceTopupBody": { - "properties": { - "amount": { - "description": "Amount (can be monetary or non-monetary) to be recharged in the bucket", - "$ref": "QuantityType.schema.json#/definitions/QuantityType" - }, - "channel": { - "description": "Indicator for the channel used to request the top-up operation. Structure including at least attribute \ufffdname\ufffd", - "$ref": "ChannelRef.schema.json#/definitions/ChannelRef" - }, - "product": { - "description": "A reference to the product related to the bucket that is impacted by the balance related operation", - "$ref": "ProductRef.schema.json#/definitions/ProductRef" - }, - "type": { - "type": "string", - "description": "A preconfigured value that describes a TopUp type which determines the prepay balance bucket in which the top-up is done (national-voice, roaming-voice, promotional-voice, data, ....)" - } - }, - "required": [ - "type", - "channel", - "amount" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTopupBody.schema.json", + "title": "BalanceTopupBody", + "definitions": { + "BalanceTopupBody": { + "$id": "#BalanceTopupBody", + "properties": { + "amount": { + "description": "Amount (can be monetary or non-monetary) to be recharged in the bucket", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "channel": { + "description": "Indicator for the channel used to request the top-up operation. Structure including at least attribute �name�", + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "product": { + "description": "A reference to the product related to the bucket that is impacted by the balance related operation", + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "type": { + "type": "string", + "description": "A preconfigured value that describes a TopUp type which determines the prepay balance bucket in which the top-up is done (national-voice, roaming-voice, promotional-voice, data, ....)" } + }, + "required": [ + "type", + "channel", + "amount" + ], + "type": "object" } -} + } +} \ No newline at end of file diff --git a/Customer/BalanceTopupRequest.schema.json b/Customer/BalanceTopupRequest.schema.json index e704c7fd..3bf0e1c7 100644 --- a/Customer/BalanceTopupRequest.schema.json +++ b/Customer/BalanceTopupRequest.schema.json @@ -1,97 +1,99 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTopupRequest.schema.json", - "title": "BalanceTopupRequest", - "definitions": { - "BalanceTopupRequest": { - "description": "Represents a detailed description of a recharge operation requested over a bucket (defined by a specific product or reference to a product (i.e.: a commercial id such as an msisidn) and a service type)", - "properties": { - "bucket": { - "description": "A reference to the bucket impacted by the request. This is used in scenarios where the requestor knows beforehand the bucket that is going to be impacted instead of just referring to the commercial identifier of the impacted product and the type of bucket created under that product", - "$ref": "BucketBalanceRef.schema.json#/definitions/BucketBalanceRef" - }, - "confirmationDate": { - "type": "string", - "description": "Date when the top-up was confirmed in the server" - }, - "description": { - "type": "string", - "description": "Description of the recharge operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information. This is typically the resource url to retrieve individual top-up operation details" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the recharge operation request" - }, - "isAutoTopup": { - "type": "boolean", - "description": "Indicates if the topup requested is an autotopup (to be processed periodically)" - }, - "nrOfPeriods": { - "type": "integer", - "description": "For autotopup indicates the number of occurrences of the period the recharge operation must be executed. If not included then no limit is set to stop the executionof the topup every period" - }, - "partyAccount": { - "description": "A reference to the account that owns the bucket impacted by the balance related operation", - "$ref": "PartyAccountRef.schema.json#/definitions/PartyAccountRef" - }, - "paymentMethod": { - "description": "Payment method used for the recharge operation (e.g.: cash, credit card, \ufffd). Structure including at least attribute \ufffdname\ufffd. Notice that the use of a voucher can be managed as a specific methodtype, where he voucher code can be passed as value.", - "$ref": "PaymentMethodRefOrValue.schema.json#/definitions/PaymentMethodRefOrValue" - }, - "recurringPeriod": { - "type": "string", - "description": "For autotopup indicates the periodicity for the recharge operation (monthly, weekly, )" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedPartyRef.schema.json#/definitions/RelatedPartyRef" - }, - "description": "Used to provide information about any other entity with relation to the operation" - }, - "requestedDate": { - "type": "string", - "description": "Date when the top-up request was received in the server" - }, - "requestor": { - "description": "Identifier for the user/customer/entity that performs the top-up action. This can be used to indicate the identifier of an agent that performs the operation on behalf of a user via a customer service channel. Structure including at least attributes \ufffdrole\ufffd and \ufffdname\ufffd.", - "$ref": "RelatedPartyRef.schema.json#/definitions/RelatedPartyRef" - }, - "status": { - "type": "string", - "description": "Status of the top-up operation Supported values are: - confirmed - cancelled - in progress", - "enum": [ - "confirmed", - "cancelled", - "in progress" - ] - }, - "validFor": { - "description": "The period defined for the recharged amount to be part of the prepay balance. This could be used to define expiration times to remove balance not consumed.", - "$ref": "TimePeriodType.schema.json#/definitions/TimePeriodType" - }, - "voucher": { - "type": "string", - "description": "Identifier for the voucher when the topup can be perfomed by this means (referenced by a voucher based payment mean). This attribute is left in this release to keep compatibility with previous version and for implementations that do not relay on paymentMethods. A voucher can be managed as a specific methodtype, where he voucher code can be passed as value." - } - }, - "allOf": [ - { - "$ref": "BalanceTopupBody.schema.json#/definitions/BalanceTopupBody" - } - ], - "required": [ - "id", - "href", - "validFor", - "requestedDate", - "confirmationDate", - "status" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTopupRequest.schema.json", + "title": "BalanceTopupRequest", + "definitions": { + "BalanceTopupRequest": { + "$id": "#BalanceTopupRequest", + "description": "Represents a detailed description of a recharge operation requested over a bucket (defined by a specific product or reference to a product (i.e.: a commercial id such as an msisidn) and a service type)", + "properties": { + "bucket": { + "description": "A reference to the bucket impacted by the request. This is used in scenarios where the requestor knows beforehand the bucket that is going to be impacted instead of just referring to the commercial identifier of the impacted product and the type of bucket created under that product", + "$ref": "BucketBalanceRef.schema.json#BucketBalanceRef" + }, + "confirmationDate": { + "type": "string", + "description": "Date when the top-up was confirmed in the server" + }, + "description": { + "type": "string", + "description": "Description of the recharge operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information. This is typically the resource url to retrieve individual top-up operation details" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the recharge operation request" + }, + "isAutoTopup": { + "type": "boolean", + "description": "Indicates if the topup requested is an autotopup (to be processed periodically)" + }, + "nrOfPeriods": { + "type": "integer", + "description": "For autotopup indicates the number of occurrences of the period the recharge operation must be executed. If not included then no limit is set to stop the executionof the topup every period" + }, + "partyAccount": { + "description": "A reference to the account that owns the bucket impacted by the balance related operation", + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "paymentMethod": { + "description": "Payment method used for the recharge operation (e.g.: cash, credit card, �). Structure including at least attribute �name�. Notice that the use of a voucher can be managed as a specific methodtype, where he voucher code can be passed as value.", + "$ref": "PaymentMethodRefOrValue.schema.json#PaymentMethodRefOrValue" + }, + "recurringPeriod": { + "type": "string", + "description": "For autotopup indicates the periodicity for the recharge operation (monthly, weekly, )" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "description": "Used to provide information about any other entity with relation to the operation" + }, + "requestedDate": { + "type": "string", + "description": "Date when the top-up request was received in the server" + }, + "requestor": { + "description": "Identifier for the user/customer/entity that performs the top-up action. This can be used to indicate the identifier of an agent that performs the operation on behalf of a user via a customer service channel. Structure including at least attributes �role� and �name�.", + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "status": { + "type": "string", + "description": "Status of the top-up operation Supported values are: - confirmed - cancelled - in progress", + "enum": [ + "confirmed", + "cancelled", + "in progress" + ] + }, + "validFor": { + "description": "The period defined for the recharged amount to be part of the prepay balance. This could be used to define expiration times to remove balance not consumed.", + "$ref": "../Common/TimePeriodType.schema.json#TimePeriodType" + }, + "voucher": { + "type": "string", + "description": "Identifier for the voucher when the topup can be perfomed by this means (referenced by a voucher based payment mean). This attribute is left in this release to keep compatibility with previous version and for implementations that do not relay on paymentMethods. A voucher can be managed as a specific methodtype, where he voucher code can be passed as value." } + }, + "allOf": [ + { + "$ref": "BalanceTopupBody.schema.json#BalanceTopupBody" + } + ], + "required": [ + "id", + "href", + "validFor", + "requestedDate", + "confirmationDate", + "status" + ], + "type": "object" } -} + } +} \ No newline at end of file diff --git a/Customer/BalanceTopupStatus.schema.json b/Customer/BalanceTopupStatus.schema.json index a41cc93b..95b874e8 100644 --- a/Customer/BalanceTopupStatus.schema.json +++ b/Customer/BalanceTopupStatus.schema.json @@ -1,24 +1,24 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTopupStatus.schema.json", - "title": "BalanceTopupStatus", - "definitions": { - "BalanceTopupStatusType": { - "description": "Structure including specific information about change of status for the topup operation", - "properties": { - "statusChangeDate": { - "type": "string", - "description": "Date in which the latest change of status was requested" - } - }, - "allOf": [ - { - "$ref": "BalanceTopupStatusTypeModify.schema.json#/definitions/BalanceTopupStatusTypeModify" - } - ], - "required": [ - "statusChangeDate" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTopupStatus.schema.json", + "title": "BalanceTopupStatus", + "definitions": { + "BalanceTopupStatus": { + "description": "Structure including specific information about change of status for the topup operation", + "properties": { + "statusChangeDate": { + "type": "string", + "description": "Date in which the latest change of status was requested" } + }, + "allOf": [ + { + "$ref": "BalanceTopupStatusTypeModify.schema.json#/definitions/BalanceTopupStatusTypeModify" + } + ], + "required": [ + "statusChangeDate" + ] } -} + } +} \ No newline at end of file diff --git a/Customer/BalanceTopupStatusTypeModify.schema.json b/Customer/BalanceTopupStatusTypeModify.schema.json index ecf49d35..c6ac437c 100644 --- a/Customer/BalanceTopupStatusTypeModify.schema.json +++ b/Customer/BalanceTopupStatusTypeModify.schema.json @@ -1,18 +1,20 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTopupStatusTypeModify.schema.json", - "title": "BalanceTopupStatusTypeModify", - "definitions": { - "BalanceTopupStatusTypeModify": { - "properties": { - "status": { - "type": "string", - "description": "Current status of the operation request" - } - }, - "required": [ - "status" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTopupStatusTypeModify.schema.json", + "title": "BalanceTopupStatusTypeModify", + "definitions": { + "BalanceTopupStatusTypeModify": { + "$id": "#BalanceTopupStatusTypeModify", + "properties": { + "status": { + "type": "string", + "description": "Current status of the operation request" } + }, + "required": [ + "status" + ], + "type": "object" } + } } \ No newline at end of file diff --git a/Customer/BalanceTransfer.schema.json b/Customer/BalanceTransfer.schema.json index e94013ce..c708f976 100644 --- a/Customer/BalanceTransfer.schema.json +++ b/Customer/BalanceTransfer.schema.json @@ -1,10 +1,12 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTransfer.schema.json", - "title": "BalanceTransfer", - "definitions": { - "BalanceTransfer": { - "description": "#TODO" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTransfer.schema.json", + "title": "BalanceTransfer", + "definitions": { + "BalanceTransfer": { + "$id": "#BalanceTransfer", + "description": "#TODO", + "type": "object" } + } } \ No newline at end of file diff --git a/Customer/BalanceTransferBody.schema.json b/Customer/BalanceTransferBody.schema.json index 7321b800..68a81e4e 100644 --- a/Customer/BalanceTransferBody.schema.json +++ b/Customer/BalanceTransferBody.schema.json @@ -1,37 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTransferBody.schema.json", - "title": "BalanceTransferBody", - "definitions": { - "BalanceTransferBody": { - "properties": { - "amount": { - "description": "Amount (can be monetary or non-monetary) to be transferred", - "$ref": "QuantityType.schema.json#/definitions/QuantityType" - }, - "channel": { - "description": "Indicator for the channel used to request the top-up operation. Structure including at least attribute \ufffdname\ufffd", - "$ref": "ChannelRef.schema.json#/definitions/ChannelRef" - }, - "product": { - "description": "A reference to the product related to the bucket that is impacted by the balance related operation", - "$ref": "ProductRef.schema.json#/definitions/ProductRef" - }, - "targetId": { - "type": "string", - "description": "Identifier for the entity that receives the transfer (reference to a product via a commercial identifier such as an msisidn that relates to an internal product id)" - }, - "type": { - "type": "string", - "description": "A preconfigured value that describes a TopUp type which determines the prepay balance bucket in which the top-up is done (national-voice, roaming-voice, promotional-voice, data, ....)" - } - }, - "required": [ - "type", - "channel", - "targetId", - "amount" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTransferBody.schema.json", + "title": "BalanceTransferBody", + "definitions": { + "BalanceTransferBody": { + "$id": "#BalanceTransferBody", + "properties": { + "amount": { + "description": "Amount (can be monetary or non-monetary) to be transferred", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "channel": { + "description": "Indicator for the channel used to request the top-up operation. Structure including at least attribute �name�", + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "product": { + "description": "A reference to the product related to the bucket that is impacted by the balance related operation", + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "targetId": { + "type": "string", + "description": "Identifier for the entity that receives the transfer (reference to a product via a commercial identifier such as an msisidn that relates to an internal product id)" + }, + "type": { + "type": "string", + "description": "A preconfigured value that describes a TopUp type which determines the prepay balance bucket in which the top-up is done (national-voice, roaming-voice, promotional-voice, data, ....)" } + }, + "required": [ + "type", + "channel", + "targetId", + "amount" + ], + "type": "object" } -} + } +} \ No newline at end of file diff --git a/Customer/BalanceTransferRequest.schema.json b/Customer/BalanceTransferRequest.schema.json index c645e3d9..fa3b7ed8 100644 --- a/Customer/BalanceTransferRequest.schema.json +++ b/Customer/BalanceTransferRequest.schema.json @@ -1,98 +1,100 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTransferRequest.schema.json", - "title": "BalanceTransferRequest", - "definitions": { - "BalanceTransferRequest": { - "description": "The BalanceTransfer resource is a detailed description of credit transfer operation requested between two buckets (reference to products owned by customers and consuming credit when using a service).", - "properties": { - "bucket": { - "description": "A reference to the bucket impacted by the request. This is used in scenarios where the requestor knows beforehand the bucket that is going to be impacted instead of just referring to the commercial identifier of the impacted product and the type of bucket created under that product", - "$ref": "BucketBalanceRef.schema.json#/definitions/BucketBalanceRef" - }, - "confirmationDate": { - "type": "string", - "description": "Date when the transfer was confirmed in the server" - }, - "costOwner": { - "type": "string", - "description": "Indicates the entity responsible to assume the cost of the transfer operation", - "enum": [ - "originator", - "receiver" - ] - }, - "description": { - "type": "string", - "description": "Description of the transfer operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information. This is typically the resource url to retrieve individual transfer operation details" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the balance transfer operation request." - }, - "partyAccount": { - "description": "A reference to the account that owns the bucket impacted by the balance related operation", - "$ref": "PartyAccountRef.schema.json#/definitions/PartyAccountRef" - }, - "reason": { - "type": "string", - "description": "Text describing the reason for the adjustment" - }, - "receiver": { - "description": "Identifier for the user/customer/entity that receives the transfer action when it is required to indicate additional customer hierarchy information regarding the entity receiving the balance transfer", - "$ref": "RelatedPartyRef.schema.json#/definitions/RelatedPartyRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedPartyRef.schema.json#/definitions/RelatedPartyRef" - }, - "description": "Used to provide information about any other entity with relation to the operation" - }, - "requestedDate": { - "type": "string", - "description": "Date when the transfer request was received in the server" - }, - "requestor": { - "description": "Identifier for the user/customer/entity that performs the top-up action. This can be used to indicate the identifier of an agent that performs the operation on behalf of a user via a customer service channel. Structure including at least attributes \ufffdrole\ufffd and \ufffdname\ufffd.", - "$ref": "RelatedPartyRef.schema.json#/definitions/RelatedPartyRef" - }, - "status": { - "type": "string", - "description": "Status of the top-up.", - "enum": [ - "confirmed", - "cancelled", - "in progress" - ] - }, - "targetType": { - "type": "string", - "description": "Intended for scenarios where the transfer is done from one bucket type to another (from voice to data). A preconfigured value that describes a Transfer type which determines the prepay balance bucket in which the transfer is done" - }, - "transferCost": { - "description": "Associated cost to be charged for the transfer operation (can be monetary or non-monetary)", - "$ref": "QuantityType.schema.json#/definitions/QuantityType" - } - }, - "allOf": [ - { - "$ref": "BalanceTransferBody.schema.json#/definitions/BalanceTransferBody" - } - ], - "required": [ - "id", - "href", - "reason", - "requestedDate", - "confirmationDate", - "status", - "product" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTransferRequest.schema.json", + "title": "BalanceTransferRequest", + "definitions": { + "BalanceTransferRequest": { + "$id": "#BalanceTransferRequest", + "description": "The BalanceTransfer resource is a detailed description of credit transfer operation requested between two buckets (reference to products owned by customers and consuming credit when using a service).", + "properties": { + "bucket": { + "description": "A reference to the bucket impacted by the request. This is used in scenarios where the requestor knows beforehand the bucket that is going to be impacted instead of just referring to the commercial identifier of the impacted product and the type of bucket created under that product", + "$ref": "BucketBalanceRef.schema.json#BucketBalanceRef" + }, + "confirmationDate": { + "type": "string", + "description": "Date when the transfer was confirmed in the server" + }, + "costOwner": { + "type": "string", + "description": "Indicates the entity responsible to assume the cost of the transfer operation", + "enum": [ + "originator", + "receiver" + ] + }, + "description": { + "type": "string", + "description": "Description of the transfer operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information. This is typically the resource url to retrieve individual transfer operation details" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the balance transfer operation request." + }, + "partyAccount": { + "description": "A reference to the account that owns the bucket impacted by the balance related operation", + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "reason": { + "type": "string", + "description": "Text describing the reason for the adjustment" + }, + "receiver": { + "description": "Identifier for the user/customer/entity that receives the transfer action when it is required to indicate additional customer hierarchy information regarding the entity receiving the balance transfer", + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "description": "Used to provide information about any other entity with relation to the operation" + }, + "requestedDate": { + "type": "string", + "description": "Date when the transfer request was received in the server" + }, + "requestor": { + "description": "Identifier for the user/customer/entity that performs the top-up action. This can be used to indicate the identifier of an agent that performs the operation on behalf of a user via a customer service channel. Structure including at least attributes �role� and �name�.", + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "status": { + "type": "string", + "description": "Status of the top-up.", + "enum": [ + "confirmed", + "cancelled", + "in progress" + ] + }, + "targetType": { + "type": "string", + "description": "Intended for scenarios where the transfer is done from one bucket type to another (from voice to data). A preconfigured value that describes a Transfer type which determines the prepay balance bucket in which the transfer is done" + }, + "transferCost": { + "description": "Associated cost to be charged for the transfer operation (can be monetary or non-monetary)", + "$ref": "../Common/QuantityType.schema.json#QuantityType" } + }, + "allOf": [ + { + "$ref": "BalanceTransferBody.schema.json#BalanceTransferBody" + } + ], + "required": [ + "id", + "href", + "reason", + "requestedDate", + "confirmationDate", + "status", + "product" + ], + "type": "object" } -} + } +} \ No newline at end of file diff --git a/Customer/BalanceTransferStatusTypeModify.schema.json b/Customer/BalanceTransferStatusTypeModify.schema.json index 62a5f35a..f6c43481 100644 --- a/Customer/BalanceTransferStatusTypeModify.schema.json +++ b/Customer/BalanceTransferStatusTypeModify.schema.json @@ -1,17 +1,19 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTransferStatusTypeModify.schema.json", - "title": "BalanceTransferStatusTypeModify", - "definitions": { - "BalanceTransferStatusTypeModify": { - "properties": { - "status": { - "type": "string" - } - }, - "required": [ - "status" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTransferStatusTypeModify.schema.json", + "title": "BalanceTransferStatusTypeModify", + "definitions": { + "BalanceTransferStatusTypeModify": { + "$id": "#BalanceTransferStatusTypeModify", + "properties": { + "status": { + "type": "string" } + }, + "required": [ + "status" + ], + "type": "object" } + } } \ No newline at end of file diff --git a/Customer/BalanceUnreserve.schema.json b/Customer/BalanceUnreserve.schema.json index 33237363..80d011e4 100644 --- a/Customer/BalanceUnreserve.schema.json +++ b/Customer/BalanceUnreserve.schema.json @@ -1,52 +1,52 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceUnreserve.schema.json", - "title": "BalanceUnreserve", - "definitions": { - "BalanceUnreserve": { - "$id": "#BalanceUnreserve", - "description": "The Balance Unreserve Operation resource is a detailed description of a balance unreserve operation requested over a subscription", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the unreserve operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a unreserve" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the unreserve operation request" - }, - "requestedDate": { - "type": "string", - "format": "date-time", - "description": "Date when the unreserve request was received in the server" - }, - "status": { - "type": "string", - "description": "Status of the unreserve operation" - }, - "balanceReserve": { - "$ref": "BalanceReserveRef.schema.json#BalanceReserveRef" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "requestor": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "product": { - "$ref": "../Product/ProductRef.schema.json#ProductRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceUnreserve.schema.json", + "title": "BalanceUnreserve", + "definitions": { + "BalanceUnreserve": { + "$id": "#BalanceUnreserve", + "description": "The Balance Unreserve Operation resource is a detailed description of a balance unreserve operation requested over a subscription", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the unreserve operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a unreserve" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the unreserve operation request" + }, + "requestedDate": { + "type": "string", + "format": "date-time", + "description": "Date when the unreserve request was received in the server" + }, + "status": { + "type": "string", + "description": "Status of the unreserve operation" + }, + "balanceReserve": { + "$ref": "BalanceReserveRef.schema.json#BalanceReserveRef" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "requestor": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "product": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/BankCardDetails.schema.json b/Customer/BankCardDetails.schema.json index cca79dbd..e09a4e9b 100644 --- a/Customer/BankCardDetails.schema.json +++ b/Customer/BankCardDetails.schema.json @@ -1,52 +1,52 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankCardDetails.schema.json", - "title": "BankCardDetails", - "definitions": { - "BankCardDetails": { - "$id": "#BankCardDetails", - "description": "Detailed information for a bank card", - "type": "object", - "properties": { - "bank": { - "type": "string", - "description": "Bank that issued the card" - }, - "brand": { - "type": "string", - "description": "Card brand, such as Visa, MasterCard, AmericanExpress" - }, - "cardNumber": { - "type": "string", - "description": "Credit long card number" - }, - "cvv": { - "type": "string", - "description": "The security code (e.g.: CVV, CVV2) of the card" - }, - "expirationDate": { - "type": "string", - "format": "date-time", - "description": "Expiration date of the card" - }, - "lastFourDigits": { - "type": "string", - "description": "Last four digits of the credit card" - }, - "nameOnCard": { - "type": "string", - "description": "Name on the card" - }, - "cardType": { - "type": "string", - "description": "Type of the card, such as Credit, Debit" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankCardDetails.schema.json", + "title": "BankCardDetails", + "definitions": { + "BankCardDetails": { + "$id": "#BankCardDetails", + "description": "Detailed information for a bank card", + "type": "object", + "properties": { + "bank": { + "type": "string", + "description": "Bank that issued the card" + }, + "brand": { + "type": "string", + "description": "Card brand, such as Visa, MasterCard, AmericanExpress" + }, + "cardNumber": { + "type": "string", + "description": "Credit long card number" + }, + "cvv": { + "type": "string", + "description": "The security code (e.g.: CVV, CVV2) of the card" + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "Expiration date of the card" + }, + "lastFourDigits": { + "type": "string", + "description": "Last four digits of the credit card" + }, + "nameOnCard": { + "type": "string", + "description": "Name on the card" + }, + "cardType": { + "type": "string", + "description": "Type of the card, such as Credit, Debit" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/BankCardMethod.schema.json b/Customer/BankCardMethod.schema.json index 0957e500..25d72f1a 100644 --- a/Customer/BankCardMethod.schema.json +++ b/Customer/BankCardMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankCardMethod.schema.json", - "title": "BankCardMethod", - "definitions": { - "BankCardMethod": { - "$id": "#BankCardMethod", - "type": "object", - "properties": { - "details": { - "$ref": "BankCardDetails.schema.json#BankCardDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankCardMethod.schema.json", + "title": "BankCardMethod", + "definitions": { + "BankCardMethod": { + "$id": "#BankCardMethod", + "type": "object", + "properties": { + "details": { + "$ref": "BankCardDetails.schema.json#BankCardDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/Bill.schema.json b/Customer/Bill.schema.json index 5e1d1a3e..698af8d3 100644 --- a/Customer/Bill.schema.json +++ b/Customer/Bill.schema.json @@ -1,118 +1,118 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Bill.schema.json", - "title": "Bill", - "definitions": { - "Bill": { - "$id": "#Bill", - "description": "The Bill entity is used to model a bill (aka an invoice). It represents a total amount due for all products during the billing period and all significant date.", - "type": "object", - "properties": { - "amountDue": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Amount due for this bill expressed in the given currency" - }, - "billDate": { - "type": "string", - "format": "date-time", - "description": "Bill date" - }, - "billingPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Billing period of the bill (used for onCycle bill only)" - }, - "billNo": { - "type": "string", - "description": "Bill reference known by the customer or the party and displayed on the bill. Could be different from the id." - }, - "category": { - "type": "string", - "description": "Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note" - }, - "href": { - "type": "string", - "description": "Bill unique reference" - }, - "id": { - "type": "string", - "description": "Bill unique identifier" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date of bill last update" - }, - "nextBillDate": { - "type": "string", - "format": "date-time", - "description": "Approximate date of the next bill production given for information (only used for onCycle bill)" - }, - "paymentDueDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the amount due should have been paid" - }, - "remainingAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Remaining amount to be paid for this bill expressed in the given currency" - }, - "runType": { - "type": "string", - "description": "onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close)" - }, - "state": { - "type": "string", - "description": "State that a bill could take during its lifecycle : New, Validated, On Hold, Sent, Partially paid or Settled" - }, - "taxExcludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Total tax excluded amount expressed in the given currency" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Total tax included amount expressed in the given" - }, - "billDocument": { - "type": "array", - "items": { - "$ref": "../Common/FileDocument.schema.json#FileDocument" - }, - "description": "Document(s) associated to the bill" - }, - "paymentItem": { - "type": "array", - "items": { - "$ref": "PaymentItem.schema.json#PaymentItem" - }, - "description": "Payment items already lettered on this bill." - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef" - }, - "taxItem": { - "type": "array", - "items": { - "$ref": "TaxItem.schema.json#TaxItem" - } - }, - "paymentMethod": { - "$ref": "PaymentMethodRef.schema.json#PaymentMethodRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "financialAccount": { - "$ref": "../EngagedParty/FinancialAccountRef.schema.json#FinancialAccountRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Bill.schema.json", + "title": "Bill", + "definitions": { + "Bill": { + "$id": "#Bill", + "description": "The Bill entity is used to model a bill (aka an invoice). It represents a total amount due for all products during the billing period and all significant date.", + "type": "object", + "properties": { + "amountDue": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Amount due for this bill expressed in the given currency" + }, + "billDate": { + "type": "string", + "format": "date-time", + "description": "Bill date" + }, + "billingPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Billing period of the bill (used for onCycle bill only)" + }, + "billNo": { + "type": "string", + "description": "Bill reference known by the customer or the party and displayed on the bill. Could be different from the id." + }, + "category": { + "type": "string", + "description": "Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note" + }, + "href": { + "type": "string", + "description": "Bill unique reference" + }, + "id": { + "type": "string", + "description": "Bill unique identifier" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date of bill last update" + }, + "nextBillDate": { + "type": "string", + "format": "date-time", + "description": "Approximate date of the next bill production given for information (only used for onCycle bill)" + }, + "paymentDueDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the amount due should have been paid" + }, + "remainingAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Remaining amount to be paid for this bill expressed in the given currency" + }, + "runType": { + "type": "string", + "description": "onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close)" + }, + "state": { + "type": "string", + "description": "State that a bill could take during its lifecycle : New, Validated, On Hold, Sent, Partially paid or Settled" + }, + "taxExcludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Total tax excluded amount expressed in the given currency" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Total tax included amount expressed in the given" + }, + "billDocument": { + "type": "array", + "items": { + "$ref": "../Common/FileDocument.schema.json#FileDocument" + }, + "description": "Document(s) associated to the bill" + }, + "paymentItem": { + "type": "array", + "items": { + "$ref": "PaymentItem.schema.json#PaymentItem" + }, + "description": "Payment items already lettered on this bill." + }, + "billingAccount": { + "$ref": "BillingAccountRef.schema.json#BillingAccountRef" + }, + "taxItem": { + "type": "array", + "items": { + "$ref": "TaxItem.schema.json#TaxItem" + } + }, + "paymentMethod": { + "$ref": "PaymentMethodRef.schema.json#PaymentMethodRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "financialAccount": { + "$ref": "../EngagedParty/FinancialAccountRef.schema.json#FinancialAccountRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/BillFormat.schema.json b/Customer/BillFormat.schema.json index c22a0f45..b4a11aac 100644 --- a/Customer/BillFormat.schema.json +++ b/Customer/BillFormat.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillFormat.schema.json", - "title": "BillFormat", - "definitions": { - "BillFormat": { - "$id": "#BillFormat", - "description": "A detailed description of the way in which a bill is presented.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "description": { - "type": "string", - "description": "An explanatory text for this bill format" - }, - "href": { - "type": "string", - "description": "Reference of the bill format" - }, - "id": { - "type": "string", - "description": "Unique identifier of the bill format" - }, - "name": { - "type": "string", - "description": "A short descriptive name" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillFormat.schema.json", + "title": "BillFormat", + "definitions": { + "BillFormat": { + "$id": "#BillFormat", + "description": "A detailed description of the way in which a bill is presented.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "description": { + "type": "string", + "description": "An explanatory text for this bill format" + }, + "href": { + "type": "string", + "description": "Reference of the bill format" + }, + "id": { + "type": "string", + "description": "Unique identifier of the bill format" + }, + "name": { + "type": "string", + "description": "A short descriptive name" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/BillFormatRef.schema.json b/Customer/BillFormatRef.schema.json index 2e2ead81..517bc774 100644 --- a/Customer/BillFormatRef.schema.json +++ b/Customer/BillFormatRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillFormatRef.schema.json", - "title": "BillFormatRef", - "definitions": { - "BillFormatRef": { - "$id": "#BillFormatRef", - "description": "BillFormat reference. A bill format is a description of the way in which a bill is presented.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the bill format" - }, - "id": { - "type": "string", - "description": "Unique identifier of the bill format" - }, - "name": { - "type": "string", - "description": "A short descriptive name" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillFormatRef.schema.json", + "title": "BillFormatRef", + "definitions": { + "BillFormatRef": { + "$id": "#BillFormatRef", + "description": "BillFormat reference. A bill format is a description of the way in which a bill is presented.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the bill format" + }, + "id": { + "type": "string", + "description": "Unique identifier of the bill format" + }, + "name": { + "type": "string", + "description": "A short descriptive name" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/BillFormatRefOrValue.schema.json b/Customer/BillFormatRefOrValue.schema.json index 82d4a4ce..e2b05516 100644 --- a/Customer/BillFormatRefOrValue.schema.json +++ b/Customer/BillFormatRefOrValue.schema.json @@ -1,33 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillFormatRefOrValue.schema.json", - "title": "BillFormatRefOrValue", - "definitions": { - "BillFormatRefOrValue": { - "discriminator": "isRef", - "$id": "#BillFormatRefOrValue", - "description": "An attachment by value or by reference.", - "type": "object", - "properties": { - "isRef": { - "type": "boolean", - "default": true - - } - }, - "required": [ - "isRef", - "role" - ], - "allOf": [ - { - "$ref": "BillFormatRef.schema.json#BillFormatRef" - }, - { - "$ref": "BillFormat.schema.json#BillFormat" - } - - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillFormatRefOrValue.schema.json", + "title": "BillFormatRefOrValue", + "definitions": { + "BillFormatRefOrValue": { + "discriminator": "isRef", + "$id": "#BillFormatRefOrValue", + "description": "An attachment by value or by reference.", + "type": "object", + "properties": { + "isRef": { + "type": "boolean", + "default": true } + }, + "required": [ + "isRef", + "role" + ], + "allOf": [ + { + "$ref": "BillFormatRef.schema.json#BillFormatRef" + }, + { + "$ref": "BillFormat.schema.json#BillFormat" + } + ] } } +} \ No newline at end of file diff --git a/Customer/BillPresentationMedia.schema.json b/Customer/BillPresentationMedia.schema.json index 93164914..14069795 100644 --- a/Customer/BillPresentationMedia.schema.json +++ b/Customer/BillPresentationMedia.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillPresentationMedia.schema.json", - "title": "BillPresentationMedia", - "definitions": { - "BillPresentationMedia": { - "$id": "#BillPresentationMedia", - "description": "A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "description": { - "type": "string", - "description": "An explanatory text describing this bill presentation media" - }, - "href": { - "type": "string", - "description": "Reference of the bill presentation media" - }, - "id": { - "type": "string", - "description": "Unique identifier of the bill presentation media" - }, - "name": { - "type": "string", - "description": "A short descriptive name" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillPresentationMedia.schema.json", + "title": "BillPresentationMedia", + "definitions": { + "BillPresentationMedia": { + "$id": "#BillPresentationMedia", + "description": "A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "description": { + "type": "string", + "description": "An explanatory text describing this bill presentation media" + }, + "href": { + "type": "string", + "description": "Reference of the bill presentation media" + }, + "id": { + "type": "string", + "description": "Unique identifier of the bill presentation media" + }, + "name": { + "type": "string", + "description": "A short descriptive name" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/BillPresentationMediaRef.schema.json b/Customer/BillPresentationMediaRef.schema.json index 878ca8b0..9a2ae302 100644 --- a/Customer/BillPresentationMediaRef.schema.json +++ b/Customer/BillPresentationMediaRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillPresentationMediaRef.schema.json", - "title": "BillPresentationMediaRef", - "definitions": { - "BillPresentationMediaRef": { - "$id": "#BillPresentationMediaRef", - "description": "PresentationMedia reference. A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the bill presentation media" - }, - "id": { - "type": "string", - "description": "Unique identifier of the bill presentation media" - }, - "name": { - "type": "string", - "description": "A short descriptive name" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillPresentationMediaRef.schema.json", + "title": "BillPresentationMediaRef", + "definitions": { + "BillPresentationMediaRef": { + "$id": "#BillPresentationMediaRef", + "description": "PresentationMedia reference. A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the bill presentation media" + }, + "id": { + "type": "string", + "description": "Unique identifier of the bill presentation media" + }, + "name": { + "type": "string", + "description": "A short descriptive name" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/BillPresentationMediaRefOrValue.schema.json b/Customer/BillPresentationMediaRefOrValue.schema.json index e03af200..f56afe1f 100644 --- a/Customer/BillPresentationMediaRefOrValue.schema.json +++ b/Customer/BillPresentationMediaRefOrValue.schema.json @@ -1,33 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillPresentationMediaRefOrValue.schema.json", - "title": "BillPresentationMediaRefOrValue", - "definitions": { - "BillPresentationMediaRefOrValue": { - "discriminator": "isRef", - "$id": "#BillPresentationMediaRefOrValue", - "description": "An attachment by value or by reference.", - "type": "object", - "properties": { - "isRef": { - "type": "boolean", - "default": true - - } - }, - "required": [ - "isRef", - "role" - ], - "allOf": [ - { - "$ref": "BillPresentationMediaRef.schema.json#BillPresentationMediaRef" - }, - { - "$ref": "BillPresentationMedia.schema.json#BillPresentationMedia" - } - - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillPresentationMediaRefOrValue.schema.json", + "title": "BillPresentationMediaRefOrValue", + "definitions": { + "BillPresentationMediaRefOrValue": { + "discriminator": "isRef", + "$id": "#BillPresentationMediaRefOrValue", + "description": "An attachment by value or by reference.", + "type": "object", + "properties": { + "isRef": { + "type": "boolean", + "default": true } + }, + "required": [ + "isRef", + "role" + ], + "allOf": [ + { + "$ref": "BillPresentationMediaRef.schema.json#BillPresentationMediaRef" + }, + { + "$ref": "BillPresentationMedia.schema.json#BillPresentationMedia" + } + ] } } +} \ No newline at end of file diff --git a/Customer/BillRef.schema.json b/Customer/BillRef.schema.json index 6b2377e0..c82b1fdf 100644 --- a/Customer/BillRef.schema.json +++ b/Customer/BillRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillRef.schema.json", - "title": "BillRef", - "definitions": { - "BillRef": { - "$id": "#BillRef", - "description": "Bill reference.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Unique reference of the bill." - }, - "id": { - "type": "string", - "description": "Unique identifier of the bill" - }, - "name": { - "type": "string", - "description": "Name of the bill" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillRef.schema.json", + "title": "BillRef", + "definitions": { + "BillRef": { + "$id": "#BillRef", + "description": "Bill reference.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Unique reference of the bill." + }, + "id": { + "type": "string", + "description": "Unique identifier of the bill" + }, + "name": { + "type": "string", + "description": "Name of the bill" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/BillStructure.schema.json b/Customer/BillStructure.schema.json index 9a299e67..4ccfac80 100644 --- a/Customer/BillStructure.schema.json +++ b/Customer/BillStructure.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillStructure.schema.json", - "title": "BillStructure", - "definitions": { - "BillStructure": { - "$id": "#BillStructure", - "description": "The structure of the bill for party accounts (billing or settlement).", - "type": "object", - "properties": { - "presentationMedia": { - "type": "array", - "items": { - "$ref": "BillPresentationMediaRefOrValue.schema.json#BillPresentationMediaRefOrValue" - } - }, - "format": { - "$ref": "BillFormatRefOrValue.schema.json#BillFormatRefOrValue" - }, - "cycleSpecification": { - "$ref": "BillingCycleSpecificationRefOrValue.schema.json#BillingCycleSpecificationRefOrValue" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillStructure.schema.json", + "title": "BillStructure", + "definitions": { + "BillStructure": { + "$id": "#BillStructure", + "description": "The structure of the bill for party accounts (billing or settlement).", + "type": "object", + "properties": { + "presentationMedia": { + "type": "array", + "items": { + "$ref": "BillPresentationMediaRefOrValue.schema.json#BillPresentationMediaRefOrValue" + } + }, + "format": { + "$ref": "BillFormatRefOrValue.schema.json#BillFormatRefOrValue" + }, + "cycleSpecification": { + "$ref": "BillingCycleSpecificationRefOrValue.schema.json#BillingCycleSpecificationRefOrValue" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/BillingAccount.schema.json b/Customer/BillingAccount.schema.json index 288ed0f4..1296b6c9 100644 --- a/Customer/BillingAccount.schema.json +++ b/Customer/BillingAccount.schema.json @@ -1,23 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillingAccount.schema.json", - "title": "BillingAccount", - "definitions": { - "BillingAccount": { - "$id": "#BillingAccount", - "description": "A party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.", - "type": "object", - "required": [ - "name", - "relatedParty" - ], - "properties": { - }, - "allOf": [ - { - "$ref": "../Common/PartyAccount.schema.json#PartyAccount" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillingAccount.schema.json", + "title": "BillingAccount", + "definitions": { + "BillingAccount": { + "$id": "#BillingAccount", + "description": "A party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.", + "type": "object", + "required": [ + "name", + "relatedParty" + ], + "properties": {}, + "allOf": [ + { + "$ref": "../EngagedParty/PartyAccount.schema.json#PartyAccount" } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/BillingAccountRef.schema.json b/Customer/BillingAccountRef.schema.json index 671524c8..6a5addf9 100644 --- a/Customer/BillingAccountRef.schema.json +++ b/Customer/BillingAccountRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillingAccountRef.schema.json", - "title": "BillingAccountRef", - "definitions": { - "BillingAccountRef": { - "$id": "#BillingAccountRef", - "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the billing account" - }, - "id": { - "type": "string", - "description": "Unique identifier of the billing account" - }, - "name": { - "type": "string", - "description": "Name of the billing account" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillingAccountRef.schema.json", + "title": "BillingAccountRef", + "definitions": { + "BillingAccountRef": { + "$id": "#BillingAccountRef", + "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the billing account" + }, + "id": { + "type": "string", + "description": "Unique identifier of the billing account" + }, + "name": { + "type": "string", + "description": "Name of the billing account" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/BillingCycleSpecification.schema.json b/Customer/BillingCycleSpecification.schema.json index 4f405115..584cb48c 100644 --- a/Customer/BillingCycleSpecification.schema.json +++ b/Customer/BillingCycleSpecification.schema.json @@ -1,70 +1,70 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillingCycleSpecification.schema.json", - "title": "BillingCycleSpecification", - "definitions": { - "BillingCycleSpecification": { - "$id": "#BillingCycleSpecification", - "description": "A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "billingDateShift": { - "type": "integer", - "description": "An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period." - }, - "billingPeriod": { - "type": "string", - "description": "A billing time period. It can be recurring, for example: week, month, quarter of year, year ." - }, - "chargeDateOffset": { - "type": "integer", - "description": "An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod." - }, - "creditDateOffset": { - "type": "integer", - "description": "An offset of a date through which credits previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod." - }, - "description": { - "type": "string", - "description": "An explanation regarding this billing cycle specification" - }, - "frequency": { - "type": "string", - "description": "Frequency of the billing cycle (monthly for instance)" - }, - "href": { - "type": "string", - "description": "Reference of the billing cycle specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the billing cycle specification" - }, - "mailingDateOffset": { - "type": "integer", - "description": "An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod." - }, - "name": { - "type": "string", - "description": "A short descriptive name" - }, - "paymentDueDateOffset": { - "type": "integer", - "description": "An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the billing specification cycle is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillingCycleSpecification.schema.json", + "title": "BillingCycleSpecification", + "definitions": { + "BillingCycleSpecification": { + "$id": "#BillingCycleSpecification", + "description": "A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "billingDateShift": { + "type": "integer", + "description": "An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period." + }, + "billingPeriod": { + "type": "string", + "description": "A billing time period. It can be recurring, for example: week, month, quarter of year, year ." + }, + "chargeDateOffset": { + "type": "integer", + "description": "An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod." + }, + "creditDateOffset": { + "type": "integer", + "description": "An offset of a date through which credits previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod." + }, + "description": { + "type": "string", + "description": "An explanation regarding this billing cycle specification" + }, + "frequency": { + "type": "string", + "description": "Frequency of the billing cycle (monthly for instance)" + }, + "href": { + "type": "string", + "description": "Reference of the billing cycle specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the billing cycle specification" + }, + "mailingDateOffset": { + "type": "integer", + "description": "An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod." + }, + "name": { + "type": "string", + "description": "A short descriptive name" + }, + "paymentDueDateOffset": { + "type": "integer", + "description": "An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the billing specification cycle is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/BillingCycleSpecificationRef.schema.json b/Customer/BillingCycleSpecificationRef.schema.json index cd80e584..676ef715 100644 --- a/Customer/BillingCycleSpecificationRef.schema.json +++ b/Customer/BillingCycleSpecificationRef.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillingCycleSpecificationRef.schema.json", - "title": "BillingCycleSpecificationRef", - "definitions": { - "BillingCycleSpecificationRef": { - "$id": "#BillingCycleSpecificationRef", - "description": "BillingCycleSpecification reference. A description of when to initiate a billing cycle and the various sub steps of a billing cycle.", - "type": "object", - "properties": { - "dateShift": { - "type": "integer", - "description": "An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period." - }, - "frequency": { - "type": "string", - "description": "Frequency of the billing cycle (monthly for instance)" - }, - "href": { - "type": "string", - "description": "Reference of the billing cycle specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the billing cycle specification" - }, - "name": { - "type": "string", - "description": "A short descriptive name" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillingCycleSpecificationRef.schema.json", + "title": "BillingCycleSpecificationRef", + "definitions": { + "BillingCycleSpecificationRef": { + "$id": "#BillingCycleSpecificationRef", + "description": "BillingCycleSpecification reference. A description of when to initiate a billing cycle and the various sub steps of a billing cycle.", + "type": "object", + "properties": { + "dateShift": { + "type": "integer", + "description": "An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period." + }, + "frequency": { + "type": "string", + "description": "Frequency of the billing cycle (monthly for instance)" + }, + "href": { + "type": "string", + "description": "Reference of the billing cycle specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the billing cycle specification" + }, + "name": { + "type": "string", + "description": "A short descriptive name" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/BillingCycleSpecificationRefOrValue.schema.json b/Customer/BillingCycleSpecificationRefOrValue.schema.json index 4b152859..9157847c 100644 --- a/Customer/BillingCycleSpecificationRefOrValue.schema.json +++ b/Customer/BillingCycleSpecificationRefOrValue.schema.json @@ -1,33 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillingCycleSpecificationRefOrValue.schema.json", - "title": "BillingCycleSpecificationRefOrValue", - "definitions": { - "BillingCycleSpecificationRefOrValue": { - "discriminator": "isRef", - "$id": "#BillingCycleSpecificationRefOrValue", - "description": "An attachment by value or by reference.", - "type": "object", - "properties": { - "isRef": { - "type": "boolean", - "default": true - - } - }, - "required": [ - "isRef", - "role" - ], - "allOf": [ - { - "$ref": "BillingCycleSpecificationRef.schema.json#BillingCycleSpecificationRef" - }, - { - "$ref": "BillingCycleSpecification.schema.json#BillingCycleSpecification" - } - - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillingCycleSpecificationRefOrValue.schema.json", + "title": "BillingCycleSpecificationRefOrValue", + "definitions": { + "BillingCycleSpecificationRefOrValue": { + "discriminator": "isRef", + "$id": "#BillingCycleSpecificationRefOrValue", + "description": "An attachment by value or by reference.", + "type": "object", + "properties": { + "isRef": { + "type": "boolean", + "default": true } + }, + "required": [ + "isRef", + "role" + ], + "allOf": [ + { + "$ref": "BillingCycleSpecificationRef.schema.json#BillingCycleSpecificationRef" + }, + { + "$ref": "BillingCycleSpecification.schema.json#BillingCycleSpecification" + } + ] } } +} \ No newline at end of file diff --git a/Customer/Bucket.schema.json b/Customer/Bucket.schema.json index 2f080e44..159c8c5c 100644 --- a/Customer/Bucket.schema.json +++ b/Customer/Bucket.schema.json @@ -1,16 +1,17 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Bucket.schema.json", - "title": "Bucket", - "definitions": { - "Bucket": { - "description": "desc", - - "allOf": [ - { - "$ref": "BucketBalance.schema.json#/definitions/BucketBalance" - } - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Bucket.schema.json", + "title": "Bucket", + "definitions": { + "Bucket": { + "$id": "#Bucket", + "description": "desc", + "allOf": [ + { + "$ref": "BucketBalance.schema.json#BucketBalance" + } + ], + "type": "object" } -} + } +} \ No newline at end of file diff --git a/Customer/BucketBalance.schema.json b/Customer/BucketBalance.schema.json index ece87b54..98ca1fed 100644 --- a/Customer/BucketBalance.schema.json +++ b/Customer/BucketBalance.schema.json @@ -1,81 +1,83 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BucketBalance.schema.json", - "title": "BucketBalance", - "definitions": { - "BucketBalance": { - "description": "Represents and tracks the amount remained or owed for a certain type of service by certain customer", - "properties": { - "bucketType": { - "type": "string", - "description": "Type of prepay balance bucket (e.g.: promotion, deposit, bonus, data, voice, or any other service type)" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the balance managed by the bucket" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information for the bucket" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the bucket" - }, - "name": { - "type": "string", - "description": "Friendly name to identify the bucket" - }, - "partyAccount": { - "description": "A reference to the account that owns the bucket", - "$ref": "PartyAccountRef.schema.json#/definitions/PartyAccountRef" - }, - "product": { - "type": "array", - "items": { - "$ref": "ProductRef.schema.json#/definitions/ProductRef" - }, - "description": "A reference to the product whose consumption is managed by the bucket. This is an array to allow scenarios where a given bucket is shared between different products." - }, - "realizingResource": { - "type": "array", - "items": { - "$ref": "ResourceRef.schema.json#/definitions/ResourceRef" - }, - "description": "A reference to the resource that realizes a product. This is an array to allow scenarios where a given bucket is shared between different resources." - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#/definitions/RelatedParty" - }, - "description": "Used to provide information about any other entity with relation to the balance, for instance to define customer hierarchy for the balance (e.g.: customerId, userId, )" - }, - "remainedAmount": { - "description": "Amount remained in the bucket", - "$ref": "QuantityType.schema.json#/definitions/QuantityType" - }, - "reservedAmount": { - "description": "Indicate the reserved amount on the bucket", - "$ref": "QuantityType.schema.json#/definitions/QuantityType" - }, - "status": { - "type": "string", - "description": "Status for the balance (active, expired, suspended)" - }, - "validFor": { - "description": "The period for which the balance in the bucket is valid", - "$ref": "TimePeriodType.schema.json#/definitions/TimePeriodType" - } - }, - "required": [ - "id", - "href", - "bucketType", - "validFor", - "status", - "product" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BucketBalance.schema.json", + "title": "BucketBalance", + "definitions": { + "BucketBalance": { + "$id": "#BucketBalance", + "description": "Represents and tracks the amount remained or owed for a certain type of service by certain customer", + "properties": { + "bucketType": { + "type": "string", + "description": "Type of prepay balance bucket (e.g.: promotion, deposit, bonus, data, voice, or any other service type)" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the balance managed by the bucket" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information for the bucket" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the bucket" + }, + "name": { + "type": "string", + "description": "Friendly name to identify the bucket" + }, + "partyAccount": { + "description": "A reference to the account that owns the bucket", + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "product": { + "type": "array", + "items": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "description": "A reference to the product whose consumption is managed by the bucket. This is an array to allow scenarios where a given bucket is shared between different products." + }, + "realizingResource": { + "type": "array", + "items": { + "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" + }, + "description": "A reference to the resource that realizes a product. This is an array to allow scenarios where a given bucket is shared between different resources." + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "Used to provide information about any other entity with relation to the balance, for instance to define customer hierarchy for the balance (e.g.: customerId, userId, )" + }, + "remainedAmount": { + "description": "Amount remained in the bucket", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "reservedAmount": { + "description": "Indicate the reserved amount on the bucket", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "status": { + "type": "string", + "description": "Status for the balance (active, expired, suspended)" + }, + "validFor": { + "description": "The period for which the balance in the bucket is valid", + "$ref": "../Common/TimePeriodType.schema.json#TimePeriodType" } + }, + "required": [ + "id", + "href", + "bucketType", + "validFor", + "status", + "product" + ], + "type": "object" } -} + } +} \ No newline at end of file diff --git a/Customer/BucketBalanceRef.schema.json b/Customer/BucketBalanceRef.schema.json index 94c08bd5..d24ccb8a 100644 --- a/Customer/BucketBalanceRef.schema.json +++ b/Customer/BucketBalanceRef.schema.json @@ -1,24 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BucketBalanceRef.schema.json", - "title": "BucketBalanceRef", - "definitions": { - "BucketBalanceRef": { - "description": "link to the resource that holds bucket balance information", - "properties": { - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the balance information for a bucket" - }, - "id": { - "type": "string", - "description": "Unique identifier for the bucket entity" - } - }, - "required": [ - "id", - "href" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BucketBalanceRef.schema.json", + "title": "BucketBalanceRef", + "definitions": { + "BucketBalanceRef": { + "$id": "#BucketBalanceRef", + "description": "link to the resource that holds bucket balance information", + "properties": { + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the balance information for a bucket" + }, + "id": { + "type": "string", + "description": "Unique identifier for the bucket entity" } + }, + "required": [ + "id", + "href" + ], + "type": "object" } -} + } +} \ No newline at end of file diff --git a/Customer/CartItem.schema.json b/Customer/CartItem.schema.json index 2da2c4f6..352e29c9 100755 --- a/Customer/CartItem.schema.json +++ b/Customer/CartItem.schema.json @@ -1,77 +1,77 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartItem.schema.json", - "title": "CartItem", - "definitions": { - "CartItem": { - "$id": "#CartItem", - "description": "An identified part of the shopping cart. A shopping cart is decomposed into one or more shopping cart item. Cart item represents a product offering or bundled product offering that user wish to purchase, as well as the pricing of the product offering, reference to product in case of configured characteristic or installation address. Cart items can be related to other cart item to related bundled offerings or reference cart Items to a shipping options", - "type": "object", - "properties": { - "action": { - "$ref": "CartItemActionType.schema.json#/definitions/CartItemActionType", - "description": "The action to be carried out on the Product. Can be: add, modify, delete, noChange" - }, - "id": { - "type": "string", - "description": "Identifier of the cart item (generally it is a sequence number 01, 02, 03, ...) in the shopping cart" - }, - "quantity": { - "type": "integer", - "description": "Quantity of cart items" - }, - "status": { - "$ref": "CartItemStatusType.schema.json#/definitions/CartItemStatusType", - "description": "status of cart item. e.g \"active\" , \"savedForLater\"." - }, - "itemTerm": { - "type": "array", - "items": { - "$ref": "CartTerm.schema.json#CartTerm" - } - }, - "cartItem": { - "type": "array", - "items": { - "$ref": "CartItem.schema.json#CartItem" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "ItemTotalPrice": { - "type": "array", - "items": { - "$ref": "CartPrice.schema.json#CartPrice" - } - }, - "product": { - "$ref": "../Product/ProductRefOrValue.schema.json#ProductRefOrValue" - }, - "itemPrice": { - "type": "array", - "items": { - "$ref": "CartPrice.schema.json#CartPrice" - } - }, - "productOffering": { - "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "cartItemRelationship": { - "type": "array", - "items": { - "$ref": "CartItemRelationship.schema.json#CartItemRelationship" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartItem.schema.json", + "title": "CartItem", + "definitions": { + "CartItem": { + "$id": "#CartItem", + "description": "An identified part of the shopping cart. A shopping cart is decomposed into one or more shopping cart item. Cart item represents a product offering or bundled product offering that user wish to purchase, as well as the pricing of the product offering, reference to product in case of configured characteristic or installation address. Cart items can be related to other cart item to related bundled offerings or reference cart Items to a shipping options", + "type": "object", + "properties": { + "action": { + "$ref": "CartItemActionType.schema.json#CartItemActionType", + "description": "The action to be carried out on the Product. Can be: add, modify, delete, noChange" + }, + "id": { + "type": "string", + "description": "Identifier of the cart item (generally it is a sequence number 01, 02, 03, ...) in the shopping cart" + }, + "quantity": { + "type": "integer", + "description": "Quantity of cart items" + }, + "status": { + "$ref": "CartItemStatusType.schema.json#CartItemStatusType", + "description": "status of cart item. e.g \"active\" , \"savedForLater\"." + }, + "itemTerm": { + "type": "array", + "items": { + "$ref": "CartTerm.schema.json#CartTerm" + } + }, + "cartItem": { + "type": "array", + "items": { + "$ref": "CartItem.schema.json#CartItem" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "ItemTotalPrice": { + "type": "array", + "items": { + "$ref": "CartPrice.schema.json#CartPrice" + } + }, + "product": { + "$ref": "../Product/ProductRefOrValue.schema.json#ProductRefOrValue" + }, + "itemPrice": { + "type": "array", + "items": { + "$ref": "CartPrice.schema.json#CartPrice" + } + }, + "productOffering": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "cartItemRelationship": { + "type": "array", + "items": { + "$ref": "CartItemRelationship.schema.json#CartItemRelationship" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/CartItemActionType.schema.json b/Customer/CartItemActionType.schema.json index a12cb124..1116b8e9 100644 --- a/Customer/CartItemActionType.schema.json +++ b/Customer/CartItemActionType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartItemActionType.schema.json", - "title": "CartItemActionType", - "definitions": { - "CartItemActionType": { - "$id": "#CartItemActionType", - "description": "action to be performed on the product", - "type": "string", - "enum": [ - "add", - "modify", - "delete", - "noChange" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartItemActionType.schema.json", + "title": "CartItemActionType", + "definitions": { + "CartItemActionType": { + "$id": "#CartItemActionType", + "description": "action to be performed on the product", + "type": "string", + "enum": [ + "add", + "modify", + "delete", + "noChange" + ] } -} + } +} \ No newline at end of file diff --git a/Customer/CartItemRef.schema.json b/Customer/CartItemRef.schema.json index 6789dec9..7d48e529 100644 --- a/Customer/CartItemRef.schema.json +++ b/Customer/CartItemRef.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartItemRef.schema.json", - "title": "CartItemRef", - "definitions": { - "CartItemRef": { - "$id": "#CartItemRef", - "description": "CartIIem reference. A CartItem is an identified part of the shopping cart.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the cart item" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartItemRef.schema.json", + "title": "CartItemRef", + "definitions": { + "CartItemRef": { + "$id": "#CartItemRef", + "description": "CartIIem reference. A CartItem is an identified part of the shopping cart.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the cart item" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/CartItemRelationship.schema.json b/Customer/CartItemRelationship.schema.json index 60640eeb..535a5b0e 100644 --- a/Customer/CartItemRelationship.schema.json +++ b/Customer/CartItemRelationship.schema.json @@ -1,33 +1,33 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartItemRelationship.schema.json", - "title": "CartItemRelationship", - "definitions": { - "CartItemRelationship": { - "$id": "#CartItemRelationship", - "description": "Relationship among cart items mainly other than hierarchical relationships such as \"RelyOn\", \"DependentOn\", \"Shipping\" etc.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the referred cart item" - }, - "relationshipType": { - "type": "string", - "description": "Type of the cart item relationship" - }, - "cartItem": { - "type": "array", - "items": { - "$ref": "CartItemRef.schema.json#CartItemRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartItemRelationship.schema.json", + "title": "CartItemRelationship", + "definitions": { + "CartItemRelationship": { + "$id": "#CartItemRelationship", + "description": "Relationship among cart items mainly other than hierarchical relationships such as \"RelyOn\", \"DependentOn\", \"Shipping\" etc.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the referred cart item" + }, + "relationshipType": { + "type": "string", + "description": "Type of the cart item relationship" + }, + "cartItem": { + "type": "array", + "items": { + "$ref": "CartItemRef.schema.json#CartItemRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/CartItemStatusType.schema.json b/Customer/CartItemStatusType.schema.json index 6531ac84..982cc456 100644 --- a/Customer/CartItemStatusType.schema.json +++ b/Customer/CartItemStatusType.schema.json @@ -1,16 +1,16 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartItemStatusType.schema.json", - "title": "CartItemStatusType", - "definitions": { - "CartItemStatusType": { - "$id": "#CartItemStatusType", - "type": "string", - "description": "Possible values for the status of the cart item", - "enum": [ - "active", - "saveForLater" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartItemStatusType.schema.json", + "title": "CartItemStatusType", + "definitions": { + "CartItemStatusType": { + "$id": "#CartItemStatusType", + "type": "string", + "description": "Possible values for the status of the cart item", + "enum": [ + "active", + "saveForLater" + ] } -} + } +} \ No newline at end of file diff --git a/Customer/CartPrice.schema.json b/Customer/CartPrice.schema.json index 34293a41..0e4a6cd3 100755 --- a/Customer/CartPrice.schema.json +++ b/Customer/CartPrice.schema.json @@ -1,52 +1,52 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartPrice.schema.json", - "title": "CartPrice", - "definitions": { - "CartPrice": { - "$id": "#CartPrice", - "description": "An amount, usually of money, that represents the actual price paid by the customer for this item. May represent the total price of the shopping cart or the total of the cart item depending on the relation", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail the semantics of this order item price." - }, - "name": { - "type": "string", - "description": "A short descriptive name such as \"Subscription price\"." - }, - "priceType": { - "type": "string", - "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth" - }, - "productOfferingPrice": { - "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef", - "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time." - }, - "recurringChargePeriod": { - "type": "string", - "description": "Could be month, week..." - }, - "unitOfMeasure": { - "type": "string", - "description": "Could be minutes, GB..." - }, - "price": { - "$ref": "Price.schema.json#Price" - }, - "priceAlteration": { - "type": "array", - "items": { - "$ref": "PriceAlteration.schema.json#PriceAlteration" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartPrice.schema.json", + "title": "CartPrice", + "definitions": { + "CartPrice": { + "$id": "#CartPrice", + "description": "An amount, usually of money, that represents the actual price paid by the customer for this item. May represent the total price of the shopping cart or the total of the cart item depending on the relation", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail the semantics of this order item price." + }, + "name": { + "type": "string", + "description": "A short descriptive name such as \"Subscription price\"." + }, + "priceType": { + "type": "string", + "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth" + }, + "productOfferingPrice": { + "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef", + "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time." + }, + "recurringChargePeriod": { + "type": "string", + "description": "Could be month, week..." + }, + "unitOfMeasure": { + "type": "string", + "description": "Could be minutes, GB..." + }, + "price": { + "$ref": "Price.schema.json#Price" + }, + "priceAlteration": { + "type": "array", + "items": { + "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/CartTerm.schema.json b/Customer/CartTerm.schema.json index 864c968c..5cfb155c 100644 --- a/Customer/CartTerm.schema.json +++ b/Customer/CartTerm.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartTerm.schema.json", - "title": "CartTerm", - "definitions": { - "CartTerm": { - "$id": "#CartTerm", - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "duration": { - "$ref": "../Common/Quantity.schema.json#Quantity" - }, - "name": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartTerm.schema.json", + "title": "CartTerm", + "definitions": { + "CartTerm": { + "$id": "#CartTerm", + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "duration": { + "$ref": "../Common/Quantity.schema.json#Quantity" + }, + "name": { + "type": "string" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/CashDetails.schema.json b/Customer/CashDetails.schema.json index 06b430cc..424e5ce4 100644 --- a/Customer/CashDetails.schema.json +++ b/Customer/CashDetails.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CashDetails.schema.json", - "title": "CashDetails", - "definitions": { - "CashDetails": { - "$id": "#CashDetails", - "description": "Cash has no additional data, but it could be extended to add information (e.g.: the cashier who took the payment, the person who paid, etc)", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CashDetails.schema.json", + "title": "CashDetails", + "definitions": { + "CashDetails": { + "$id": "#CashDetails", + "description": "Cash has no additional data, but it could be extended to add information (e.g.: the cashier who took the payment, the person who paid, etc)", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/CashMethod.schema.json b/Customer/CashMethod.schema.json index 7a0e4649..3abe7892 100644 --- a/Customer/CashMethod.schema.json +++ b/Customer/CashMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CashMethod.schema.json", - "title": "CashMethod", - "definitions": { - "CashMethod": { - "$id": "#CashMethod", - "type": "object", - "properties": { - "details": { - "$ref": "CashDetails.schema.json#CashDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CashMethod.schema.json", + "title": "CashMethod", + "definitions": { + "CashMethod": { + "$id": "#CashMethod", + "type": "object", + "properties": { + "details": { + "$ref": "CashDetails.schema.json#CashDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/CheckDetails.schema.json b/Customer/CheckDetails.schema.json index fdb9d5e3..c92071d1 100644 --- a/Customer/CheckDetails.schema.json +++ b/Customer/CheckDetails.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CheckDetails.schema.json", - "title": "CheckDetails", - "definitions": { - "CheckDetails": { - "$id": "#CheckDetails", - "description": "Detailed information of a check", - "type": "object", - "properties": { - "bank": { - "type": "string", - "description": "Bank performing the payment of the check" - }, - "code": { - "type": "string", - "description": "Unique identifier of the check" - }, - "date": { - "type": "string", - "format": "date-time", - "description": "Date when the check was signed" - }, - "drawer": { - "type": "string", - "description": "Person or entity writing the check" - }, - "payee": { - "type": "string", - "description": "Person or entity the check is addressed to" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CheckDetails.schema.json", + "title": "CheckDetails", + "definitions": { + "CheckDetails": { + "$id": "#CheckDetails", + "description": "Detailed information of a check", + "type": "object", + "properties": { + "bank": { + "type": "string", + "description": "Bank performing the payment of the check" + }, + "code": { + "type": "string", + "description": "Unique identifier of the check" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "Date when the check was signed" + }, + "drawer": { + "type": "string", + "description": "Person or entity writing the check" + }, + "payee": { + "type": "string", + "description": "Person or entity the check is addressed to" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/CheckMethod.schema.json b/Customer/CheckMethod.schema.json index 1bc9cd83..876852cd 100644 --- a/Customer/CheckMethod.schema.json +++ b/Customer/CheckMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CheckMethod.schema.json", - "title": "CheckMethod", - "definitions": { - "CheckMethod": { - "$id": "#CheckMethod", - "type": "object", - "properties": { - "details": { - "$ref": "CheckDetails.schema.json#CheckDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CheckMethod.schema.json", + "title": "CheckMethod", + "definitions": { + "CheckMethod": { + "$id": "#CheckMethod", + "type": "object", + "properties": { + "details": { + "$ref": "CheckDetails.schema.json#CheckDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/CreditProfile.schema.json b/Customer/CreditProfile.schema.json index 13319d48..2bfb3724 100644 --- a/Customer/CreditProfile.schema.json +++ b/Customer/CreditProfile.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CreditProfile.schema.json", - "title": "CreditProfile", - "definitions": { - "CreditProfile": { - "$id": "#CreditProfile", - "description": "Credit profile for the party (containing credit scoring, ...). By default only the current credit profile is retrieved. It can be used as a list to give the party credit profiles history, the first one in the list will be the current one.", - "type": "object", - "properties": { - "creditProfileDate": { - "type": "string", - "format": "date-time", - "description": "The date the profile was established" - }, - "creditRiskRating": { - "type": "integer", - "description": "This is an integer whose value is used to rate the risk" - }, - "creditScore": { - "type": "integer", - "description": "A measure of a person or organizations creditworthiness calculated on the basis of a combination of factors such as their income and credit history" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the profile is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CreditProfile.schema.json", + "title": "CreditProfile", + "definitions": { + "CreditProfile": { + "$id": "#CreditProfile", + "description": "Credit profile for the party (containing credit scoring, ...). By default only the current credit profile is retrieved. It can be used as a list to give the party credit profiles history, the first one in the list will be the current one.", + "type": "object", + "properties": { + "creditProfileDate": { + "type": "string", + "format": "date-time", + "description": "The date the profile was established" + }, + "creditRiskRating": { + "type": "integer", + "description": "This is an integer whose value is used to rate the risk" + }, + "creditScore": { + "type": "integer", + "description": "A measure of a person or organizations creditworthiness calculated on the basis of a combination of factors such as their income and credit history" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the profile is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/Customer.schema.json b/Customer/Customer.schema.json index 288b3fc0..61c99d96 100644 --- a/Customer/Customer.schema.json +++ b/Customer/Customer.schema.json @@ -1,91 +1,91 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Customer.schema.json", - "title": "Customer", - "definitions": { - "Customer": { - "$id": "#Customer", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Url used to reference the customer." - }, - "id": { - "type": "string", - "description": "Unique identifier for Customers" - }, - "name": { - "type": "string", - "description": "A word, term, or phrase by which the Customer is known and distinguished from other Customers." - }, - "status": { - "type": "string", - "description": "Used to track the lifecycle status of the customer." - }, - "statusReason": { - "type": "string", - "description": "A string providing an explanation on the value of the status lifecycle. For instance if the status is Rejected, statusReason will provide the reason for rejection." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The time period that the Customer is valid for." - }, - "engagedParty": { - "$ref": "../EngagedParty/PartyRef.schema.json#PartyRef" - }, - "roleType": { - "$ref": "../EngagedParty/RoleTypeRef.schema.json#RoleTypeRef" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } - }, - "paymentMethod": { - "type": "array", - "items": { - "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" - } - }, - "contactMedium": { - "type": "array", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - }, - "description": "Describes the characteristic of a customer." - }, - "creditProfile": { - "type": "array", - "items": { - "$ref": "../Customer/CreditProfile.schema.json#CreditProfile" - } - }, - "agreement": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Customer.schema.json", + "title": "Customer", + "definitions": { + "Customer": { + "$id": "#Customer", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Url used to reference the customer." + }, + "id": { + "type": "string", + "description": "Unique identifier for Customers" + }, + "name": { + "type": "string", + "description": "A word, term, or phrase by which the Customer is known and distinguished from other Customers." + }, + "status": { + "type": "string", + "description": "Used to track the lifecycle status of the customer." + }, + "statusReason": { + "type": "string", + "description": "A string providing an explanation on the value of the status lifecycle. For instance if the status is Rejected, statusReason will provide the reason for rejection." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The time period that the Customer is valid for." + }, + "engagedParty": { + "$ref": "../EngagedParty/PartyRef.schema.json#PartyRef" + }, + "roleType": { + "$ref": "../EngagedParty/RoleTypeRef.schema.json#RoleTypeRef" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } + }, + "paymentMethod": { + "type": "array", + "items": { + "$ref": "PaymentMethodRef.schema.json#PaymentMethodRef" + } + }, + "contactMedium": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + }, + "description": "Describes the characteristic of a customer." + }, + "creditProfile": { + "type": "array", + "items": { + "$ref": "CreditProfile.schema.json#CreditProfile" + } + }, + "agreement": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/CustomerBill.schema.json b/Customer/CustomerBill.schema.json index 78a7a6c4..6558ebed 100644 --- a/Customer/CustomerBill.schema.json +++ b/Customer/CustomerBill.schema.json @@ -1,117 +1,117 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CustomerBill.schema.json", - "title": "CustomerBill", - "definitions": { - "CustomerBill": { - "$id": "#CustomerBill", - "type": "object", - "properties": { - "amountDue": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Amount due for this bill expressed in the given currency" - }, - "billDate": { - "type": "string", - "format": "date-time", - "description": "Bill date" - }, - "billingPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Billing period of the bill (used for onCycle bill only)" - }, - "billNo": { - "type": "string", - "description": "Bill reference known by the customer or the party and displayed on the bill. Could be different from the id." - }, - "category": { - "type": "string", - "description": "Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note" - }, - "href": { - "type": "string", - "description": "Bill unique reference" - }, - "id": { - "type": "string", - "description": "Bill unique identifier" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date of bill last update" - }, - "nextBillDate": { - "type": "string", - "format": "date-time", - "description": "Approximate date of the next bill production given for information (only used for onCycle bill)" - }, - "paymentDueDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the amount due should have been paid" - }, - "remainingAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Remaining amount to be paid for this bill expressed in the given currency" - }, - "runType": { - "type": "string", - "description": "onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close)" - }, - "state": { - "type": "string", - "description": "State that a bill could take during its lifecycle : New, Validated, On Hold, Sent, Partially paid or Settled" - }, - "taxExcludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Total tax excluded amount expressed in the given currency" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Total tax included amount expressed in the given" - }, - "billDocument": { - "type": "array", - "items": { - "$ref": "../Common/FileDocument.schema.json#FileDocument" - }, - "description": "Document(s) associated to the bill" - }, - "paymentItem": { - "type": "array", - "items": { - "$ref": "PaymentItem.schema.json#PaymentItem" - }, - "description": "Payment items already lettered on this bill." - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef" - }, - "taxItem": { - "type": "array", - "items": { - "$ref": "TaxItem.schema.json#TaxItem" - } - }, - "paymentMethod": { - "$ref": "PaymentMethodRef.schema.json#PaymentMethodRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "financialAccount": { - "$ref": "../EngagedParty/FinancialAccountRef.schema.json#FinancialAccountRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CustomerBill.schema.json", + "title": "CustomerBill", + "definitions": { + "CustomerBill": { + "$id": "#CustomerBill", + "type": "object", + "properties": { + "amountDue": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Amount due for this bill expressed in the given currency" + }, + "billDate": { + "type": "string", + "format": "date-time", + "description": "Bill date" + }, + "billingPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Billing period of the bill (used for onCycle bill only)" + }, + "billNo": { + "type": "string", + "description": "Bill reference known by the customer or the party and displayed on the bill. Could be different from the id." + }, + "category": { + "type": "string", + "description": "Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note" + }, + "href": { + "type": "string", + "description": "Bill unique reference" + }, + "id": { + "type": "string", + "description": "Bill unique identifier" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date of bill last update" + }, + "nextBillDate": { + "type": "string", + "format": "date-time", + "description": "Approximate date of the next bill production given for information (only used for onCycle bill)" + }, + "paymentDueDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the amount due should have been paid" + }, + "remainingAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Remaining amount to be paid for this bill expressed in the given currency" + }, + "runType": { + "type": "string", + "description": "onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close)" + }, + "state": { + "type": "string", + "description": "State that a bill could take during its lifecycle : New, Validated, On Hold, Sent, Partially paid or Settled" + }, + "taxExcludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Total tax excluded amount expressed in the given currency" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Total tax included amount expressed in the given" + }, + "billDocument": { + "type": "array", + "items": { + "$ref": "../Common/FileDocument.schema.json#FileDocument" + }, + "description": "Document(s) associated to the bill" + }, + "paymentItem": { + "type": "array", + "items": { + "$ref": "PaymentItem.schema.json#PaymentItem" + }, + "description": "Payment items already lettered on this bill." + }, + "billingAccount": { + "$ref": "BillingAccountRef.schema.json#BillingAccountRef" + }, + "taxItem": { + "type": "array", + "items": { + "$ref": "TaxItem.schema.json#TaxItem" + } + }, + "paymentMethod": { + "$ref": "PaymentMethodRef.schema.json#PaymentMethodRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "financialAccount": { + "$ref": "../EngagedParty/FinancialAccountRef.schema.json#FinancialAccountRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/DigitalWalletDetails.schema.json b/Customer/DigitalWalletDetails.schema.json index 64c5a987..62de914d 100644 --- a/Customer/DigitalWalletDetails.schema.json +++ b/Customer/DigitalWalletDetails.schema.json @@ -1,32 +1,32 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DigitalWalletDetails.schema.json", - "title": "DigitalWalletDetails", - "definitions": { - "DigitalWalletDetails": { - "$id": "#DigitalWalletDetails", - "description": "Detailed information of a check", - "type": "object", - "properties": { - "service": { - "type": "string", - "description": "Organization, platform or currency backing the wallet (e.g.: PayPal, Yandex, BitCoin...)" - }, - "walletId": { - "type": "string", - "description": "account identifier in that service" - }, - "walletUrl": { - "type": "string", - "format": "uri", - "description": "URI pointing at the digital wallet (e.g.: https://paypal.me/johndoe)" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DigitalWalletDetails.schema.json", + "title": "DigitalWalletDetails", + "definitions": { + "DigitalWalletDetails": { + "$id": "#DigitalWalletDetails", + "description": "Detailed information of a check", + "type": "object", + "properties": { + "service": { + "type": "string", + "description": "Organization, platform or currency backing the wallet (e.g.: PayPal, Yandex, BitCoin...)" + }, + "walletId": { + "type": "string", + "description": "account identifier in that service" + }, + "walletUrl": { + "type": "string", + "format": "uri", + "description": "URI pointing at the digital wallet (e.g.: https://paypal.me/johndoe)" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/DigitalWalletMethod.schema.json b/Customer/DigitalWalletMethod.schema.json index b515de3a..56be96d8 100644 --- a/Customer/DigitalWalletMethod.schema.json +++ b/Customer/DigitalWalletMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DigitalWalletMethod.schema.json", - "title": "DigitalWalletMethod", - "definitions": { - "DigitalWalletMethod": { - "$id": "#DigitalWalletMethod", - "type": "object", - "properties": { - "details": { - "$ref": "DigitalWalletDetails.schema.json#DigitalWalletDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DigitalWalletMethod.schema.json", + "title": "DigitalWalletMethod", + "definitions": { + "DigitalWalletMethod": { + "$id": "#DigitalWalletMethod", + "type": "object", + "properties": { + "details": { + "$ref": "DigitalWalletDetails.schema.json#DigitalWalletDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/Disability.schema.json b/Customer/Disability.schema.json index 01ece798..08d65dc7 100644 --- a/Customer/Disability.schema.json +++ b/Customer/Disability.schema.json @@ -1,29 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Disability.schema.json", - "title": "Disability", - "definitions": { - "Disability": { - "type": "object", - "description": "Lack or inadequate strength or ability.", - "properties": { - "disabilityCode": { - "type": "string", - "description": "Code of the disability" - }, - "disabilityName": { - "type": "string", - "description": "Name of the disability" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#/definitions/TimePeriod" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Disability.schema.json", + "title": "Disability", + "definitions": { + "Disability": { + "$id": "#Disability", + "type": "object", + "description": "Lack or inadequate strength or ability.", + "properties": { + "disabilityCode": { + "type": "string", + "description": "Code of the disability" + }, + "disabilityName": { + "type": "string", + "description": "Name of the disability" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Customer/OrderItem.schema.json b/Customer/OrderItem.schema.json index d64df0ca..b6e26d2b 100644 --- a/Customer/OrderItem.schema.json +++ b/Customer/OrderItem.schema.json @@ -1,89 +1,89 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderItem.schema.json", - "title": "OrderItem", - "definitions": { - "OrderItem": { - "$id": "#OrderItem", - "description": "An identified part of the order. A product order is decomposed into one or more order items.", - "type": "object", - "properties": { - "action": { - "type": "string", - "description": "Can be \"add\" / \"modify\" / \"no_change\"/ \"delete\"" - }, - "id": { - "type": "string", - "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" - }, - "quantity": { - "type": "integer", - "description": "Quantity ordered" - }, - "state": { - "type": "string", - "description": "State of the order item : described in the state machine diagram" - }, - "appointment": { - "$ref": "AppointmentRef.schema.json#AppointmentRef" - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef" - }, - "itemPrice": { - "type": "array", - "items": { - "$ref": "OrderPrice.schema.json#OrderPrice" - } - }, - "orderItem": { - "type": "array", - "items": { - "$ref": "OrderItem.schema.json#OrderItem" - } - }, - "orderItemRelationship": { - "type": "array", - "items": { - "$ref": "OrderItemRelationship.schema.json#OrderItemRelationship" - } - }, - "itemTotalPrice": { - "type": "array", - "items": { - "$ref": "OrderPrice.schema.json#OrderPrice" - } - }, - "payment": { - "type": "array", - "items": { - "$ref": "PaymentRef.schema.json#PaymentRef" - } - }, - "productOffering": { - "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "product": { - "$ref": "../Product/Product.schema.json#Product" - }, - "qualification": { - "type": "array", - "items": { - "$ref": "../Common/QualificationRef.schema.json#QualificationRef" - } - }, - "itemTerm": { - "type": "array", - "items": { - "$ref": "OrderTerm.schema.json#OrderTerm" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderItem.schema.json", + "title": "OrderItem", + "definitions": { + "OrderItem": { + "$id": "#OrderItem", + "description": "An identified part of the order. A product order is decomposed into one or more order items.", + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "Can be \"add\" / \"modify\" / \"no_change\"/ \"delete\"" + }, + "id": { + "type": "string", + "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" + }, + "quantity": { + "type": "integer", + "description": "Quantity ordered" + }, + "state": { + "type": "string", + "description": "State of the order item : described in the state machine diagram" + }, + "appointment": { + "$ref": "AppointmentRef.schema.json#AppointmentRef" + }, + "billingAccount": { + "$ref": "BillingAccountRef.schema.json#BillingAccountRef" + }, + "itemPrice": { + "type": "array", + "items": { + "$ref": "OrderPrice.schema.json#OrderPrice" + } + }, + "orderItem": { + "type": "array", + "items": { + "$ref": "OrderItem.schema.json#OrderItem" + } + }, + "orderItemRelationship": { + "type": "array", + "items": { + "$ref": "OrderItemRelationship.schema.json#OrderItemRelationship" + } + }, + "itemTotalPrice": { + "type": "array", + "items": { + "$ref": "OrderPrice.schema.json#OrderPrice" + } + }, + "payment": { + "type": "array", + "items": { + "$ref": "PaymentRef.schema.json#PaymentRef" + } + }, + "productOffering": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "product": { + "$ref": "../Product/Product.schema.json#Product" + }, + "qualification": { + "type": "array", + "items": { + "$ref": "../Common/QualificationRef.schema.json#QualificationRef" + } + }, + "itemTerm": { + "type": "array", + "items": { + "$ref": "OrderTerm.schema.json#OrderTerm" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/OrderItemActionType.schema.json b/Customer/OrderItemActionType.schema.json index 7fc1c889..8c41997d 100644 --- a/Customer/OrderItemActionType.schema.json +++ b/Customer/OrderItemActionType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderItemActionType.schema.json", - "title": "OrderItemActionType", - "definitions": { - "OrderItemActionType": { - "$id": "#OrderItemActionType", - "description": "action to be performed on the product", - "type": "string", - "enum": [ - "add", - "modify", - "delete", - "noChange" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderItemActionType.schema.json", + "title": "OrderItemActionType", + "definitions": { + "OrderItemActionType": { + "$id": "#OrderItemActionType", + "description": "action to be performed on the product", + "type": "string", + "enum": [ + "add", + "modify", + "delete", + "noChange" + ] } -} + } +} \ No newline at end of file diff --git a/Customer/OrderItemPrice.schema.json b/Customer/OrderItemPrice.schema.json index 51e86171..0408bc16 100644 --- a/Customer/OrderItemPrice.schema.json +++ b/Customer/OrderItemPrice.schema.json @@ -1,55 +1,58 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderItemPrice.schema.json", - "title": "OrderItemPrice", - "definitions": { - "OrderItemPrice": { - "$id": "#OrderItemPrice", - "description": "An amount, usually of money, that represents the actual price paid by the Customer for this item or this order", - "type": "object", - "required": ["priceType", "price"], - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail the semantics of this order item price." - }, - "name": { - "type": "string", - "description": "Name of the order item price" - }, - "productOfferingPrice": { - "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" - }, - "priceType": { - "type": "string", - "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth" - }, - "recurringChargePeriod": { - "type": "string", - "description": "Could be month, week..." - }, - "unitOfMeasure": { - "type": "string", - "description": "Could be minutes, GB..." - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef" - }, - "price": { - "$ref": "Price.schema.json#Price" - }, - "priceAlteration": { - "type": "array", - "items": { - "$ref": "PriceAlteration.schema.json#PriceAlteration" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderItemPrice.schema.json", + "title": "OrderItemPrice", + "definitions": { + "OrderItemPrice": { + "$id": "#OrderItemPrice", + "description": "An amount, usually of money, that represents the actual price paid by the Customer for this item or this order", + "type": "object", + "required": [ + "priceType", + "price" + ], + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail the semantics of this order item price." + }, + "name": { + "type": "string", + "description": "Name of the order item price" + }, + "productOfferingPrice": { + "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" + }, + "priceType": { + "type": "string", + "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth" + }, + "recurringChargePeriod": { + "type": "string", + "description": "Could be month, week..." + }, + "unitOfMeasure": { + "type": "string", + "description": "Could be minutes, GB..." + }, + "billingAccount": { + "$ref": "BillingAccountRef.schema.json#BillingAccountRef" + }, + "price": { + "$ref": "Price.schema.json#Price" + }, + "priceAlteration": { + "type": "array", + "items": { + "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/OrderItemRelationship.schema.json b/Customer/OrderItemRelationship.schema.json index 5bb17179..eef200bd 100644 --- a/Customer/OrderItemRelationship.schema.json +++ b/Customer/OrderItemRelationship.schema.json @@ -1,25 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderItemRelationship.schema.json", - "title": "OrderItemRelationship", - "definitions": { - "OrderItemRelationship": { - "$id": "#OrderItemRelationship", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "relationshipType": { - "type": "string", - "description": "The type of order item relationship" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderItemRelationship.schema.json", + "title": "OrderItemRelationship", + "definitions": { + "OrderItemRelationship": { + "$id": "#OrderItemRelationship", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "relationshipType": { + "type": "string", + "description": "The type of order item relationship" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/OrderPrice.schema.json b/Customer/OrderPrice.schema.json index 1da2cdef..374a3d68 100644 --- a/Customer/OrderPrice.schema.json +++ b/Customer/OrderPrice.schema.json @@ -1,58 +1,58 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderPrice.schema.json", - "title": "OrderPrice", - "definitions": { - "OrderPrice": { - "$id": "#OrderPrice", - "description": "An amount, usually of money, that represents the actual price paid by the Customer for this item or this order", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail the semantics of this order item price." - }, - "name": { - "type": "string", - "description": "A short descriptive name such as \"Subscription price\"." - }, - "productOfferingPrice": { - "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef", - "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time." - }, - "priceType": { - "type": "string", - "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth" - }, - "recurringChargePeriod": { - "type": "string", - "description": "Could be month, week..." - }, - "unitOfMeasure": { - "type": "string", - "description": "Could be minutes, GB..." - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef", - "description": "A reference to a billing account used for paid the order price charge" - }, - "price": { - "$ref": "Price.schema.json#Price", - "description": "a structure used to define price amount" - }, - "priceAlteration": { - "type": "array", - "description": "a strucuture used to describe a price alteration", - "items": { - "$ref": "PriceAlteration.schema.json#PriceAlteration" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderPrice.schema.json", + "title": "OrderPrice", + "definitions": { + "OrderPrice": { + "$id": "#OrderPrice", + "description": "An amount, usually of money, that represents the actual price paid by the Customer for this item or this order", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail the semantics of this order item price." + }, + "name": { + "type": "string", + "description": "A short descriptive name such as \"Subscription price\"." + }, + "productOfferingPrice": { + "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef", + "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time." + }, + "priceType": { + "type": "string", + "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth" + }, + "recurringChargePeriod": { + "type": "string", + "description": "Could be month, week..." + }, + "unitOfMeasure": { + "type": "string", + "description": "Could be minutes, GB..." + }, + "billingAccount": { + "$ref": "BillingAccountRef.schema.json#BillingAccountRef", + "description": "A reference to a billing account used for paid the order price charge" + }, + "price": { + "$ref": "Price.schema.json#Price", + "description": "a structure used to define price amount" + }, + "priceAlteration": { + "type": "array", + "description": "a strucuture used to describe a price alteration", + "items": { + "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/OrderRelationship.schema.json b/Customer/OrderRelationship.schema.json index 46384d75..190d8eec 100644 --- a/Customer/OrderRelationship.schema.json +++ b/Customer/OrderRelationship.schema.json @@ -1,28 +1,28 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderRelationship.schema.json", - "title": "OrderRelationship", - "definitions": { - "OrderRelationship": { - "$id": "#OrderRelationship", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "id": { - "type": "string" - }, - "relationshipType": { - "type": "string", - "description": "The type of order relationship" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderRelationship.schema.json", + "title": "OrderRelationship", + "definitions": { + "OrderRelationship": { + "$id": "#OrderRelationship", + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "id": { + "type": "string" + }, + "relationshipType": { + "type": "string", + "description": "The type of order relationship" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/OrderTerm.schema.json b/Customer/OrderTerm.schema.json index 71c60784..31804b0f 100644 --- a/Customer/OrderTerm.schema.json +++ b/Customer/OrderTerm.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderTerm.schema.json", - "title": "OrderTerm", - "definitions": { - "OrderTerm": { - "$id": "#OrderTerm", - "description": "Description of a productTerm linked to this orderItem. This represent a commitment with a duration", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the productOrderTerm" - }, - "duration": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "Duration of the productOrderTerm" - }, - "name": { - "type": "string", - "description": "Name of the productOrderTerm" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderTerm.schema.json", + "title": "OrderTerm", + "definitions": { + "OrderTerm": { + "$id": "#OrderTerm", + "description": "Description of a productTerm linked to this orderItem. This represent a commitment with a duration", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the productOrderTerm" + }, + "duration": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "Duration of the productOrderTerm" + }, + "name": { + "type": "string", + "description": "Name of the productOrderTerm" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/PaymentItem.schema.json b/Customer/PaymentItem.schema.json index a3f8fd2f..1b6da182 100644 --- a/Customer/PaymentItem.schema.json +++ b/Customer/PaymentItem.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PaymentItem.schema.json", - "title": "PaymentItem", - "definitions": { - "PaymentItem": { - "$id": "#PaymentItem", - "description": "The paymentItem is the result of lettering process. It enables to assign automatically or manually part of incoming payment amount to a bill", - "type": "object", - "properties": { - "appliedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Part of a payment amount lettered to the customer bill" - }, - "payment": { - "$ref": "PaymentRef.schema.json#PaymentRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PaymentItem.schema.json", + "title": "PaymentItem", + "definitions": { + "PaymentItem": { + "$id": "#PaymentItem", + "description": "The paymentItem is the result of lettering process. It enables to assign automatically or manually part of incoming payment amount to a bill", + "type": "object", + "properties": { + "appliedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Part of a payment amount lettered to the customer bill" + }, + "payment": { + "$ref": "PaymentRef.schema.json#PaymentRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/PaymentMethod.schema.json b/Customer/PaymentMethod.schema.json index a392d9cf..18a21ad7 100644 --- a/Customer/PaymentMethod.schema.json +++ b/Customer/PaymentMethod.schema.json @@ -1,59 +1,59 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PaymentMethod.schema.json", - "title": "PaymentMethod", - "definitions": { - "PaymentMethod": { - "$id": "#PaymentMethod", - "description": "Defines a specific method of payment (e.g. direct debit with all details associated)", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PaymentMethod.schema.json", + "title": "PaymentMethod", + "definitions": { + "PaymentMethod": { + "$id": "#PaymentMethod", + "description": "Defines a specific method of payment (e.g. direct debit with all details associated)", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/PaymentMethodRef.schema.json b/Customer/PaymentMethodRef.schema.json index 8c1d45d2..197aa98f 100644 --- a/Customer/PaymentMethodRef.schema.json +++ b/Customer/PaymentMethodRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PaymentMethodRef.schema.json", - "title": "PaymentMethodRef", - "definitions": { - "PaymentMethodRef": { - "$id": "#PaymentMethodRef", - "description": "PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the payment mean" - }, - "id": { - "type": "string", - "description": "Unique identifier of the payment mean" - }, - "name": { - "type": "string", - "description": "Name of the payment mean" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PaymentMethodRef.schema.json", + "title": "PaymentMethodRef", + "definitions": { + "PaymentMethodRef": { + "$id": "#PaymentMethodRef", + "description": "PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the payment mean" + }, + "id": { + "type": "string", + "description": "Unique identifier of the payment mean" + }, + "name": { + "type": "string", + "description": "Name of the payment mean" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/PaymentMethodRefOrValue.schema.json b/Customer/PaymentMethodRefOrValue.schema.json index 977ae091..26d0cd24 100644 --- a/Customer/PaymentMethodRefOrValue.schema.json +++ b/Customer/PaymentMethodRefOrValue.schema.json @@ -1,36 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PaymentMethodRefOrValue.schema.json", - "title": "PaymentMethodRefOrValue", - "definitions": { - "PaymentMethodRefOrValue": { - "description": "link to the resource that holds information about the payment mean used to complete the operation", - "properties": { - "details": { - "description": "The list of parameters depends on the type of payment method", - "$ref": "RelatedPartyRef.schema.json#/definitions/RelatedPartyRef" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the channel information" - }, - "id": { - "type": "string", - "description": "Unique identifier for the channel entity" - }, - "name": { - "type": "string", - "description": "Name of the channel" - }, - "type": { - "type": "string", - "description": "Type of payment method (bankcard, voucher, \ufffd)" - } - }, - "required": [ - "id", - "href" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PaymentMethodRefOrValue.schema.json", + "title": "PaymentMethodRefOrValue", + "definitions": { + "PaymentMethodRefOrValue": { + "$id": "#PaymentMethodRefOrValue", + "description": "link to the resource that holds information about the payment mean used to complete the operation", + "properties": { + "details": { + "description": "The list of parameters depends on the type of payment method", + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the channel information" + }, + "id": { + "type": "string", + "description": "Unique identifier for the channel entity" + }, + "name": { + "type": "string", + "description": "Name of the channel" + }, + "type": { + "type": "string", + "description": "Type of payment method (bankcard, voucher, �)" } + }, + "required": [ + "id", + "href" + ], + "type": "object" } -} + } +} \ No newline at end of file diff --git a/Customer/PaymentPlan.schema.json b/Customer/PaymentPlan.schema.json index ab273513..8dd1a313 100644 --- a/Customer/PaymentPlan.schema.json +++ b/Customer/PaymentPlan.schema.json @@ -1,50 +1,50 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PaymentPlan.schema.json", - "title": "PaymentPlan", - "definitions": { - "PaymentPlan": { - "$id": "#PaymentPlan", - "description": "Defines a plan for payment (when a party wants to spread his payments)", - "type": "object", - "properties": { - "numberOfPayments": { - "type": "integer", - "description": "Number of payments used to spread the global payment" - }, - "paymentFrequency": { - "type": "string", - "description": "Frequency of the payments, such as monthly and bimonthly" - }, - "priority": { - "type": "integer", - "description": "Priority of the payment plan" - }, - "status": { - "type": "string", - "description": "Status of the payment plan (effective, ineffective)" - }, - "totalAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Amount paid" - }, - "planType": { - "type": "string", - "description": "Type of payment plan" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Validity period of the payment plan" - }, - "paymentMethod": { - "$ref": "PaymentMethodRef.schema.json#PaymentMethodRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PaymentPlan.schema.json", + "title": "PaymentPlan", + "definitions": { + "PaymentPlan": { + "$id": "#PaymentPlan", + "description": "Defines a plan for payment (when a party wants to spread his payments)", + "type": "object", + "properties": { + "numberOfPayments": { + "type": "integer", + "description": "Number of payments used to spread the global payment" + }, + "paymentFrequency": { + "type": "string", + "description": "Frequency of the payments, such as monthly and bimonthly" + }, + "priority": { + "type": "integer", + "description": "Priority of the payment plan" + }, + "status": { + "type": "string", + "description": "Status of the payment plan (effective, ineffective)" + }, + "totalAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Amount paid" + }, + "planType": { + "type": "string", + "description": "Type of payment plan" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Validity period of the payment plan" + }, + "paymentMethod": { + "$ref": "PaymentMethodRef.schema.json#PaymentMethodRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/PaymentRef.schema.json b/Customer/PaymentRef.schema.json index d33ace61..db37a1c4 100644 --- a/Customer/PaymentRef.schema.json +++ b/Customer/PaymentRef.schema.json @@ -1,22 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PaymentRef.schema.json", - "title": "PaymentRef", - "definitions": { - "PaymentRef": { - "type": "object", - "description": "If an immediate payment has been done at the product order submission, the payment information are captured and stored (as a reference) in the order.", - "properties": { - "name": { - "type": "string", - "description": "A name for the payment" - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#/EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PaymentRef.schema.json", + "title": "PaymentRef", + "definitions": { + "PaymentRef": { + "$id": "#PaymentRef", + "type": "object", + "description": "If an immediate payment has been done at the product order submission, the payment information are captured and stored (as a reference) in the order.", + "properties": { + "name": { + "type": "string", + "description": "A name for the payment" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } + } } \ No newline at end of file diff --git a/Customer/Price.schema.json b/Customer/Price.schema.json index 1b0d091e..a77c2312 100644 --- a/Customer/Price.schema.json +++ b/Customer/Price.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Price.schema.json", - "title": "Price", - "definitions": { - "Price": { - "$id": "#Price", - "description": "Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.", - "type": "object", - "properties": { - "dutyFreeAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "All taxes excluded amount (expressed in the given currency)" - }, - "percentage": { - "type": "number", - "format": "float", - "description": "Percentage to apply for ProdOfferPriceAlteration" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "All taxes included amount (expressed in the given currency)" - }, - "taxRate": { - "type": "number", - "format": "float", - "description": "Tax rate" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Price.schema.json", + "title": "Price", + "definitions": { + "Price": { + "$id": "#Price", + "description": "Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.", + "type": "object", + "properties": { + "dutyFreeAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "All taxes excluded amount (expressed in the given currency)" + }, + "percentage": { + "type": "number", + "format": "float", + "description": "Percentage to apply for ProdOfferPriceAlteration" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "All taxes included amount (expressed in the given currency)" + }, + "taxRate": { + "type": "number", + "format": "float", + "description": "Tax rate" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/ProductOrder.schema.json b/Customer/ProductOrder.schema.json index cb884b7f..eb556d7e 100644 --- a/Customer/ProductOrder.schema.json +++ b/Customer/ProductOrder.schema.json @@ -1,144 +1,147 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOrder.schema.json", - "title": "ProductOrder", - "definitions": { - "ProductOrder": { - "type": "object", - "required": ["productOrderItem"], - "description": "A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa,", - "properties": { - "agreement": { - "type": "array", - "description": "A reference to an agreement defined in the context of the product order", - "items": { - "$ref": "AgreementRef.schema.json#/definitions/AgreementRef" - } - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#/definitions/BillingAccountRef" - }, - "cancellationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order is cancelled. This is used when order is cancelled. " - }, - "cancellationReason": { - "type": "string", - "description": "Reason why the order is cancelled. This is used when order is cancelled. " - }, - "category": { - "type": "string", - "description": "Used to categorize the order from a business perspective that can be useful for the OM system (e.g. \"enterprise\", \"residential\", ...)" - }, - "channel": { - "type": "array", - "items": { - "$ref": "RelatedChannel.schema.json#/definitions/RelatedChannel" - } - }, - "completionDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order was completed" - }, - "description": { - "type": "string", - "description": "Description of the product order" - }, - "expectedCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Expected delivery date amended by the provider" - }, - "externalId": { - "type": "string", - "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the order" - }, - "id": { - "type": "string", - "description": "ID created on repository side (OM system)" - }, - "note": { - "type": "array", - "items": { - "$ref": "Note.schema.json#/definitions/Note" - } - }, - "notificationContact": { - "type": "string", - "description": "Contact attached to the order to send back information regarding this order" - }, - "orderDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order was created" - }, - "orderTotalPrice": { - "type": "array", - "items": { - "$ref": "OrderPrice.schema.json#/definitions/OrderPrice" - } - }, - "payment": { - "type": "array", - "items": { - "$ref": "PaymentRef.schema.json#/definitions/PaymentRef" - } - }, - "priority": { - "type": "string", - "description": "A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)" - }, - "productOfferingQualification": { - "type": "array", - "items": { - "$ref": "ProductOfferingQualificationRef.schema.json#/definitions/ProductOfferingQualificationRef" - } - }, - "quote": { - "type": "array", - "items": { - "$ref": "QuoteRef.schema.json#/definitions/QuoteRef" - } - }, - "productOrderItem": { - "type": "array", - "items": { - "$ref": "ProductOrderItem.schema.json#/definitions/ProductOrderItem" - }, - "minItems": 1 - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#/definitions/RelatedParty" - } - }, - "requestedCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Requested delivery date from the requestor perspective" - }, - "requestedStartDate": { - "type": "string", - "format": "date-time", - "description": "Order fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow seller to begin to operationally begin the fulfillment before a date. " - }, - "state": { - "$ref": "ProductOrderStateType.schema.json#/definitions/ProductOrderStateType", - "description": "Tracks the lifecycle status of the product order, such as Acknowledged, Rejected, InProgress, Pending and so on." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#/Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOrder.schema.json", + "title": "ProductOrder", + "definitions": { + "ProductOrder": { + "$id": "#ProductOrder", + "type": "object", + "required": [ + "productOrderItem" + ], + "description": "A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa,", + "properties": { + "agreement": { + "type": "array", + "description": "A reference to an agreement defined in the context of the product order", + "items": { + "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" + } + }, + "billingAccount": { + "$ref": "BillingAccountRef.schema.json#BillingAccountRef" + }, + "cancellationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order is cancelled. This is used when order is cancelled. " + }, + "cancellationReason": { + "type": "string", + "description": "Reason why the order is cancelled. This is used when order is cancelled. " + }, + "category": { + "type": "string", + "description": "Used to categorize the order from a business perspective that can be useful for the OM system (e.g. \"enterprise\", \"residential\", ...)" + }, + "channel": { + "type": "array", + "items": { + "$ref": "../Common/RelatedChannel.schema.json#RelatedChannel" + } + }, + "completionDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order was completed" + }, + "description": { + "type": "string", + "description": "Description of the product order" + }, + "expectedCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Expected delivery date amended by the provider" + }, + "externalId": { + "type": "string", + "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the order" + }, + "id": { + "type": "string", + "description": "ID created on repository side (OM system)" + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "notificationContact": { + "type": "string", + "description": "Contact attached to the order to send back information regarding this order" + }, + "orderDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order was created" + }, + "orderTotalPrice": { + "type": "array", + "items": { + "$ref": "OrderPrice.schema.json#OrderPrice" + } + }, + "payment": { + "type": "array", + "items": { + "$ref": "PaymentRef.schema.json#PaymentRef" + } + }, + "priority": { + "type": "string", + "description": "A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)" + }, + "productOfferingQualification": { + "type": "array", + "items": { + "$ref": "../Product/ProductOfferingQualificationRef.schema.json#ProductOfferingQualificationRef" + } + }, + "quote": { + "type": "array", + "items": { + "$ref": "QuoteRef.schema.json#QuoteRef" + } + }, + "productOrderItem": { + "type": "array", + "items": { + "$ref": "ProductOrderItem.schema.json#ProductOrderItem" + }, + "minItems": 1 + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "requestedCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Requested delivery date from the requestor perspective" + }, + "requestedStartDate": { + "type": "string", + "format": "date-time", + "description": "Order fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow seller to begin to operationally begin the fulfillment before a date. " + }, + "state": { + "$ref": "ProductOrderStateType.schema.json#ProductOrderStateType", + "description": "Tracks the lifecycle status of the product order, such as Acknowledged, Rejected, InProgress, Pending and so on." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Customer/ProductOrderItem.schema.json b/Customer/ProductOrderItem.schema.json index c831bd29..09492aa6 100644 --- a/Customer/ProductOrderItem.schema.json +++ b/Customer/ProductOrderItem.schema.json @@ -1,94 +1,95 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOrderItem.schema.json", - "title": "ProductOrderItem", - "definitions": { - "ProductOrderItem": { - "type": "object", - "description": "An identified part of the order. A product order is decomposed into one or more order items.", - "properties": { - "id": { - "type": "string", - "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" - }, - "quantity": { - "type": "integer", - "description": "Quantity ordered" - }, - "action": { - "$ref": "OrderItemActionType.schema.json#/definitions/OrderItemActionType", - "description": "The action to be carried out on the Product. Can be: add, modify, delete, noChange" - }, - "appointment": { - "$ref": "AppointmentRef.schema.json#/definitions/AppointmentRef" - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#/definitions/BillingAccountRef" - }, - "itemPrice": { - "type": "array", - "items": { - "$ref": "OrderPrice.schema.json#/definitions/OrderPrice" - } - }, - "itemTerm": { - "type": "array", - "items": { - "$ref": "OrderTerm.schema.json#/definitions/OrderTerm" - } - }, - "itemTotalPrice": { - "type": "array", - "items": { - "$ref": "OrderPrice.schema.json#/definitions/OrderPrice" - } - }, - "payment": { - "type": "array", - "items": { - "$ref": "PaymentRef.schema.json#/definitions/PaymentRef" - } - }, - "product": { - "$ref": "ProductRefOrValue.schema.json#/definitions/ProductRefOrValue" - }, - "productOffering": { - "$ref": "ProductOfferingRef.schema.json#/definitions/ProductOfferingRef" - }, - "productOfferingQualificationItem": { - "$ref": "ProductOfferingQualificationItemRef.schema.json#/definitions/ProductOfferingQualificationItemRef" - }, - "quoteItem": { - "$ref": "QuoteItemRef.schema.json#/definitions/QuoteItemRef" - }, - "productOrderItem": { - "type": "array", - "items": { - "$ref": "ProductOrderItem.schema.json#/definitions/ProductOrderItem" - } - }, - "productOrderItemRelationship": { - "type": "array", - "items": { - "$ref": "OrderItemRelationship.schema.json#/definitions/OrderItemRelationship" - } - }, - "qualification": { - "type": "array", - "items": { - "$ref": "ProductOfferingQualificationRef.schema.json#/definitions/ProductOfferingQualificationRef" - } - }, - "state": { - "$ref": "ProductOrderItemStateType.schema.json#/definitions/ProductOrderItemStateType", - "description": "State of the order item : described in the state machine diagram" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#/Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOrderItem.schema.json", + "title": "ProductOrderItem", + "definitions": { + "ProductOrderItem": { + "$id": "#ProductOrderItem", + "type": "object", + "description": "An identified part of the order. A product order is decomposed into one or more order items.", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" + }, + "quantity": { + "type": "integer", + "description": "Quantity ordered" + }, + "action": { + "$ref": "OrderItemActionType.schema.json#OrderItemActionType", + "description": "The action to be carried out on the Product. Can be: add, modify, delete, noChange" + }, + "appointment": { + "$ref": "AppointmentRef.schema.json#AppointmentRef" + }, + "billingAccount": { + "$ref": "BillingAccountRef.schema.json#BillingAccountRef" + }, + "itemPrice": { + "type": "array", + "items": { + "$ref": "OrderPrice.schema.json#OrderPrice" + } + }, + "itemTerm": { + "type": "array", + "items": { + "$ref": "OrderTerm.schema.json#OrderTerm" + } + }, + "itemTotalPrice": { + "type": "array", + "items": { + "$ref": "OrderPrice.schema.json#OrderPrice" + } + }, + "payment": { + "type": "array", + "items": { + "$ref": "PaymentRef.schema.json#PaymentRef" + } + }, + "product": { + "$ref": "../Product/ProductRefOrValue.schema.json#ProductRefOrValue" + }, + "productOffering": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "productOfferingQualificationItem": { + "$ref": "../Product/ProductOfferingQualificationItemRef.schema.json#ProductOfferingQualificationItemRef" + }, + "quoteItem": { + "$ref": "QuoteItemRef.schema.json#QuoteItemRef" + }, + "productOrderItem": { + "type": "array", + "items": { + "$ref": "ProductOrderItem.schema.json#ProductOrderItem" + } + }, + "productOrderItemRelationship": { + "type": "array", + "items": { + "$ref": "OrderItemRelationship.schema.json#OrderItemRelationship" + } + }, + "qualification": { + "type": "array", + "items": { + "$ref": "../Product/ProductOfferingQualificationRef.schema.json#ProductOfferingQualificationRef" + } + }, + "state": { + "$ref": "ProductOrderItemStateType.schema.json#ProductOrderItemStateType", + "description": "State of the order item : described in the state machine diagram" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/ProductOrderItemStateType.schema.json b/Customer/ProductOrderItemStateType.schema.json index 065a7818..87da3c97 100644 --- a/Customer/ProductOrderItemStateType.schema.json +++ b/Customer/ProductOrderItemStateType.schema.json @@ -1,24 +1,24 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOrderItemStateType.schema.json", - "title": "ProductOrderItemStateType", - "definitions": { - "ProductOrderItemStateType": { - "$id": "#ProductOrderItemStateType", - "type": "string", - "description": "Possible values for the state of the product order item", - "enum": [ - "acknowledged", - "rejected", - "pending", - "held", - "inProgress", - "cancelled", - "completed", - "failed", - "assessingCancellation", - "pendingCancellation" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOrderItemStateType.schema.json", + "title": "ProductOrderItemStateType", + "definitions": { + "ProductOrderItemStateType": { + "$id": "#ProductOrderItemStateType", + "type": "string", + "description": "Possible values for the state of the product order item", + "enum": [ + "acknowledged", + "rejected", + "pending", + "held", + "inProgress", + "cancelled", + "completed", + "failed", + "assessingCancellation", + "pendingCancellation" + ] } -} + } +} \ No newline at end of file diff --git a/Customer/ProductOrderRef.schema.json b/Customer/ProductOrderRef.schema.json index ca3ed1ae..6cecbbc5 100644 --- a/Customer/ProductOrderRef.schema.json +++ b/Customer/ProductOrderRef.schema.json @@ -1,19 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOrderRef.schema.json", - "title": "ProductOrderRef", - "definitions": { - "ProductOrderRef": { - "$id": "#ProductOrderRef", - "description": "ProductOrder (ProductOrder) .The product order which the recommendation is related with.", - "type": "object", - "properties": { - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOrderRef.schema.json", + "title": "ProductOrderRef", + "definitions": { + "ProductOrderRef": { + "$id": "#ProductOrderRef", + "description": "ProductOrder (ProductOrder) .The product order which the recommendation is related with.", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/ProductOrderStateType.schema.json b/Customer/ProductOrderStateType.schema.json index cc29c0b1..857fed13 100644 --- a/Customer/ProductOrderStateType.schema.json +++ b/Customer/ProductOrderStateType.schema.json @@ -1,25 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOrderStateType.schema.json", - "title": "ProductOrderStateType", - "definitions": { - "ProductOrderStateType": { - "$id": "#ProductOrderStateType", - "type": "string", - "description": "Possible values for the state of the order", - "enum": [ - "acknowledged", - "rejected", - "pending", - "held", - "inProgress", - "cancelled", - "completed", - "failed", - "partial", - "assessingCancellation", - "pendingCancellation" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOrderStateType.schema.json", + "title": "ProductOrderStateType", + "definitions": { + "ProductOrderStateType": { + "$id": "#ProductOrderStateType", + "type": "string", + "description": "Possible values for the state of the order", + "enum": [ + "acknowledged", + "rejected", + "pending", + "held", + "inProgress", + "cancelled", + "completed", + "failed", + "partial", + "assessingCancellation", + "pendingCancellation" + ] } -} + } +} \ No newline at end of file diff --git a/Customer/Quote.schema.json b/Customer/Quote.schema.json index 1bda4656..9f45b0a3 100644 --- a/Customer/Quote.schema.json +++ b/Customer/Quote.schema.json @@ -1,145 +1,147 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Quote.schema.json", - "title": "Quote", - "definitions": { - "Quote": { - "type": "object", - "required": ["quoteItem"], - "description": "Quote can be used to negotiate service and product acquisition or modification between a customer and a service provider. Quote contain list of quote items, a reference to customer (partyRole), a list of productOffering and attached prices and conditions.", - "properties": { - "agreement": { - "type": "array", - "description": "A reference to an agreement defining the context of the quote", - "items": { - "$ref": "AgreementRef.schema.json#/definitions/AgreementRef" - } - }, - "billingAccount": { - "type": "array", - "description": "A reference to a billing account to provide quote context information ", - "items": { - "$ref": "BillingAccountRef.schema.json#/definitions/BillingAccountRef" - } - }, - "category": { - "type": "string", - "description": "Used to categorize the quote from a business perspective that can be useful for the CRM system (e.g. \"enterprise\", \"residential\", ...)" - }, - "contactMedium": { - "type": "array", - "description": "Information contact related to the quote requester", - "items": { - "$ref": "ContactMedium.schema.json#/definitions/ContactMedium" - } - }, - "description": { - "type": "string", - "description": "Description of the quote" - }, - "effectiveQuoteCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Date when the quote has been completed" - }, - "expectedFulfillmentStartDate": { - "type": "string", - "format": "date-time", - "description": "this is the date wished by the requester to have the requested quote item delivered" - }, - "expectedQuoteCompletionDate": { - "type": "string", - "format": "date-time", - "description": "This is expected date - from quote supplier - to be able to send back a response for this quote" - }, - "externalId": { - "type": "string", - "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the quote" - }, - "id": { - "type": "string", - "description": "Unique identifier - attributed by quoting system" - }, - "instantSyncQuote": { - "type": "boolean", - "description": "An indicator which when the value is \"true\" means that requester expects to get quoting result immediately in the response. If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201. " - }, - "note": { - "type": "array", - "description": "Free form text associated with the quote", - "items": { - "$ref": "Note.schema.json#/definitions/Note" - } - }, - "authorization": { - "type": "array", - "description": "An authorization provided for the quote", - "items": { - "$ref": "Authorization.schema.json#/definitions/Authorization" - } - }, - "quoteDate": { - "type": "string", - "format": "date-time", - "description": "Date and time when the quote was created" - }, - "quoteItem": { - "type": "array", - "description": "An item of the quote - it is used to descirbe an operation on a product to be quoted", - "items": { - "$ref": "QuoteItem.schema.json#/definitions/QuoteItem" - }, - "minItems": 1 - }, - "quoteTotalPrice": { - "type": "array", - "description": "Quote total price", - "items": { - "$ref": "QuotePrice.schema.json#/definitions/QuotePrice" - } - }, - "relatedParty": { - "type": "array", - "description": "A reference to a party playing a role in this quote (customer, seller, requester, etc.)", - "items": { - "$ref": "RelatedParty.schema.json#/definitions/RelatedParty" - } - }, - "productOfferingQualification": { - "type": "array", - "description": "A reference to a previously done product offering qualification", - "items": { - "$ref": "ProductOfferingQualificationRef.schema.json#/definitions/ProductOfferingQualificationRef" - } - }, - "requestedQuoteCompletionDate": { - "type": "string", - "format": "date-time", - "description": "This is requested date - from quote requester - to get a complete response for this quote" - }, - "state": { - "$ref": "QuoteStateType.schema.json#/definitions/QuoteStateType", - "description": "State of the quote : described in the state-machine diagram" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#/definitions/TimePeriod", - "description": "Quote validity period" - }, - "version": { - "type": "string", - "description": "Quote version - if the customer rejected the quote but negotiations still open a new version of the quote is managed" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#/Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Quote.schema.json", + "title": "Quote", + "definitions": { + "Quote": { + "$id": "#Quote", + "type": "object", + "required": [ + "quoteItem" + ], + "description": "Quote can be used to negotiate service and product acquisition or modification between a customer and a service provider. Quote contain list of quote items, a reference to customer (partyRole), a list of productOffering and attached prices and conditions.", + "properties": { + "agreement": { + "type": "array", + "description": "A reference to an agreement defining the context of the quote", + "items": { + "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" + } + }, + "billingAccount": { + "type": "array", + "description": "A reference to a billing account to provide quote context information ", + "items": { + "$ref": "BillingAccountRef.schema.json#BillingAccountRef" + } + }, + "category": { + "type": "string", + "description": "Used to categorize the quote from a business perspective that can be useful for the CRM system (e.g. \"enterprise\", \"residential\", ...)" + }, + "contactMedium": { + "type": "array", + "description": "Information contact related to the quote requester", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "description": { + "type": "string", + "description": "Description of the quote" + }, + "effectiveQuoteCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Date when the quote has been completed" + }, + "expectedFulfillmentStartDate": { + "type": "string", + "format": "date-time", + "description": "this is the date wished by the requester to have the requested quote item delivered" + }, + "expectedQuoteCompletionDate": { + "type": "string", + "format": "date-time", + "description": "This is expected date - from quote supplier - to be able to send back a response for this quote" + }, + "externalId": { + "type": "string", + "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the quote" + }, + "id": { + "type": "string", + "description": "Unique identifier - attributed by quoting system" + }, + "instantSyncQuote": { + "type": "boolean", + "description": "An indicator which when the value is \"true\" means that requester expects to get quoting result immediately in the response. If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201. " + }, + "note": { + "type": "array", + "description": "Free form text associated with the quote", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "authorization": { + "type": "array", + "description": "An authorization provided for the quote", + "items": { + "$ref": "Authorization.schema.json#Authorization" + } + }, + "quoteDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the quote was created" + }, + "quoteItem": { + "type": "array", + "description": "An item of the quote - it is used to descirbe an operation on a product to be quoted", + "items": { + "$ref": "QuoteItem.schema.json#QuoteItem" + }, + "minItems": 1 + }, + "quoteTotalPrice": { + "type": "array", + "description": "Quote total price", + "items": { + "$ref": "QuotePrice.schema.json#QuotePrice" + } + }, + "relatedParty": { + "type": "array", + "description": "A reference to a party playing a role in this quote (customer, seller, requester, etc.)", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "productOfferingQualification": { + "type": "array", + "description": "A reference to a previously done product offering qualification", + "items": { + "$ref": "../Product/ProductOfferingQualificationRef.schema.json#ProductOfferingQualificationRef" + } + }, + "requestedQuoteCompletionDate": { + "type": "string", + "format": "date-time", + "description": "This is requested date - from quote requester - to get a complete response for this quote" + }, + "state": { + "$ref": "../Product/QuoteStateType.schema.json#QuoteStateType", + "description": "State of the quote : described in the state-machine diagram" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Quote validity period" + }, + "version": { + "type": "string", + "description": "Quote version - if the customer rejected the quote but negotiations still open a new version of the quote is managed" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} - + } +} \ No newline at end of file diff --git a/Customer/QuoteItem.schema.json b/Customer/QuoteItem.schema.json index 69d514f2..0ba71951 100644 --- a/Customer/QuoteItem.schema.json +++ b/Customer/QuoteItem.schema.json @@ -1,100 +1,101 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteItem.schema.json", - "title": "QuoteItem", - "definitions": { - "QuoteItem": { - "type": "object", - "description": "A quote items describe an action to be performed on a productOffering or a product in order to get pricing elements and condition.", - "properties": { - "action": { - "type": "string", - "description": "Action to be performed on this quote item (add, modify, remove, etc.)" - }, - "appointment": { - "type": "array", - "description": "A reference to appointment(s) associated with this quote item", - "items": { - "$ref": "AppointmentRef.schema.json#/definitions/AppointmentRef" - } - }, - "attachment": { - "type": "array", - "description": "A reference to attachment(s) associated with this quote item", - "items": { - "$ref": "AttachmentRefOrValue.schema.json#/definitions/AttachmentRefOrValue" - } - }, - "id": { - "type": "string", - "description": "Identifier of the quote item (generally it is a sequence number 01, 02, 03, ...)" - }, - "note": { - "type": "array", - "description": "Free form text associated with the quote item", - "items": { - "$ref": "Note.schema.json#/definitions/Note" - } - }, - "product": { - "$ref": "ProductRefOrValue.schema.json#/definitions/ProductRefOrValue" - }, - "productOffering": { - "$ref": "ProductOfferingRef.schema.json#/definitions/ProductOfferingRef" - }, - "quantity": { - "type": "integer", - "description": "Quantity asked for this quote item" - }, - "quoteItem": { - "type": "array", - "description": "A structure to embedded quote item within quote item", - "items": { - "$ref": "QuoteItem.schema.json#/definitions/QuoteItem" - } - }, - "quoteItemAuthorization": { - "type": "array", - "description": "Authorization related to this quote item", - "items": { - "$ref": "Authorization.schema.json#/definitions/Authorization" - } - }, - "quoteItemPrice": { - "type": "array", - "description": "Price for this quote item", - "items": { - "$ref": "QuotePrice.schema.json#/definitions/QuotePrice" - } - }, - "quoteItemRelationship": { - "type": "array", - "description": "A relationship from item within a quote", - "items": { - "$ref": "QuoteItemRelationship.schema.json#/definitions/QuoteItemRelationship" - } - }, - "productOfferingQualificationItem": { - "description": "A reference to a previously done POQ with item specified", - "$ref": "ProductOfferingQualificationItemRef.schema.json#/definitions/ProductOfferingQualificationItemRef" - }, - "relatedParty": { - "type": "array", - "description": "A reference to a party playing a role in this quote item", - "items": { - "$ref": "RelatedParty.schema.json#/definitions/RelatedParty" - } - }, - "state": { - "type": "string", - "description": "State of the quote item : described in the state machine diagram" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#/Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteItem.schema.json", + "title": "QuoteItem", + "definitions": { + "QuoteItem": { + "$id": "#QuoteItem", + "type": "object", + "description": "A quote items describe an action to be performed on a productOffering or a product in order to get pricing elements and condition.", + "properties": { + "action": { + "type": "string", + "description": "Action to be performed on this quote item (add, modify, remove, etc.)" + }, + "appointment": { + "type": "array", + "description": "A reference to appointment(s) associated with this quote item", + "items": { + "$ref": "AppointmentRef.schema.json#AppointmentRef" + } + }, + "attachment": { + "type": "array", + "description": "A reference to attachment(s) associated with this quote item", + "items": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + } + }, + "id": { + "type": "string", + "description": "Identifier of the quote item (generally it is a sequence number 01, 02, 03, ...)" + }, + "note": { + "type": "array", + "description": "Free form text associated with the quote item", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "product": { + "$ref": "../Product/ProductRefOrValue.schema.json#ProductRefOrValue" + }, + "productOffering": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "quantity": { + "type": "integer", + "description": "Quantity asked for this quote item" + }, + "quoteItem": { + "type": "array", + "description": "A structure to embedded quote item within quote item", + "items": { + "$ref": "QuoteItem.schema.json#QuoteItem" + } + }, + "quoteItemAuthorization": { + "type": "array", + "description": "Authorization related to this quote item", + "items": { + "$ref": "Authorization.schema.json#Authorization" + } + }, + "quoteItemPrice": { + "type": "array", + "description": "Price for this quote item", + "items": { + "$ref": "QuotePrice.schema.json#QuotePrice" + } + }, + "quoteItemRelationship": { + "type": "array", + "description": "A relationship from item within a quote", + "items": { + "$ref": "QuoteItemRelationship.schema.json#QuoteItemRelationship" + } + }, + "productOfferingQualificationItem": { + "description": "A reference to a previously done POQ with item specified", + "$ref": "../Product/ProductOfferingQualificationItemRef.schema.json#ProductOfferingQualificationItemRef" + }, + "relatedParty": { + "type": "array", + "description": "A reference to a party playing a role in this quote item", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "state": { + "type": "string", + "description": "State of the quote item : described in the state machine diagram" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Customer/QuoteItemRef.schema.json b/Customer/QuoteItemRef.schema.json index f2c74b74..b39c4222 100644 --- a/Customer/QuoteItemRef.schema.json +++ b/Customer/QuoteItemRef.schema.json @@ -1,35 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteItemRef.schema.json", - "title": "QuoteItemRef", - "definitions": { - "QuoteItemRef": { - "type": "object", - "description": "It's a Quote item that has been executed previously.", - "required": ["id", "quoteId"], - "properties": { - "quoteHref": { - "type": "string", - "description": "Reference of the related entity." - }, - "quoteId": { - "type": "string", - "description": "Unique identifier of a related entity." - }, - "quoteName": { - "type": "string", - "description": "Name of the related entity." - }, - "id": { - "type": "string", - "description": "Id of an item of a quote" - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#/EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteItemRef.schema.json", + "title": "QuoteItemRef", + "definitions": { + "QuoteItemRef": { + "$id": "#QuoteItemRef", + "type": "object", + "description": "It's a Quote item that has been executed previously.", + "required": [ + "id", + "quoteId" + ], + "properties": { + "quoteHref": { + "type": "string", + "description": "Reference of the related entity." + }, + "quoteId": { + "type": "string", + "description": "Unique identifier of a related entity." + }, + "quoteName": { + "type": "string", + "description": "Name of the related entity." + }, + "id": { + "type": "string", + "description": "Id of an item of a quote" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } + } } \ No newline at end of file diff --git a/Customer/QuoteItemRelationship.schema.json b/Customer/QuoteItemRelationship.schema.json index f85b9000..956dd6da 100644 --- a/Customer/QuoteItemRelationship.schema.json +++ b/Customer/QuoteItemRelationship.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteItemRelationship.schema.json", - "title": "QuoteItemRelationship", - "definitions": { - "QuoteItemRelationship": { - "$id": "#QuoteItemRelationship", - "description": "Used to describe relationship between quote item. These relationship could have an impact on pricing and conditions", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "ID of the related order item (must be in the same quote)" - }, - "relationshipType": { - "type": "string", - "description": "Relationship type as relies on, bundles, etc..." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteItemRelationship.schema.json", + "title": "QuoteItemRelationship", + "definitions": { + "QuoteItemRelationship": { + "$id": "#QuoteItemRelationship", + "description": "Used to describe relationship between quote item. These relationship could have an impact on pricing and conditions", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the related order item (must be in the same quote)" + }, + "relationshipType": { + "type": "string", + "description": "Relationship type as relies on, bundles, etc..." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/QuotePrice.schema.json b/Customer/QuotePrice.schema.json index 490a7e8d..ccc7ec6a 100644 --- a/Customer/QuotePrice.schema.json +++ b/Customer/QuotePrice.schema.json @@ -1,52 +1,52 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuotePrice.schema.json", - "title": "QuotePrice", - "definitions": { - "QuotePrice": { - "$id": "#QuotePrice", - "description": "Description of price and discount awarded", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the quote/quote item price" - }, - "name": { - "type": "string", - "description": "Name of the quote /quote item price" - }, - "productOfferingPrice": { - "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef", - "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time." - }, - "priceType": { - "type": "string", - "description": "indicate if the price is for recurrent or no-recurrent charge" - }, - "recurringChargePeriod": { - "type": "string", - "description": "Used for recurring charge to indicate period (month, week, etc..)" - }, - "unitOfMeasure": { - "type": "string", - "description": "Unit of Measure if price depending on it (Gb, SMS volume, etc..)" - }, - "priceAlteration": { - "type": "array", - "items": { - "$ref": "PriceAlteration.schema.json#PriceAlteration" - } - }, - "price": { - "$ref": "Price.schema.json#Price" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuotePrice.schema.json", + "title": "QuotePrice", + "definitions": { + "QuotePrice": { + "$id": "#QuotePrice", + "description": "Description of price and discount awarded", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the quote/quote item price" + }, + "name": { + "type": "string", + "description": "Name of the quote /quote item price" + }, + "productOfferingPrice": { + "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef", + "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time." + }, + "priceType": { + "type": "string", + "description": "indicate if the price is for recurrent or no-recurrent charge" + }, + "recurringChargePeriod": { + "type": "string", + "description": "Used for recurring charge to indicate period (month, week, etc..)" + }, + "unitOfMeasure": { + "type": "string", + "description": "Unit of Measure if price depending on it (Gb, SMS volume, etc..)" + }, + "priceAlteration": { + "type": "array", + "items": { + "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" + } + }, + "price": { + "$ref": "Price.schema.json#Price" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/QuoteRef.schema.json b/Customer/QuoteRef.schema.json index d4769ef8..980bbd5f 100644 --- a/Customer/QuoteRef.schema.json +++ b/Customer/QuoteRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteRef.schema.json", - "title": "QuoteRef", - "definitions": { - "QuoteRef": { - "type": "object", - "description": "It's a Quote that has been executed previously", - "properties": { - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#/EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteRef.schema.json", + "title": "QuoteRef", + "definitions": { + "QuoteRef": { + "$id": "#QuoteRef", + "type": "object", + "description": "It's a Quote that has been executed previously", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } + } } \ No newline at end of file diff --git a/Customer/SearchTimeSlot.schema.json b/Customer/SearchTimeSlot.schema.json index c587849b..848fcd39 100644 --- a/Customer/SearchTimeSlot.schema.json +++ b/Customer/SearchTimeSlot.schema.json @@ -1,65 +1,66 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SearchTimeSlot.schema.json", - "title": "SearchTimeSlot", - "definitions": { - "SearchTimeSlot": { - "type": "object", - "description": "This task resource is used to retrieve available time slots. One of this available time slot is after used to create or reschedule an appointment", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the search time slot request" - }, - "href": { - "type": "string", - "description": "Reference to access the search time slot resource" - }, - "status": { - "type": "string", - "description": "Status of the search time slot (rejected, inProgress, done or terminatedWithError)" - }, - "searchDate": { - "type": "string", - "format": "date-time", - "description": "Date when the search time slot is performed" - }, - "searchResult": { - "type": "string", - "description": "Result of the search time slot (success or fail for example)" - }, - "requestedTimeSlot": { - "type": "array", - "items": { - "$ref": "TimeSlot.schema.json#/definitions/TimeSlot" - } - }, - "availableTimeSlot": { - "type": "array", - "items": { - "$ref": "TimeSlot.schema.json#/definitions/TimeSlot" - } - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty", - "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity." - }, - "relatedEntity": { - "type": "array", - "items": { - "$ref": "../Common/RelatedEntity.schema.json#RelatedEntity" - } - }, - "relatedPlace": { - "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue", - "description": "Related place defines (by reference or value) the place where the appointment will take place." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SearchTimeSlot.schema.json", + "title": "SearchTimeSlot", + "definitions": { + "SearchTimeSlot": { + "$id": "#SearchTimeSlot", + "type": "object", + "description": "This task resource is used to retrieve available time slots. One of this available time slot is after used to create or reschedule an appointment", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the search time slot request" + }, + "href": { + "type": "string", + "description": "Reference to access the search time slot resource" + }, + "status": { + "type": "string", + "description": "Status of the search time slot (rejected, inProgress, done or terminatedWithError)" + }, + "searchDate": { + "type": "string", + "format": "date-time", + "description": "Date when the search time slot is performed" + }, + "searchResult": { + "type": "string", + "description": "Result of the search time slot (success or fail for example)" + }, + "requestedTimeSlot": { + "type": "array", + "items": { + "$ref": "TimeSlot.schema.json#TimeSlot" + } + }, + "availableTimeSlot": { + "type": "array", + "items": { + "$ref": "TimeSlot.schema.json#TimeSlot" + } + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty", + "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity." + }, + "relatedEntity": { + "type": "array", + "items": { + "$ref": "../Common/RelatedEntity.schema.json#RelatedEntity" + } + }, + "relatedPlace": { + "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue", + "description": "Related place defines (by reference or value) the place where the appointment will take place." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Customer/SettlementMethod.schema.json b/Customer/SettlementMethod.schema.json index e6a6ce9d..1386ed37 100644 --- a/Customer/SettlementMethod.schema.json +++ b/Customer/SettlementMethod.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SettlementMethod.schema.json", - "title": "SettlementMethod", - "definitions": { - "SettlementMethod": { - "$id": "#SettlementMethod", - "description": "Is the way in which the CSP provides the payment", - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Code of the settlement method" - }, - "label": { - "type": "string", - "description": "A word, term or phrase by which a settlement method is known and distinguished from other settlement method" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SettlementMethod.schema.json", + "title": "SettlementMethod", + "definitions": { + "SettlementMethod": { + "$id": "#SettlementMethod", + "description": "Is the way in which the CSP provides the payment", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Code of the settlement method" + }, + "label": { + "type": "string", + "description": "A word, term or phrase by which a settlement method is known and distinguished from other settlement method" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/SettlementNoteAdvice.schema.json b/Customer/SettlementNoteAdvice.schema.json index 19be573f..2365301b 100644 --- a/Customer/SettlementNoteAdvice.schema.json +++ b/Customer/SettlementNoteAdvice.schema.json @@ -1,92 +1,92 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SettlementNoteAdvice.schema.json", - "title": "SettlementNoteAdvice", - "definitions": { - "SettlementNoteAdvice": { - "$id": "#SettlementNoteAdvice", - "description": "The settlement is about transferring money receiving by a CSP to a partner. The settlement is notified to the partner with a settlement note advice containing details in settlement lines.", - "type": "object", - "properties": { - "currencyCode": { - "type": "string", - "description": "A string used as a code for specifying the currency associated to the given amounts. The ISO4217 norm uses 3 letters to define the currency (for example USD for US dollar or EUR for Euro)." - }, - "date": { - "type": "string", - "format": "date-time", - "description": "Creation date of the settlement note advice" - }, - "description": { - "type": "string", - "description": "A free description text" - }, - "href": { - "type": "string", - "description": "Reference of the settlement note advice" - }, - "id": { - "type": "string", - "description": "A unique identifier for the settlement note advice" - }, - "issuerTaxRegistration": { - "type": "string", - "description": "Tax registration number of the issuer" - }, - "paymentDueDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the due amount should have been paid to the partner" - }, - "receiverTaxRegistration": { - "type": "string", - "description": "Tax registration number of the receiver" - }, - "taxDate": { - "type": "string", - "format": "date-time", - "description": "Date of the tax" - }, - "taxExcludedAmount": { - "type": "number", - "format": "float", - "description": "All taxes excluded amount (expressed in the given currency)" - }, - "taxIncludedAmount": { - "type": "number", - "format": "float", - "description": "All taxes included amount (expressed in the given currency)" - }, - "settlementMethod": { - "$ref": "SettlementMethod.schema.json#SettlementMethod" - }, - "settlementNoteImage": { - "$ref": "SettlementNoteImage.schema.json#SettlementNoteImage" - }, - "receiver": { - "$ref": "../EngagedParty/PartyRef.schema.json#PartyRef" - }, - "taxItem": { - "type": "array", - "items": { - "$ref": "TaxItem.schema.json#TaxItem" - } - }, - "issuer": { - "$ref": "../EngagedParty/PartyRef.schema.json#PartyRef" - }, - "settlementNoteItem": { - "type": "array", - "items": { - "$ref": "SettlementNoteItem.schema.json#SettlementNoteItem" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SettlementNoteAdvice.schema.json", + "title": "SettlementNoteAdvice", + "definitions": { + "SettlementNoteAdvice": { + "$id": "#SettlementNoteAdvice", + "description": "The settlement is about transferring money receiving by a CSP to a partner. The settlement is notified to the partner with a settlement note advice containing details in settlement lines.", + "type": "object", + "properties": { + "currencyCode": { + "type": "string", + "description": "A string used as a code for specifying the currency associated to the given amounts. The ISO4217 norm uses 3 letters to define the currency (for example USD for US dollar or EUR for Euro)." + }, + "date": { + "type": "string", + "format": "date-time", + "description": "Creation date of the settlement note advice" + }, + "description": { + "type": "string", + "description": "A free description text" + }, + "href": { + "type": "string", + "description": "Reference of the settlement note advice" + }, + "id": { + "type": "string", + "description": "A unique identifier for the settlement note advice" + }, + "issuerTaxRegistration": { + "type": "string", + "description": "Tax registration number of the issuer" + }, + "paymentDueDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the due amount should have been paid to the partner" + }, + "receiverTaxRegistration": { + "type": "string", + "description": "Tax registration number of the receiver" + }, + "taxDate": { + "type": "string", + "format": "date-time", + "description": "Date of the tax" + }, + "taxExcludedAmount": { + "type": "number", + "format": "float", + "description": "All taxes excluded amount (expressed in the given currency)" + }, + "taxIncludedAmount": { + "type": "number", + "format": "float", + "description": "All taxes included amount (expressed in the given currency)" + }, + "settlementMethod": { + "$ref": "SettlementMethod.schema.json#SettlementMethod" + }, + "settlementNoteImage": { + "$ref": "SettlementNoteImage.schema.json#SettlementNoteImage" + }, + "receiver": { + "$ref": "../EngagedParty/PartyRef.schema.json#PartyRef" + }, + "taxItem": { + "type": "array", + "items": { + "$ref": "TaxItem.schema.json#TaxItem" + } + }, + "issuer": { + "$ref": "../EngagedParty/PartyRef.schema.json#PartyRef" + }, + "settlementNoteItem": { + "type": "array", + "items": { + "$ref": "SettlementNoteItem.schema.json#SettlementNoteItem" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/SettlementNoteImage.schema.json b/Customer/SettlementNoteImage.schema.json index 0feb3b43..dc7db03b 100644 --- a/Customer/SettlementNoteImage.schema.json +++ b/Customer/SettlementNoteImage.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SettlementNoteImage.schema.json", - "title": "SettlementNoteImage", - "definitions": { - "SettlementNoteImage": { - "$id": "#SettlementNoteImage", - "description": "Is the image of the settlement note", - "type": "object", - "properties": { - "imageFileName": { - "type": "string", - "description": "The name of the file in which the settlement note image is saved." - }, - "imageFileURL": { - "type": "string", - "description": "The URL of the settlement note image" - }, - "imageFormat": { - "type": "string", - "description": "The format of the settlement note image (csv, pdf, xls, txt...)" - }, - "imageSize": { - "type": "integer", - "description": "The size of the settlement note image (in bytes)" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SettlementNoteImage.schema.json", + "title": "SettlementNoteImage", + "definitions": { + "SettlementNoteImage": { + "$id": "#SettlementNoteImage", + "description": "Is the image of the settlement note", + "type": "object", + "properties": { + "imageFileName": { + "type": "string", + "description": "The name of the file in which the settlement note image is saved." + }, + "imageFileURL": { + "type": "string", + "description": "The URL of the settlement note image" + }, + "imageFormat": { + "type": "string", + "description": "The format of the settlement note image (csv, pdf, xls, txt...)" + }, + "imageSize": { + "type": "integer", + "description": "The size of the settlement note image (in bytes)" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/SettlementNoteItem.schema.json b/Customer/SettlementNoteItem.schema.json index 7a592f48..10cce5f6 100644 --- a/Customer/SettlementNoteItem.schema.json +++ b/Customer/SettlementNoteItem.schema.json @@ -1,59 +1,59 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SettlementNoteItem.schema.json", - "title": "SettlementNoteItem", - "definitions": { - "SettlementNoteItem": { - "$id": "#SettlementNoteItem", - "description": "Concerns a product identified by its catalogue reference. It could also follow a period delimited by a start and an end date.", - "type": "object", - "properties": { - "itemId": { - "type": "string", - "description": "Unique identifier of the settlement note item" - }, - "itemLabel": { - "type": "string", - "description": "A free description text for the settlement note item" - }, - "itemNumber": { - "type": "string", - "description": "Unique number assigned to the settlement note item" - }, - "period": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - }, - "quantity": { - "type": "integer", - "description": "Quantity" - }, - "taxExcludedAmount": { - "type": "number", - "format": "float", - "description": "Tax excluded amount equal to quantity * taxExcludedUnitPrice" - }, - "taxExcludedUnitPrice": { - "type": "number", - "format": "float", - "description": "Tax excluded unit price to be applied on the given quantity" - }, - "taxIncludedAmount": { - "type": "number", - "format": "float", - "description": "All taxes included amount equal to taxExcludedAmount + taxAmount" - }, - "taxItem": { - "type": "array", - "items": { - "$ref": "TaxItem.schema.json#TaxItem" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SettlementNoteItem.schema.json", + "title": "SettlementNoteItem", + "definitions": { + "SettlementNoteItem": { + "$id": "#SettlementNoteItem", + "description": "Concerns a product identified by its catalogue reference. It could also follow a period delimited by a start and an end date.", + "type": "object", + "properties": { + "itemId": { + "type": "string", + "description": "Unique identifier of the settlement note item" + }, + "itemLabel": { + "type": "string", + "description": "A free description text for the settlement note item" + }, + "itemNumber": { + "type": "string", + "description": "Unique number assigned to the settlement note item" + }, + "period": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + }, + "quantity": { + "type": "integer", + "description": "Quantity" + }, + "taxExcludedAmount": { + "type": "number", + "format": "float", + "description": "Tax excluded amount equal to quantity * taxExcludedUnitPrice" + }, + "taxExcludedUnitPrice": { + "type": "number", + "format": "float", + "description": "Tax excluded unit price to be applied on the given quantity" + }, + "taxIncludedAmount": { + "type": "number", + "format": "float", + "description": "All taxes included amount equal to taxExcludedAmount + taxAmount" + }, + "taxItem": { + "type": "array", + "items": { + "$ref": "TaxItem.schema.json#TaxItem" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/ShoppingCart.schema.json b/Customer/ShoppingCart.schema.json index db504a0e..4cf8dda2 100644 --- a/Customer/ShoppingCart.schema.json +++ b/Customer/ShoppingCart.schema.json @@ -1,56 +1,56 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ShoppingCart.schema.json", - "title": "ShoppingCart", - "definitions": { - "ShoppingCart": { - "$id": "#ShoppingCart", - "description": "Shopping Cart resource is used for the temporarily selection and reservation of product offerings in e-commerce, call center and retail purchase. Shopping cart supports purchase of both physical and digital goods and service (e.g. handset, telecom network service). Shopping Cart contain list of cart items, a reference to customer (partyRole) or contact medium in case customer not exist, and the total items price including promotions", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink to access the shopping cart" - }, - "id": { - "type": "string", - "description": "Unique identifier created on provider side (e.g. Order Capture system)" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the shopping cart is valid (e.g. 90 if no activity or 7 days if cart is empty)" - }, - "contactMedium": { - "type": "array", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - }, - "cartTotalPrice": { - "type": "array", - "items": { - "$ref": "CartPrice.schema.json#CartPrice" - }, - "description": "Total amount of the shopping cart, usually of money, that represents the actual price paid by the Customer for cart (considering only \"Active\" cart items)" - }, - "cartItem": { - "type": "array", - "items": { - "$ref": "CartItem.schema.json#CartItem" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ShoppingCart.schema.json", + "title": "ShoppingCart", + "definitions": { + "ShoppingCart": { + "$id": "#ShoppingCart", + "description": "Shopping Cart resource is used for the temporarily selection and reservation of product offerings in e-commerce, call center and retail purchase. Shopping cart supports purchase of both physical and digital goods and service (e.g. handset, telecom network service). Shopping Cart contain list of cart items, a reference to customer (partyRole) or contact medium in case customer not exist, and the total items price including promotions", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink to access the shopping cart" + }, + "id": { + "type": "string", + "description": "Unique identifier created on provider side (e.g. Order Capture system)" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the shopping cart is valid (e.g. 90 if no activity or 7 days if cart is empty)" + }, + "contactMedium": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "cartTotalPrice": { + "type": "array", + "items": { + "$ref": "CartPrice.schema.json#CartPrice" + }, + "description": "Total amount of the shopping cart, usually of money, that represents the actual price paid by the Customer for cart (considering only \"Active\" cart items)" + }, + "cartItem": { + "type": "array", + "items": { + "$ref": "CartItem.schema.json#CartItem" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/ShoppingCartRef.schema.json b/Customer/ShoppingCartRef.schema.json index 8a4ffe45..26c0230e 100644 --- a/Customer/ShoppingCartRef.schema.json +++ b/Customer/ShoppingCartRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ShoppingCartRef.schema.json", - "title": "ShoppingCartRef", - "definitions": { - "ShoppingCartRef": { - "$id": "#ShoppingCartRef", - "description": "ShoppingCart (ShoppingCartRef) . The shopping cart which the recommendation is related with.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hypertext Reference of the shopping cart." - }, - "id": { - "type": "string", - "description": "Unique identifier of shopping cart" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ShoppingCartRef.schema.json", + "title": "ShoppingCartRef", + "definitions": { + "ShoppingCartRef": { + "$id": "#ShoppingCartRef", + "description": "ShoppingCart (ShoppingCartRef) . The shopping cart which the recommendation is related with.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hypertext Reference of the shopping cart." + }, + "id": { + "type": "string", + "description": "Unique identifier of shopping cart" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/TaxItem.schema.json b/Customer/TaxItem.schema.json index 5e15ce54..f35e98b2 100644 --- a/Customer/TaxItem.schema.json +++ b/Customer/TaxItem.schema.json @@ -1,32 +1,32 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaxItem.schema.json", - "title": "TaxItem", - "definitions": { - "TaxItem": { - "$id": "#TaxItem", - "description": "A tax item is created for each tax rate and tax type used in the bill.", - "type": "object", - "properties": { - "taxAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Amount of tax expressed in the given currency" - }, - "taxCategory": { - "type": "string", - "description": "Tax category" - }, - "taxRate": { - "type": "number", - "format": "float", - "description": "Applied rate of the tax" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaxItem.schema.json", + "title": "TaxItem", + "definitions": { + "TaxItem": { + "$id": "#TaxItem", + "description": "A tax item is created for each tax rate and tax type used in the bill.", + "type": "object", + "properties": { + "taxAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Amount of tax expressed in the given currency" + }, + "taxCategory": { + "type": "string", + "description": "Tax category" + }, + "taxRate": { + "type": "number", + "format": "float", + "description": "Applied rate of the tax" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/TimeSlot.schema.json b/Customer/TimeSlot.schema.json index 3f3882c9..ae8d5967 100644 --- a/Customer/TimeSlot.schema.json +++ b/Customer/TimeSlot.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TimeSlot.schema.json", - "title": "TimeSlot", - "definitions": { - "TimeSlot": { - "$id": "#TimeSlot", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the TimeSlot" - }, - "id": { - "type": "string", - "description": "Unique identifier of the TimeSlot" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty", - "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Start date and end date of the timeSlot" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TimeSlot.schema.json", + "title": "TimeSlot", + "definitions": { + "TimeSlot": { + "$id": "#TimeSlot", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the TimeSlot" + }, + "id": { + "type": "string", + "description": "Unique identifier of the TimeSlot" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty", + "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Start date and end date of the timeSlot" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Customer/TokenizedCardDetails.schema.json b/Customer/TokenizedCardDetails.schema.json index 4292b252..2c314fe4 100644 --- a/Customer/TokenizedCardDetails.schema.json +++ b/Customer/TokenizedCardDetails.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TokenizedCardDetails.schema.json", - "title": "TokenizedCardDetails", - "definitions": { - "TokenizedCardDetails": { - "$id": "#TokenizedCardDetails", - "description": "Detailed information for a stored tokenized card", - "type": "object", - "properties": { - "brand": { - "type": "string", - "description": "Card brand. Might be used for display purposes" - }, - "issuer": { - "type": "string", - "description": "Whoever issued the token" - }, - "lastFourDigits": { - "type": "string", - "description": "Last four digits of the credit card. Might be used for display purposes" - }, - "token": { - "type": "string", - "description": "The token itself" - }, - "tokenType": { - "type": "string", - "description": "Token type (e.g.: emv)" - }, - "cardType": { - "type": "string", - "description": "Card type. Might be used for display purposes" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TokenizedCardDetails.schema.json", + "title": "TokenizedCardDetails", + "definitions": { + "TokenizedCardDetails": { + "$id": "#TokenizedCardDetails", + "description": "Detailed information for a stored tokenized card", + "type": "object", + "properties": { + "brand": { + "type": "string", + "description": "Card brand. Might be used for display purposes" + }, + "issuer": { + "type": "string", + "description": "Whoever issued the token" + }, + "lastFourDigits": { + "type": "string", + "description": "Last four digits of the credit card. Might be used for display purposes" + }, + "token": { + "type": "string", + "description": "The token itself" + }, + "tokenType": { + "type": "string", + "description": "Token type (e.g.: emv)" + }, + "cardType": { + "type": "string", + "description": "Card type. Might be used for display purposes" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/TokenizedCardMethod.schema.json b/Customer/TokenizedCardMethod.schema.json index 45a89730..e680d994 100644 --- a/Customer/TokenizedCardMethod.schema.json +++ b/Customer/TokenizedCardMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TokenizedCardMethod.schema.json", - "title": "TokenizedCardMethod", - "definitions": { - "TokenizedCardMethod": { - "$id": "#TokenizedCardMethod", - "type": "object", - "properties": { - "details": { - "$ref": "TokenizedCardDetails.schema.json#TokenizedCardDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TokenizedCardMethod.schema.json", + "title": "TokenizedCardMethod", + "definitions": { + "TokenizedCardMethod": { + "$id": "#TokenizedCardMethod", + "type": "object", + "properties": { + "details": { + "$ref": "TokenizedCardDetails.schema.json#TokenizedCardDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/VoucherDetails.schema.json b/Customer/VoucherDetails.schema.json index 8997fca2..bf0bc289 100644 --- a/Customer/VoucherDetails.schema.json +++ b/Customer/VoucherDetails.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "VoucherDetails.schema.json", - "title": "VoucherDetails", - "definitions": { - "VoucherDetails": { - "$id": "#VoucherDetails", - "description": "Detailed information of a voucher", - "type": "object", - "properties": { - "campaign": { - "type": "string", - "description": "Campaign this voucher belongs to" - }, - "code": { - "type": "string", - "description": "Code that identifies the voucher" - }, - "expirationDate": { - "type": "string", - "format": "date-time", - "description": "The vouchers expiration date" - }, - "value": { - "type": "number", - "format": "float", - "description": "Discount that the voucher applies when it is a discount" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "VoucherDetails.schema.json", + "title": "VoucherDetails", + "definitions": { + "VoucherDetails": { + "$id": "#VoucherDetails", + "description": "Detailed information of a voucher", + "type": "object", + "properties": { + "campaign": { + "type": "string", + "description": "Campaign this voucher belongs to" + }, + "code": { + "type": "string", + "description": "Code that identifies the voucher" + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "The vouchers expiration date" + }, + "value": { + "type": "number", + "format": "float", + "description": "Discount that the voucher applies when it is a discount" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Customer/VoucherMethod.schema.json b/Customer/VoucherMethod.schema.json index f81ce5a5..c9a6c996 100644 --- a/Customer/VoucherMethod.schema.json +++ b/Customer/VoucherMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "VoucherMethod.schema.json", - "title": "VoucherMethod", - "definitions": { - "VoucherMethod": { - "$id": "#VoucherMethod", - "type": "object", - "properties": { - "details": { - "$ref": "VoucherDetails.schema.json#VoucherDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "VoucherMethod.schema.json", + "title": "VoucherMethod", + "definitions": { + "VoucherMethod": { + "$id": "#VoucherMethod", + "type": "object", + "properties": { + "details": { + "$ref": "VoucherDetails.schema.json#VoucherDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/Account.schema.json b/EngagedParty/Account.schema.json index 21273d22..8db480bf 100644 --- a/EngagedParty/Account.schema.json +++ b/EngagedParty/Account.schema.json @@ -1,85 +1,85 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Account.schema.json", - "title": "Account", - "definitions": { - "Account": { - "$id": "#Account", - "description": "Generic Account structure used to define commonalities between sub concepts of PartyAccount and Financial Account.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "creditLimit": { - "$ref": "../Common/Money.schema.json#Money", - "description": "The maximum amount of money that may be charged on an account" - }, - "description": { - "type": "string", - "description": "Detailed description of the party account" - }, - "href": { - "type": "string", - "description": "Unique reference of the account" - }, - "id": { - "type": "string", - "description": "Unique identifier of the account" - }, - "lastModified": { - "type": "string", - "format": "date-time", - "description": "Date of last modification of the account" - }, - "name": { - "type": "string", - "description": "Name of the account" - }, - "state": { - "type": "string", - "description": "Contains the lifecycle state such as: Active, Closed, Suspended and so on." - }, - "accountType": { - "type": "string", - "description": "A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values." - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "taxExemption": { - "type": "array", - "items": { - "$ref": "AccountTaxExemption.schema.json#AccountTaxExemption" - } - }, - "contact": { - "type": "array", - "items": { - "$ref": "Contact.schema.json#Contact" - } - }, - "accountBalance": { - "type": "array", - "items": { - "$ref": "AccountBalance.schema.json#AccountBalance" - } - }, - "accountRelationship": { - "type": "array", - "items": { - "$ref": "AccountRelationship.schema.json#AccountRelationship" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Account.schema.json", + "title": "Account", + "definitions": { + "Account": { + "$id": "#Account", + "description": "Generic Account structure used to define commonalities between sub concepts of PartyAccount and Financial Account.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "creditLimit": { + "$ref": "../Common/Money.schema.json#Money", + "description": "The maximum amount of money that may be charged on an account" + }, + "description": { + "type": "string", + "description": "Detailed description of the party account" + }, + "href": { + "type": "string", + "description": "Unique reference of the account" + }, + "id": { + "type": "string", + "description": "Unique identifier of the account" + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "Date of last modification of the account" + }, + "name": { + "type": "string", + "description": "Name of the account" + }, + "state": { + "type": "string", + "description": "Contains the lifecycle state such as: Active, Closed, Suspended and so on." + }, + "accountType": { + "type": "string", + "description": "A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values." + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "RelatedParty.schema.json#RelatedParty" + } + }, + "taxExemption": { + "type": "array", + "items": { + "$ref": "AccountTaxExemption.schema.json#AccountTaxExemption" + } + }, + "contact": { + "type": "array", + "items": { + "$ref": "Contact.schema.json#Contact" + } + }, + "accountBalance": { + "type": "array", + "items": { + "$ref": "AccountBalance.schema.json#AccountBalance" + } + }, + "accountRelationship": { + "type": "array", + "items": { + "$ref": "AccountRelationship.schema.json#AccountRelationship" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/AccountBalance.schema.json b/EngagedParty/AccountBalance.schema.json index 78613e77..d60a9551 100644 --- a/EngagedParty/AccountBalance.schema.json +++ b/EngagedParty/AccountBalance.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountBalance.schema.json", - "title": "AccountBalance", - "definitions": { - "AccountBalance": { - "$id": "#AccountBalance", - "description": "Balances linked to the account", - "type": "object", - "required": [ - "amount", - "balanceType", - "validFor" - ], - "properties": { - "amount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Balance amount" - }, - "balanceType": { - "type": "string", - "description": "Type of the balance : deposit balance, disputed balance, loyalty balance, receivable balance..." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Balance validity period" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountBalance.schema.json", + "title": "AccountBalance", + "definitions": { + "AccountBalance": { + "$id": "#AccountBalance", + "description": "Balances linked to the account", + "type": "object", + "required": [ + "amount", + "balanceType", + "validFor" + ], + "properties": { + "amount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Balance amount" + }, + "balanceType": { + "type": "string", + "description": "Type of the balance : deposit balance, disputed balance, loyalty balance, receivable balance..." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Balance validity period" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/AccountBalanceRef.schema.json b/EngagedParty/AccountBalanceRef.schema.json index acd3381a..aa3fa050 100644 --- a/EngagedParty/AccountBalanceRef.schema.json +++ b/EngagedParty/AccountBalanceRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountBalanceRef.schema.json", - "title": "AccountBalanceRef", - "definitions": { - "AccountBalanceRef": { - "$id": "#AccountBalanceRef", - "description": "Balances linked to the account", - "type": "object", - "properties": { - "amount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Balance amount" - }, - "status": { - "type": "string", - "description": "The condition of the account balance, such as due, paid, in arrears." - }, - "balanceType": { - "type": "string", - "description": "Type of the balance : deposit balance, disputed balance, loyalty balance, receivable balance..." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountBalanceRef.schema.json", + "title": "AccountBalanceRef", + "definitions": { + "AccountBalanceRef": { + "$id": "#AccountBalanceRef", + "description": "Balances linked to the account", + "type": "object", + "properties": { + "amount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Balance amount" + }, + "status": { + "type": "string", + "description": "The condition of the account balance, such as due, paid, in arrears." + }, + "balanceType": { + "type": "string", + "description": "Type of the balance : deposit balance, disputed balance, loyalty balance, receivable balance..." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/AccountDirectDetails.schema.json b/EngagedParty/AccountDirectDetails.schema.json index 40e28632..03f76f7d 100644 --- a/EngagedParty/AccountDirectDetails.schema.json +++ b/EngagedParty/AccountDirectDetails.schema.json @@ -1,21 +1,21 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountDirectDetails.schema.json", - "title": "AccountDirectDetails", - "definitions": { - "AccountDirectDetails": { - "$id": "#AccountDirectDetails", - "type": "object", - "properties": { - "account": { - "$ref": "AccountRef.schema.json#AccountRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountDirectDetails.schema.json", + "title": "AccountDirectDetails", + "definitions": { + "AccountDirectDetails": { + "$id": "#AccountDirectDetails", + "type": "object", + "properties": { + "account": { + "$ref": "AccountRef.schema.json#AccountRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/AccountDirectMethod.schema.json b/EngagedParty/AccountDirectMethod.schema.json index ebde4d06..56a4f83c 100644 --- a/EngagedParty/AccountDirectMethod.schema.json +++ b/EngagedParty/AccountDirectMethod.schema.json @@ -1,62 +1,62 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountDirectMethod.schema.json", - "title": "AccountDirectMethod", - "definitions": { - "AccountDirectMethod": { - "$id": "#AccountDirectMethod", - "description": "A payment method using an internal account that could be billed directly to perform the payment", - "type": "object", - "properties": { - "details": { - "$ref": "AccountRef.schema.json#AccountRef" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountDirectMethod.schema.json", + "title": "AccountDirectMethod", + "definitions": { + "AccountDirectMethod": { + "$id": "#AccountDirectMethod", + "description": "A payment method using an internal account that could be billed directly to perform the payment", + "type": "object", + "properties": { + "details": { + "$ref": "AccountRef.schema.json#AccountRef" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "AccountRef.schema.json#AccountRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/AccountRef.schema.json b/EngagedParty/AccountRef.schema.json index 1af0f98e..226a60d7 100644 --- a/EngagedParty/AccountRef.schema.json +++ b/EngagedParty/AccountRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountRef.schema.json", - "title": "AccountRef", - "definitions": { - "AccountRef": { - "$id": "#AccountRef", - "description": "Account reference. A account may be a party account or a financial account.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Detailed description of the account" - }, - "href": { - "type": "string", - "description": "Reference of the account" - }, - "id": { - "type": "string", - "description": "Unique identifier of the account" - }, - "name": { - "type": "string", - "description": "Name of the account" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountRef.schema.json", + "title": "AccountRef", + "definitions": { + "AccountRef": { + "$id": "#AccountRef", + "description": "Account reference. A account may be a party account or a financial account.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Detailed description of the account" + }, + "href": { + "type": "string", + "description": "Reference of the account" + }, + "id": { + "type": "string", + "description": "Unique identifier of the account" + }, + "name": { + "type": "string", + "description": "Name of the account" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/AccountRelationship.schema.json b/EngagedParty/AccountRelationship.schema.json index 4e847e76..71f81f23 100644 --- a/EngagedParty/AccountRelationship.schema.json +++ b/EngagedParty/AccountRelationship.schema.json @@ -1,33 +1,33 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountRelationship.schema.json", - "title": "AccountRelationship", - "definitions": { - "AccountRelationship": { - "$id": "#AccountRelationship", - "description": "Significant connection between accounts. For instance an aggregating account for a list of shop branches each having its own billing account.", - "type": "object", - "required": [ - "relationshipType" - ], - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of relationship" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Validity period of that relationship" - }, - "account": { - "$ref": "AccountRef.schema.json#AccountRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountRelationship.schema.json", + "title": "AccountRelationship", + "definitions": { + "AccountRelationship": { + "$id": "#AccountRelationship", + "description": "Significant connection between accounts. For instance an aggregating account for a list of shop branches each having its own billing account.", + "type": "object", + "required": [ + "relationshipType" + ], + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of relationship" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Validity period of that relationship" + }, + "account": { + "$ref": "AccountRef.schema.json#AccountRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/AccountTaxExemption.schema.json b/EngagedParty/AccountTaxExemption.schema.json index fdbfbf9d..1d74fe39 100644 --- a/EngagedParty/AccountTaxExemption.schema.json +++ b/EngagedParty/AccountTaxExemption.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountTaxExemption.schema.json", - "title": "AccountTaxExemption", - "definitions": { - "AccountTaxExemption": { - "$id": "#AccountTaxExemption", - "description": "Proof of freedom from taxes imposed by a taxing jurisdiction", - "type": "object", - "required": [ - "issuingJurisdiction", - "validFor" - ], - "properties": { - "certificateNumber": { - "type": "string", - "description": "Identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction" - }, - "issuingJurisdiction": { - "type": "string", - "description": "Name of the taxing jurisdiction for which taxes are exempt" - }, - "reason": { - "type": "string", - "description": "Reason of the tax exemption" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Period for which the exemption is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountTaxExemption.schema.json", + "title": "AccountTaxExemption", + "definitions": { + "AccountTaxExemption": { + "$id": "#AccountTaxExemption", + "description": "Proof of freedom from taxes imposed by a taxing jurisdiction", + "type": "object", + "required": [ + "issuingJurisdiction", + "validFor" + ], + "properties": { + "certificateNumber": { + "type": "string", + "description": "Identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction" + }, + "issuingJurisdiction": { + "type": "string", + "description": "Name of the taxing jurisdiction for which taxes are exempt" + }, + "reason": { + "type": "string", + "description": "Reason of the tax exemption" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Period for which the exemption is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/Agreement.schema.json b/EngagedParty/Agreement.schema.json index 54b2efd0..95dd38b2 100644 --- a/EngagedParty/Agreement.schema.json +++ b/EngagedParty/Agreement.schema.json @@ -1,103 +1,108 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Agreement.schema.json", - "title": "Agreement", - "definitions": { - "Agreement": { - "$id": "#Agreement", - "description": "An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", - "type": "object", - "required": ["name","agreementType","engagedPartyRole","agreementItem"], - "properties": { - "agreementPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The time period during which the Agreement is in effect." - }, - "completionDate": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date at which the agreement is completed" - }, - "description": { - "type": "string", - "description": "Narrative that explains the agreement and details about the it , such as why the agreement is taking place." - }, - "documentNumber": { - "type": "integer", - "description": "A reference number assigned to an Agreement that follows a prescribed numbering system." - }, - "href": { - "type": "string", - "description": "Unique url identifying the agreement as a resource" - }, - "id": { - "type": "string", - "description": "Unique identifier for the agreement" - }, - "initialDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the agreement was initialized" - }, - "name": { - "type": "string", - "description": "A human-readable name for the agreement" - }, - "statementOfIntent": { - "type": "string", - "description": "An overview and goals of the Agreement" - }, - "status": { - "type": "string", - "description": "The current status of the agreement. Typical values are: in process, approved and rejected" - }, - "agreementType": { - "type": "string", - "description": "The type of the agreement. For example commercial" - }, - "version": { - "type": "string", - "description": "A string identifying the version of the agreement" - }, - "agreementSpecification": { - "$ref": "AgreementSpecificationRef.schema.json#AgreementSpecificationRef" - }, - "agreementItem": { - "type": "array", - "items": { - "$ref": "AgreementItem.schema.json#AgreementItem" - }, - "minItems": 1 - }, - "engagedPartyRole": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "agreementAuthorization": { - "type": "array", - "items": { - "$ref": "AgreementAuthorization.schema.json#AgreementAuthorization" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - } - }, - "associatedAgreement": { - "type": "array", - "items": { - "$ref": "AgreementRef.schema.json#AgreementRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Agreement.schema.json", + "title": "Agreement", + "definitions": { + "Agreement": { + "$id": "#Agreement", + "description": "An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", + "type": "object", + "required": [ + "name", + "agreementType", + "engagedPartyRole", + "agreementItem" + ], + "properties": { + "agreementPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The time period during which the Agreement is in effect." + }, + "completionDate": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date at which the agreement is completed" + }, + "description": { + "type": "string", + "description": "Narrative that explains the agreement and details about the it , such as why the agreement is taking place." + }, + "documentNumber": { + "type": "integer", + "description": "A reference number assigned to an Agreement that follows a prescribed numbering system." + }, + "href": { + "type": "string", + "description": "Unique url identifying the agreement as a resource" + }, + "id": { + "type": "string", + "description": "Unique identifier for the agreement" + }, + "initialDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the agreement was initialized" + }, + "name": { + "type": "string", + "description": "A human-readable name for the agreement" + }, + "statementOfIntent": { + "type": "string", + "description": "An overview and goals of the Agreement" + }, + "status": { + "type": "string", + "description": "The current status of the agreement. Typical values are: in process, approved and rejected" + }, + "agreementType": { + "type": "string", + "description": "The type of the agreement. For example commercial" + }, + "version": { + "type": "string", + "description": "A string identifying the version of the agreement" + }, + "agreementSpecification": { + "$ref": "AgreementSpecificationRef.schema.json#AgreementSpecificationRef" + }, + "agreementItem": { + "type": "array", + "items": { + "$ref": "AgreementItem.schema.json#AgreementItem" + }, + "minItems": 1 + }, + "engagedPartyRole": { + "type": "array", + "items": { + "$ref": "RelatedParty.schema.json#RelatedParty" + } + }, + "agreementAuthorization": { + "type": "array", + "items": { + "$ref": "AgreementAuthorization.schema.json#AgreementAuthorization" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "associatedAgreement": { + "type": "array", + "items": { + "$ref": "AgreementRef.schema.json#AgreementRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/AgreementAttachment.schema.json b/EngagedParty/AgreementAttachment.schema.json index 25a73640..be3554c3 100644 --- a/EngagedParty/AgreementAttachment.schema.json +++ b/EngagedParty/AgreementAttachment.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementAttachment.schema.json", - "title": "AgreementAttachment", - "definitions": { - "AgreementAttachment": { - "$id": "#AgreementAttachment", - "description": "Represents a complementary piece of information to describe the agreement. Could be a document, picture, a video or any kind of multimedia content.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the attachment" - }, - "id": { - "type": "string", - "description": "Unique identifier of the attachment" - }, - "attachmentType": { - "type": "string", - "description": "The type of attachment, such as video, picture" - }, - "url": { - "type": "string", - "format": "uri", - "description": "Uniform Resource Locator, is a web page address (a subset of URI)" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementAttachment.schema.json", + "title": "AgreementAttachment", + "definitions": { + "AgreementAttachment": { + "$id": "#AgreementAttachment", + "description": "Represents a complementary piece of information to describe the agreement. Could be a document, picture, a video or any kind of multimedia content.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the attachment" + }, + "id": { + "type": "string", + "description": "Unique identifier of the attachment" + }, + "attachmentType": { + "type": "string", + "description": "The type of attachment, such as video, picture" + }, + "url": { + "type": "string", + "format": "uri", + "description": "Uniform Resource Locator, is a web page address (a subset of URI)" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/AgreementAuthorization.schema.json b/EngagedParty/AgreementAuthorization.schema.json index 8e95fb16..feca623c 100644 --- a/EngagedParty/AgreementAuthorization.schema.json +++ b/EngagedParty/AgreementAuthorization.schema.json @@ -1,32 +1,32 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementAuthorization.schema.json", - "title": "AgreementAuthorization", - "definitions": { - "AgreementAuthorization": { - "$id": "#AgreementAuthorization", - "description": "A business participant that is responsible for approving the agreement.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time", - "description": "The date associated with the authorization state." - }, - "signatureRepresentation": { - "type": "string", - "description": "Indication that represents whether the signature is a physical paper signature or a digital signature." - }, - "state": { - "type": "string", - "description": "Current status of the authorization, for example in process, approved, rejected." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementAuthorization.schema.json", + "title": "AgreementAuthorization", + "definitions": { + "AgreementAuthorization": { + "$id": "#AgreementAuthorization", + "description": "A business participant that is responsible for approving the agreement.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "The date associated with the authorization state." + }, + "signatureRepresentation": { + "type": "string", + "description": "Indication that represents whether the signature is a physical paper signature or a digital signature." + }, + "state": { + "type": "string", + "description": "Current status of the authorization, for example in process, approved, rejected." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/AgreementItem.schema.json b/EngagedParty/AgreementItem.schema.json index 10c6d605..29959505 100644 --- a/EngagedParty/AgreementItem.schema.json +++ b/EngagedParty/AgreementItem.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementItem.schema.json", - "title": "AgreementItem", - "definitions": { - "AgreementItem": { - "$id": "#AgreementItem", - "description": "A part of the agreement expressed in terms of a product offering and possibly including specific terms and conditions.", - "type": "object", - "properties": { - "productOffering": { - "type": "array", - "items": { - "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" - } - }, - "termOrCondition": { - "type": "array", - "items": { - "$ref": "AgreementTermOrCondition.schema.json#AgreementTermOrCondition" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementItem.schema.json", + "title": "AgreementItem", + "definitions": { + "AgreementItem": { + "$id": "#AgreementItem", + "description": "A part of the agreement expressed in terms of a product offering and possibly including specific terms and conditions.", + "type": "object", + "properties": { + "productOffering": { + "type": "array", + "items": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + } + }, + "termOrCondition": { + "type": "array", + "items": { + "$ref": "AgreementTermOrCondition.schema.json#AgreementTermOrCondition" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/AgreementItemRef.schema.json b/EngagedParty/AgreementItemRef.schema.json index 180bc7a7..9c719156 100644 --- a/EngagedParty/AgreementItemRef.schema.json +++ b/EngagedParty/AgreementItemRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementItemRef.schema.json", - "title": "AgreementItemRef", - "definitions": { - "AgreementItemRef": { - "$id": "#AgreementItemRef", - "description": "Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", - "type": "object", - "properties": { - "agreementItemId": { - "type": "string", - "description": "Identifier of the agreement" - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementItemRef.schema.json", + "title": "AgreementItemRef", + "definitions": { + "AgreementItemRef": { + "$id": "#AgreementItemRef", + "description": "Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", + "type": "object", + "properties": { + "agreementItemId": { + "type": "string", + "description": "Identifier of the agreement" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/AgreementRef.schema.json b/EngagedParty/AgreementRef.schema.json index 11c3a149..ba52468b 100644 --- a/EngagedParty/AgreementRef.schema.json +++ b/EngagedParty/AgreementRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementRef.schema.json", - "title": "AgreementRef", - "definitions": { - "AgreementRef": { - "$id": "#AgreementRef", - "description": "Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the agreement" - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementRef.schema.json", + "title": "AgreementRef", + "definitions": { + "AgreementRef": { + "$id": "#AgreementRef", + "description": "Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the agreement" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/AgreementSpecCharacteristic.schema.json b/EngagedParty/AgreementSpecCharacteristic.schema.json index 6a42536a..239abf1d 100644 --- a/EngagedParty/AgreementSpecCharacteristic.schema.json +++ b/EngagedParty/AgreementSpecCharacteristic.schema.json @@ -1,45 +1,45 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementSpecCharacteristic.schema.json", - "title": "AgreementSpecCharacteristic", - "definitions": { - "AgreementSpecCharacteristic": { - "$id": "#AgreementSpecCharacteristic", - "description": "A characteristic quality or distinctive feature of an agreement.", - "type": "object", - "properties": { - "configurable": { - "type": "boolean", - "description": "If true, the Boolean indicates that the characteristic is configurable" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the characteristic is" - }, - "name": { - "type": "string", - "description": "Name of the characteristic being specified." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the specification characteristic is valid" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" - }, - "specCharacteristicValue": { - "type": "array", - "items": { - "$ref": "AgreementSpecCharacteristicValue.schema.json#AgreementSpecCharacteristicValue" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementSpecCharacteristic.schema.json", + "title": "AgreementSpecCharacteristic", + "definitions": { + "AgreementSpecCharacteristic": { + "$id": "#AgreementSpecCharacteristic", + "description": "A characteristic quality or distinctive feature of an agreement.", + "type": "object", + "properties": { + "configurable": { + "type": "boolean", + "description": "If true, the Boolean indicates that the characteristic is configurable" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the characteristic is" + }, + "name": { + "type": "string", + "description": "Name of the characteristic being specified." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the specification characteristic is valid" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" + }, + "specCharacteristicValue": { + "type": "array", + "items": { + "$ref": "AgreementSpecCharacteristicValue.schema.json#AgreementSpecCharacteristicValue" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/AgreementSpecCharacteristicValue.schema.json b/EngagedParty/AgreementSpecCharacteristicValue.schema.json index 68a73c56..bb076f0b 100644 --- a/EngagedParty/AgreementSpecCharacteristicValue.schema.json +++ b/EngagedParty/AgreementSpecCharacteristicValue.schema.json @@ -1,47 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementSpecCharacteristicValue.schema.json", - "title": "AgreementSpecCharacteristicValue", - "definitions": { - "AgreementSpecCharacteristicValue": { - "$id": "#AgreementSpecCharacteristicValue", - "description": "A number or text that can be assigned to an agreement specification characteristic.", - "type": "object", - "properties": { - "default": { - "type": "boolean", - "description": "Indicates if the value is the default value for a characteristic" - }, - "unitOfMeasure": { - "type": "string", - "description": "Unit of measure for the characteristic, such as minutes, gigabytes (GB) and so on." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period of time for which a value is applicable" - }, - "value": { - "$ref": "../Common/Any.schema.json#Any", - "description": "A discrete value that the characteristic can take on" - }, - "valueFrom": { - "type": "string", - "description": "The low range value that a characteristic can take on" - }, - "valueTo": { - "type": "string", - "description": "The upper range value that a characteristic can take on" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementSpecCharacteristicValue.schema.json", + "title": "AgreementSpecCharacteristicValue", + "definitions": { + "AgreementSpecCharacteristicValue": { + "$id": "#AgreementSpecCharacteristicValue", + "description": "A number or text that can be assigned to an agreement specification characteristic.", + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Indicates if the value is the default value for a characteristic" + }, + "unitOfMeasure": { + "type": "string", + "description": "Unit of measure for the characteristic, such as minutes, gigabytes (GB) and so on." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period of time for which a value is applicable" + }, + "value": { + "$ref": "../Common/Any.schema.json#Any", + "description": "A discrete value that the characteristic can take on" + }, + "valueFrom": { + "type": "string", + "description": "The low range value that a characteristic can take on" + }, + "valueTo": { + "type": "string", + "description": "The upper range value that a characteristic can take on" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/AgreementSpecification.schema.json b/EngagedParty/AgreementSpecification.schema.json index 4ab77f42..26d878b1 100644 --- a/EngagedParty/AgreementSpecification.schema.json +++ b/EngagedParty/AgreementSpecification.schema.json @@ -1,87 +1,87 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementSpecification.schema.json", - "title": "AgreementSpecification", - "definitions": { - "AgreementSpecification": { - "$id": "#AgreementSpecification", - "description": "A template of an agreement that can be used when establishing partnerships", - "type": "object", - "required": [ - "name", - "attachment" - ], - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail what the agreement specification is about" - }, - "href": { - "type": "string", - "description": "Reference of the agreement specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the agreement specification" - }, - "isBundle": { - "type": "boolean", - "description": "If true, this agreement specification is a grouping of other agreement specifications. The list of bundled agreement specifications is provided by the specificationRelationship property" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Indicates the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the agreement specification" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the agreement specification is valid" - }, - "version": { - "type": "string", - "description": "Agreement specification version" - }, - "serviceCategory": { - "$ref": "../Product/CategoryRef.schema.json#CategoryRef" - }, - "specificationCharacteristic": { - "type": "array", - "items": { - "$ref": "AgreementSpecCharacteristic.schema.json#AgreementSpecCharacteristic" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "attachment": { - "type": "array", - "items": { - "$ref": "AttachmentRefOrValue.schema.json#AttachmentRefOrValue" - } - }, - "specificationRelationship": { - "type": "array", - "items": { - "$ref": "AgreementSpecificationRelationship.schema.json#AgreementSpecificationRelationship" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementSpecification.schema.json", + "title": "AgreementSpecification", + "definitions": { + "AgreementSpecification": { + "$id": "#AgreementSpecification", + "description": "A template of an agreement that can be used when establishing partnerships", + "type": "object", + "required": [ + "name", + "attachment" + ], + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail what the agreement specification is about" + }, + "href": { + "type": "string", + "description": "Reference of the agreement specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the agreement specification" + }, + "isBundle": { + "type": "boolean", + "description": "If true, this agreement specification is a grouping of other agreement specifications. The list of bundled agreement specifications is provided by the specificationRelationship property" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Indicates the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the agreement specification" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the agreement specification is valid" + }, + "version": { + "type": "string", + "description": "Agreement specification version" + }, + "serviceCategory": { + "$ref": "../Product/CategoryRef.schema.json#CategoryRef" + }, + "specificationCharacteristic": { + "type": "array", + "items": { + "$ref": "AgreementSpecCharacteristic.schema.json#AgreementSpecCharacteristic" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "RelatedParty.schema.json#RelatedParty" + } + }, + "attachment": { + "type": "array", + "items": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + } + }, + "specificationRelationship": { + "type": "array", + "items": { + "$ref": "AgreementSpecificationRelationship.schema.json#AgreementSpecificationRelationship" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/AgreementSpecificationRef.schema.json b/EngagedParty/AgreementSpecificationRef.schema.json index 826ee48a..391bc37e 100644 --- a/EngagedParty/AgreementSpecificationRef.schema.json +++ b/EngagedParty/AgreementSpecificationRef.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementSpecificationRef.schema.json", - "title": "AgreementSpecificationRef", - "definitions": { - "AgreementSpecificationRef": { - "$id": "#AgreementSpecificationRef", - "description": "AgreementSpecification reference. An AgreementSpecification represents a template of an agreement that can be used when establishing partnerships.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail what the agreement specification is about." - }, - "name": { - "type": "string", - "description": "Name of the agreement specification" - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementSpecificationRef.schema.json", + "title": "AgreementSpecificationRef", + "definitions": { + "AgreementSpecificationRef": { + "$id": "#AgreementSpecificationRef", + "description": "AgreementSpecification reference. An AgreementSpecification represents a template of an agreement that can be used when establishing partnerships.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail what the agreement specification is about." + }, + "name": { + "type": "string", + "description": "Name of the agreement specification" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/AgreementSpecificationRelationship.schema.json b/EngagedParty/AgreementSpecificationRelationship.schema.json index d7a27e4b..21ae1786 100644 --- a/EngagedParty/AgreementSpecificationRelationship.schema.json +++ b/EngagedParty/AgreementSpecificationRelationship.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementSpecificationRelationship.schema.json", - "title": "AgreementSpecificationRelationship", - "definitions": { - "AgreementSpecificationRelationship": { - "$id": "#AgreementSpecificationRelationship", - "description": "A relationship between agreement specifications. Typical relationships are substitution and dependency.", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of relationship such as, substitution or dependency." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the relationship is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementSpecificationRelationship.schema.json", + "title": "AgreementSpecificationRelationship", + "definitions": { + "AgreementSpecificationRelationship": { + "$id": "#AgreementSpecificationRelationship", + "description": "A relationship between agreement specifications. Typical relationships are substitution and dependency.", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of relationship such as, substitution or dependency." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the relationship is valid" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/AgreementTermOrCondition.schema.json b/EngagedParty/AgreementTermOrCondition.schema.json index 9e118f54..2e68c723 100644 --- a/EngagedParty/AgreementTermOrCondition.schema.json +++ b/EngagedParty/AgreementTermOrCondition.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementTermOrCondition.schema.json", - "title": "AgreementTermOrCondition", - "definitions": { - "AgreementTermOrCondition": { - "$id": "#AgreementTermOrCondition", - "description": "Aspects of the agreement not formally specified elsewhere in the agreement and that cannot be captured elsewhere in a formal notation, or automatically monitored and require a more human level of management.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Text that explains the term or condition of the agreement." - }, - "id": { - "type": "string", - "description": "Unique number assigned for reference." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period of time during which the term or condition of the agreement applies." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementTermOrCondition.schema.json", + "title": "AgreementTermOrCondition", + "definitions": { + "AgreementTermOrCondition": { + "$id": "#AgreementTermOrCondition", + "description": "Aspects of the agreement not formally specified elsewhere in the agreement and that cannot be captured elsewhere in a formal notation, or automatically monitored and require a more human level of management.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Text that explains the term or condition of the agreement." + }, + "id": { + "type": "string", + "description": "Unique number assigned for reference." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period of time during which the term or condition of the agreement applies." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/BankAccount.schema.json b/EngagedParty/BankAccount.schema.json index 5424e0c1..5ccb5c49 100644 --- a/EngagedParty/BankAccount.schema.json +++ b/EngagedParty/BankAccount.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankAccount.schema.json", - "title": "BankAccount", - "definitions": { - "BankAccount": { - "$id": "#BankAccount", - "description": "Describes the information of a bank account", - "type": "object", - "properties": { - "accountHolder": { - "type": "string", - "description": "Name of the holder of the bank account" - }, - "BIC": { - "type": "string", - "description": "Identifier of the bank according to its international code" - }, - "domiciliation": { - "type": "string", - "description": "Address of the bank agency which manages the bank account" - }, - "IBAN": { - "type": "string", - "description": "International Bank Account Number" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankAccount.schema.json", + "title": "BankAccount", + "definitions": { + "BankAccount": { + "$id": "#BankAccount", + "description": "Describes the information of a bank account", + "type": "object", + "properties": { + "accountHolder": { + "type": "string", + "description": "Name of the holder of the bank account" + }, + "BIC": { + "type": "string", + "description": "Identifier of the bank according to its international code" + }, + "domiciliation": { + "type": "string", + "description": "Address of the bank agency which manages the bank account" + }, + "IBAN": { + "type": "string", + "description": "International Bank Account Number" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/BankAccountDebitDetails.schema.json b/EngagedParty/BankAccountDebitDetails.schema.json index 71a542fa..8bc2840e 100644 --- a/EngagedParty/BankAccountDebitDetails.schema.json +++ b/EngagedParty/BankAccountDebitDetails.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankAccountDebitDetails.schema.json", - "title": "BankAccountDebitDetails", - "definitions": { - "BankAccountDebitDetails": { - "$id": "#BankAccountDebitDetails", - "description": "Detailed information for a bank account debit. Bear in mind that this could be extended to add any required authorization fields to allow recurring payments", - "type": "object", - "properties": { - "accountNumber": { - "type": "integer", - "description": "Bank Account Number (this could refer to the IBAN or SWIFT number)" - }, - "accountNumberType": { - "type": "string", - "description": "Type of account number (e.g.: IBAN, SWIFT, ...)" - }, - "BIC": { - "type": "string", - "description": "Business Identifier Code/Swift code of the financial institution where the account is located" - }, - "blank": { - "type": "string", - "description": "Display name of the bank" - }, - "owner": { - "type": "string", - "description": "Owner of the bank account" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankAccountDebitDetails.schema.json", + "title": "BankAccountDebitDetails", + "definitions": { + "BankAccountDebitDetails": { + "$id": "#BankAccountDebitDetails", + "description": "Detailed information for a bank account debit. Bear in mind that this could be extended to add any required authorization fields to allow recurring payments", + "type": "object", + "properties": { + "accountNumber": { + "type": "integer", + "description": "Bank Account Number (this could refer to the IBAN or SWIFT number)" + }, + "accountNumberType": { + "type": "string", + "description": "Type of account number (e.g.: IBAN, SWIFT, ...)" + }, + "BIC": { + "type": "string", + "description": "Business Identifier Code/Swift code of the financial institution where the account is located" + }, + "blank": { + "type": "string", + "description": "Display name of the bank" + }, + "owner": { + "type": "string", + "description": "Owner of the bank account" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/BankAccountDebitMethod.schema.json b/EngagedParty/BankAccountDebitMethod.schema.json index 6cc93f75..6cef1707 100644 --- a/EngagedParty/BankAccountDebitMethod.schema.json +++ b/EngagedParty/BankAccountDebitMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankAccountDebitMethod.schema.json", - "title": "BankAccountDebitMethod", - "definitions": { - "BankAccountDebitMethod": { - "$id": "#BankAccountDebitMethod", - "type": "object", - "properties": { - "details": { - "$ref": "BankAccountDebitDetails.schema.json#BankAccountDebitDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankAccountDebitMethod.schema.json", + "title": "BankAccountDebitMethod", + "definitions": { + "BankAccountDebitMethod": { + "$id": "#BankAccountDebitMethod", + "type": "object", + "properties": { + "details": { + "$ref": "BankAccountDebitDetails.schema.json#BankAccountDebitDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "AccountRef.schema.json#AccountRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/BankAccountTransferDetails.schema.json b/EngagedParty/BankAccountTransferDetails.schema.json index f52d938a..78772bdd 100644 --- a/EngagedParty/BankAccountTransferDetails.schema.json +++ b/EngagedParty/BankAccountTransferDetails.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankAccountTransferDetails.schema.json", - "title": "BankAccountTransferDetails", - "definitions": { - "BankAccountTransferDetails": { - "$id": "#BankAccountTransferDetails", - "description": "Detailed information for a bank account debit. Bear in mind that this could be extended to add any required authorization fields to allow recurring payments", - "type": "object", - "properties": { - "accountNumber": { - "type": "integer", - "description": "Bank Account Number (this could refer to the IBAN or SWIFT number)" - }, - "accountNumberType": { - "type": "string", - "description": "Type of account number (e.g.: IBAN, SWIFT, ...)" - }, - "BIC": { - "type": "string", - "description": "Business Identifier Code/Swift code of the financial institution where the account is located" - }, - "blank": { - "type": "string", - "description": "Display name of the bank" - }, - "owner": { - "type": "string", - "description": "Owner of the bank account" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankAccountTransferDetails.schema.json", + "title": "BankAccountTransferDetails", + "definitions": { + "BankAccountTransferDetails": { + "$id": "#BankAccountTransferDetails", + "description": "Detailed information for a bank account debit. Bear in mind that this could be extended to add any required authorization fields to allow recurring payments", + "type": "object", + "properties": { + "accountNumber": { + "type": "integer", + "description": "Bank Account Number (this could refer to the IBAN or SWIFT number)" + }, + "accountNumberType": { + "type": "string", + "description": "Type of account number (e.g.: IBAN, SWIFT, ...)" + }, + "BIC": { + "type": "string", + "description": "Business Identifier Code/Swift code of the financial institution where the account is located" + }, + "blank": { + "type": "string", + "description": "Display name of the bank" + }, + "owner": { + "type": "string", + "description": "Owner of the bank account" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/BankAccountTransferMethod.schema.json b/EngagedParty/BankAccountTransferMethod.schema.json index b5c828f7..f9a698e7 100644 --- a/EngagedParty/BankAccountTransferMethod.schema.json +++ b/EngagedParty/BankAccountTransferMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankAccountTransferMethod.schema.json", - "title": "BankAccountTransferMethod", - "definitions": { - "BankAccountTransferMethod": { - "$id": "#BankAccountTransferMethod", - "type": "object", - "properties": { - "details": { - "$ref": "BankAccountTransferDetails.schema.json#BankAccountTransferDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankAccountTransferMethod.schema.json", + "title": "BankAccountTransferMethod", + "definitions": { + "BankAccountTransferMethod": { + "$id": "#BankAccountTransferMethod", + "type": "object", + "properties": { + "details": { + "$ref": "BankAccountTransferDetails.schema.json#BankAccountTransferDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "AccountRef.schema.json#AccountRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/Contact.schema.json b/EngagedParty/Contact.schema.json index 16a85d14..d03e8840 100644 --- a/EngagedParty/Contact.schema.json +++ b/EngagedParty/Contact.schema.json @@ -1,47 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Contact.schema.json", - "title": "Contact", - "definitions": { - "Contact": { - "$id": "#Contact", - "description": "An individual or an organization used as a contact point for a given account and accessed via some contact medium.", - "type": "object", - "required": [ - "contactType" - ], - "properties": { - "contactName": { - "type": "string", - "description": "A displayable name for that contact" - }, - "contactType": { - "type": "string", - "description": "Type of contact (primary, secondary...)" - }, - "partyRoleType": { - "type": "string", - "description": "Identifies what kind of party role type is linked to the contact (a account manager...)" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Validity period of that contact" - }, - "contactMedium": { - "type": "array", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - }, - "relatedParty": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Contact.schema.json", + "title": "Contact", + "definitions": { + "Contact": { + "$id": "#Contact", + "description": "An individual or an organization used as a contact point for a given account and accessed via some contact medium.", + "type": "object", + "required": [ + "contactType" + ], + "properties": { + "contactName": { + "type": "string", + "description": "A displayable name for that contact" + }, + "contactType": { + "type": "string", + "description": "Type of contact (primary, secondary...)" + }, + "partyRoleType": { + "type": "string", + "description": "Identifies what kind of party role type is linked to the contact (a account manager...)" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Validity period of that contact" + }, + "contactMedium": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "relatedParty": { + "$ref": "RelatedParty.schema.json#RelatedParty" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/FinancialAccount.schema.json b/EngagedParty/FinancialAccount.schema.json index 18ff83ad..8bb7954e 100644 --- a/EngagedParty/FinancialAccount.schema.json +++ b/EngagedParty/FinancialAccount.schema.json @@ -1,22 +1,21 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "FinancialAccount.schema.json", - "title": "FinancialAccount", - "definitions": { - "FinancialAccount": { - "$id": "#FinancialAccount", - "description": "An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. A financial (account receivable account/account payable) aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party. It is a specialization of entity Account.", - "type": "object", - "required": [ - "name" - ], - "properties": { - }, - "allOf": [ - { - "$ref": "../Common/Account.schema.json#Account" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "FinancialAccount.schema.json", + "title": "FinancialAccount", + "definitions": { + "FinancialAccount": { + "$id": "#FinancialAccount", + "description": "An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. A financial (account receivable account/account payable) aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party. It is a specialization of entity Account.", + "type": "object", + "required": [ + "name" + ], + "properties": {}, + "allOf": [ + { + "$ref": "Account.schema.json#Account" } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/FinancialAccountRef.schema.json b/EngagedParty/FinancialAccountRef.schema.json index 7d5b49b8..2fc552d2 100644 --- a/EngagedParty/FinancialAccountRef.schema.json +++ b/EngagedParty/FinancialAccountRef.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "FinancialAccountRef.schema.json", - "title": "FinancialAccountRef", - "definitions": { - "FinancialAccountRef": { - "$id": "#FinancialAccountRef", - "description": "AccountReceivable reference. An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. An account receivable aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Unique reference of the account" - }, - "id": { - "type": "string", - "description": "Unique identifier of the account" - }, - "name": { - "type": "string", - "description": "Name of the account" - }, - "accountBalance": { - "$ref": "AccountBalance.schema.json#AccountBalance" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "FinancialAccountRef.schema.json", + "title": "FinancialAccountRef", + "definitions": { + "FinancialAccountRef": { + "$id": "#FinancialAccountRef", + "description": "AccountReceivable reference. An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. An account receivable aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Unique reference of the account" + }, + "id": { + "type": "string", + "description": "Unique identifier of the account" + }, + "name": { + "type": "string", + "description": "Name of the account" + }, + "accountBalance": { + "$ref": "AccountBalance.schema.json#AccountBalance" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/Individual.schema.json b/EngagedParty/Individual.schema.json index 54905f1b..5ce5026c 100644 --- a/EngagedParty/Individual.schema.json +++ b/EngagedParty/Individual.schema.json @@ -1,136 +1,137 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Individual.schema.json", - "title": "Individual", - "definitions": { - "Individual": { - "type": "object", - "description": "Individual represents a single human being (a man, woman or child). The individual can be a customer, an employee or any other person that the organization needs to store information about.", - "properties": { - "gender": { - "type": "string", - "description": "Gender" - }, - "placeOfBirth": { - "type": "string", - "description": "Reference to the place where the individual was born" - }, - "countryOfBirth": { - "type": "string", - "description": "Country where the individual was born" - }, - "nationality": { - "type": "string", - "description": "Nationality" - }, - "maritalStatus": { - "type": "string", - "description": "Marital status (married, divorced, widow ...)" - }, - "birthDate": { - "type": "string", - "format": "date-time", - "description": "Birth date" - }, - "deathDate": { - "type": "string", - "format": "date-time", - "description": "Date of death" - }, - "title": { - "type": "string", - "description": "Useful for titles (aristocratic, social,...) Pr, Dr, Sir, ..." - }, - "aristocraticTitle": { - "type": "string", - "description": "e.g. Baron, Graf, Earl,\u2026" - }, - "generation": { - "type": "string", - "description": "e.g.. Sr, Jr, III (the third),\u2026" - }, - "givenName": { - "type": "string", - "description": "First name of the individual" - }, - "preferredGivenName": { - "type": "string", - "description": "Contains the chosen name by which the individual prefers to be addressed. Note: This name may be a name other than a given name, such as a nickname" - }, - "familyNamePrefix": { - "type": "string", - "description": "Family name prefix" - }, - "familyName": { - "type": "string", - "description": "Contains the non-chosen or inherited name. Also known as last name in the Western context" - }, - "legalName": { - "type": "string", - "description": "Legal name or birth name (name one has for official purposes)" - }, - "middleName": { - "type": "string", - "description": "Middles name or initial" - }, - "fullName": { - "type": "string", - "description": "Full name flatten (first, middle, and last names)" - }, - "formattedName": { - "type": "string", - "description": "A fully formatted name in one string with all of its pieces in their proper place and all of the necessary punctuation. Useful for specific contexts (Chinese, Japanese, Korean,\u2026)" - }, - "location": { - "type": "string", - "description": "Temporary current location od the individual (may be used if the individual has approved its sharing)" - }, - "status": { - "description": "Status of the individual", - "$ref": "IndividualStateType.schema.json#/definitions/IndividualStateType" - }, - "otherName": { - "type": "array", - "items": { - "$ref": "OtherNameIndividual.schema.json#/definitions/OtherNameIndividual" - } - }, - "individualIdentification": { - "type": "array", - "items": { - "$ref": "IndividualIdentification.schema.json#/definitions/IndividualIdentification" - } - }, - "disability": { - "type": "array", - "items": { - "$ref": "Disability.schema.json#/definitions/Disability" - } - }, - "languageAbility": { - "type": "array", - "items": { - "$ref": "LanguageAbility.schema.json#/definitions/LanguageAbility" - } - }, - "skill": { - "type": "array", - "items": { - "$ref": "Skill.schema.json#/definitions/Skill" - } - } - }, - "required": [ - "id" - ], - "allOf": [ - { - "$ref": "Party.schema.json#Party" - }, - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Individual.schema.json", + "title": "Individual", + "definitions": { + "Individual": { + "$id": "#Individual", + "type": "object", + "description": "Individual represents a single human being (a man, woman or child). The individual can be a customer, an employee or any other person that the organization needs to store information about.", + "properties": { + "gender": { + "type": "string", + "description": "Gender" + }, + "placeOfBirth": { + "type": "string", + "description": "Reference to the place where the individual was born" + }, + "countryOfBirth": { + "type": "string", + "description": "Country where the individual was born" + }, + "nationality": { + "type": "string", + "description": "Nationality" + }, + "maritalStatus": { + "type": "string", + "description": "Marital status (married, divorced, widow ...)" + }, + "birthDate": { + "type": "string", + "format": "date-time", + "description": "Birth date" + }, + "deathDate": { + "type": "string", + "format": "date-time", + "description": "Date of death" + }, + "title": { + "type": "string", + "description": "Useful for titles (aristocratic, social,...) Pr, Dr, Sir, ..." + }, + "aristocraticTitle": { + "type": "string", + "description": "e.g. Baron, Graf, Earl,…" + }, + "generation": { + "type": "string", + "description": "e.g.. Sr, Jr, III (the third),…" + }, + "givenName": { + "type": "string", + "description": "First name of the individual" + }, + "preferredGivenName": { + "type": "string", + "description": "Contains the chosen name by which the individual prefers to be addressed. Note: This name may be a name other than a given name, such as a nickname" + }, + "familyNamePrefix": { + "type": "string", + "description": "Family name prefix" + }, + "familyName": { + "type": "string", + "description": "Contains the non-chosen or inherited name. Also known as last name in the Western context" + }, + "legalName": { + "type": "string", + "description": "Legal name or birth name (name one has for official purposes)" + }, + "middleName": { + "type": "string", + "description": "Middles name or initial" + }, + "fullName": { + "type": "string", + "description": "Full name flatten (first, middle, and last names)" + }, + "formattedName": { + "type": "string", + "description": "A fully formatted name in one string with all of its pieces in their proper place and all of the necessary punctuation. Useful for specific contexts (Chinese, Japanese, Korean,…)" + }, + "location": { + "type": "string", + "description": "Temporary current location od the individual (may be used if the individual has approved its sharing)" + }, + "status": { + "description": "Status of the individual", + "$ref": "IndividualStateType.schema.json#IndividualStateType" + }, + "otherName": { + "type": "array", + "items": { + "$ref": "OtherNameIndividual.schema.json#OtherNameIndividual" + } + }, + "individualIdentification": { + "type": "array", + "items": { + "$ref": "IndividualIdentification.schema.json#IndividualIdentification" + } + }, + "disability": { + "type": "array", + "items": { + "$ref": "../Customer/Disability.schema.json#Disability" + } + }, + "languageAbility": { + "type": "array", + "items": { + "$ref": "LanguageAbility.schema.json#LanguageAbility" + } + }, + "skill": { + "type": "array", + "items": { + "$ref": "Skill.schema.json#Skill" + } } + }, + "required": [ + "id" + ], + "allOf": [ + { + "$ref": "Party.schema.json#Party" + }, + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/EngagedParty/IndividualIdentification.schema.json b/EngagedParty/IndividualIdentification.schema.json index 3e35e528..1ce115d2 100644 --- a/EngagedParty/IndividualIdentification.schema.json +++ b/EngagedParty/IndividualIdentification.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "IndividualIdentification.schema.json", - "title": "IndividualIdentification", - "definitions": { - "IndividualIdentification": { - "$id": "#IndividualIdentification", - "description": "Represents our registration of information used as proof of identity by an individual (passport, national identity card, drivers license, social security number, birth certificate)", - "type": "object", - "properties": { - "identificationId": { - "type": "string", - "description": "Identifier" - }, - "issuingAuthority": { - "type": "string", - "description": "Authority which has issued the identifier, such as: social security, town hall" - }, - "issuingDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the identifier was issued" - }, - "identificationType": { - "type": "string", - "description": "Identification type (passport, national identity card, drivers license, social security number, birth certificate)" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the identification information is valid." - }, - "attachment": { - "$ref": "AttachmentRefOrValue.schema.json#/definitions/AttachmentRefOrValue" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "IndividualIdentification.schema.json", + "title": "IndividualIdentification", + "definitions": { + "IndividualIdentification": { + "$id": "#IndividualIdentification", + "description": "Represents our registration of information used as proof of identity by an individual (passport, national identity card, drivers license, social security number, birth certificate)", + "type": "object", + "properties": { + "identificationId": { + "type": "string", + "description": "Identifier" + }, + "issuingAuthority": { + "type": "string", + "description": "Authority which has issued the identifier, such as: social security, town hall" + }, + "issuingDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the identifier was issued" + }, + "identificationType": { + "type": "string", + "description": "Identification type (passport, national identity card, drivers license, social security number, birth certificate)" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the identification information is valid." + }, + "attachment": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/IndividualStateType.schema.json b/EngagedParty/IndividualStateType.schema.json index ac8b47bb..7c77ff83 100644 --- a/EngagedParty/IndividualStateType.schema.json +++ b/EngagedParty/IndividualStateType.schema.json @@ -1,17 +1,17 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "IndividualStateType.schema.json", - "title": "IndividualStateType", - "definitions": { - "IndividualStateType": { - "$id": "#IndividualStateType", - "type": "string", - "description": "Valid values for the lifecycle state of the individual", - "enum": [ - "initialized", - "validated", - "deceaded" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "IndividualStateType.schema.json", + "title": "IndividualStateType", + "definitions": { + "IndividualStateType": { + "$id": "#IndividualStateType", + "type": "string", + "description": "Valid values for the lifecycle state of the individual", + "enum": [ + "initialized", + "validated", + "deceaded" + ] } + } } \ No newline at end of file diff --git a/EngagedParty/IssuerRef.schema.json b/EngagedParty/IssuerRef.schema.json index ccfd84f8..87b7e2e1 100644 --- a/EngagedParty/IssuerRef.schema.json +++ b/EngagedParty/IssuerRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "IssuerRef.schema.json", - "title": "IssuerRef", - "definitions": { - "IssuerRef": { - "$id": "#IssuerRef", - "description": "Issuer reference. The issuer is the party role who will issue the settlement note.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the issuer" - }, - "id": { - "type": "string", - "description": "Identifier of the issuer" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "IssuerRef.schema.json", + "title": "IssuerRef", + "definitions": { + "IssuerRef": { + "$id": "#IssuerRef", + "description": "Issuer reference. The issuer is the party role who will issue the settlement note.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the issuer" + }, + "id": { + "type": "string", + "description": "Identifier of the issuer" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/LanguageAbility.schema.json b/EngagedParty/LanguageAbility.schema.json index 75625597..39fcfe20 100644 --- a/EngagedParty/LanguageAbility.schema.json +++ b/EngagedParty/LanguageAbility.schema.json @@ -1,49 +1,50 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LanguageAbility.schema.json", - "title": "LanguageAbility", - "definitions": { - "LanguageAbility": { - "type": "object", - "description": "Ability of an individual to understand or converse in a language.", - "properties": { - "languageCode": { - "type": "string", - "description": "Language code (RFC 5646)" - }, - "languageName": { - "type": "string", - "description": "Language name" - }, - "isFavouriteLanguage": { - "type": "boolean", - "description": "A \u201ctrue\u201d value specifies whether the language is considered by the individual as his favourite one" - }, - "writingProficiency": { - "type": "string", - "description": "Writing proficiency evaluated for this language" - }, - "readingProficiency": { - "type": "string", - "description": "Reading proficiency evaluated for this language" - }, - "speakingProficiency": { - "type": "string", - "description": "Speaking proficiency evaluated for this language" - }, - "listeningProficiency": { - "type": "string", - "description": "Listening proficiency evaluated for this language" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#/definitions/TimePeriod" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LanguageAbility.schema.json", + "title": "LanguageAbility", + "definitions": { + "LanguageAbility": { + "$id": "#LanguageAbility", + "type": "object", + "description": "Ability of an individual to understand or converse in a language.", + "properties": { + "languageCode": { + "type": "string", + "description": "Language code (RFC 5646)" + }, + "languageName": { + "type": "string", + "description": "Language name" + }, + "isFavouriteLanguage": { + "type": "boolean", + "description": "A “true” value specifies whether the language is considered by the individual as his favourite one" + }, + "writingProficiency": { + "type": "string", + "description": "Writing proficiency evaluated for this language" + }, + "readingProficiency": { + "type": "string", + "description": "Reading proficiency evaluated for this language" + }, + "speakingProficiency": { + "type": "string", + "description": "Speaking proficiency evaluated for this language" + }, + "listeningProficiency": { + "type": "string", + "description": "Listening proficiency evaluated for this language" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/EngagedParty/Organization.schema.json b/EngagedParty/Organization.schema.json index 0a8baafa..d633a326 100644 --- a/EngagedParty/Organization.schema.json +++ b/EngagedParty/Organization.schema.json @@ -1,76 +1,77 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Organization.schema.json", - "title": "Organization", - "definitions": { - "Organization": { - "type": "object", - "description": "Organization represents a group of people identified by shared interests or purpose. Examples include business, department and enterprise. Because of the complex nature of many businesses, both organizations and organization units are represented by the same data.", - "properties": { - "isLegalEntity": { - "type": "boolean", - "description": "If value is true, the organization is a legal entity known by a national referential." - }, - "isHeadOffice": { - "type": "boolean", - "description": "If value is true, the organization is the head office" - }, - "organizationType": { - "type": "string", - "description": "Type of Organization (company, department...)" - }, - "tradingName": { - "type": "string", - "description": "Name that the organization (unit) trades under" - }, - "existsDuring": { - "$ref": "TimePeriod.schema.json#/definitions/TimePeriod" - }, - "name": { - "type": "string", - "description": "Organization name (department name for example)" - }, - "nameType": { - "type": "string", - "description": "Type of the name : Co, Inc, Ltd,\u2026" - }, - "status": { - "description": "Status of the organization", - "$ref": "OrganizationStateType.schema.json#/definitions/OrganizationStateType" - }, - "otherName": { - "type": "array", - "items": { - "$ref": "OtherNameOrganization.schema.json#/definitions/OtherNameOrganization" - } - }, - "organizationIdentification": { - "type": "array", - "items": { - "$ref": "OrganizationIdentification.schema.json#/definitions/OrganizationIdentification" - } - }, - "organizationChildRelationship": { - "type": "array", - "items": { - "$ref": "OrganizationChildRelationship.schema.json#/definitions/OrganizationChildRelationship" - } - }, - "organizationParentRelationship": { - "$ref": "OrganizationParentRelationship.schema.json#/definitions/OrganizationParentRelationship" - } - }, - "allOf": [ - { - "$ref": "Party.schema.json#Party" - }, - { - "$ref": "Entity.schema.json#Entity" - } - ], - "required": [ - "id" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Organization.schema.json", + "title": "Organization", + "definitions": { + "Organization": { + "$id": "#Organization", + "type": "object", + "description": "Organization represents a group of people identified by shared interests or purpose. Examples include business, department and enterprise. Because of the complex nature of many businesses, both organizations and organization units are represented by the same data.", + "properties": { + "isLegalEntity": { + "type": "boolean", + "description": "If value is true, the organization is a legal entity known by a national referential." + }, + "isHeadOffice": { + "type": "boolean", + "description": "If value is true, the organization is the head office" + }, + "organizationType": { + "type": "string", + "description": "Type of Organization (company, department...)" + }, + "tradingName": { + "type": "string", + "description": "Name that the organization (unit) trades under" + }, + "existsDuring": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + }, + "name": { + "type": "string", + "description": "Organization name (department name for example)" + }, + "nameType": { + "type": "string", + "description": "Type of the name : Co, Inc, Ltd,…" + }, + "status": { + "description": "Status of the organization", + "$ref": "OrganizationStateType.schema.json#OrganizationStateType" + }, + "otherName": { + "type": "array", + "items": { + "$ref": "OtherNameOrganization.schema.json#OtherNameOrganization" + } + }, + "organizationIdentification": { + "type": "array", + "items": { + "$ref": "OrganizationIdentification.schema.json#OrganizationIdentification" + } + }, + "organizationChildRelationship": { + "type": "array", + "items": { + "$ref": "OrganizationChildRelationship.schema.json#OrganizationChildRelationship" + } + }, + "organizationParentRelationship": { + "$ref": "OrganizationParentRelationship.schema.json#OrganizationParentRelationship" } + }, + "allOf": [ + { + "$ref": "Party.schema.json#Party" + }, + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ], + "required": [ + "id" + ] } + } } \ No newline at end of file diff --git a/EngagedParty/OrganizationChildRelationship.schema.json b/EngagedParty/OrganizationChildRelationship.schema.json index 1fa57688..a1c80af7 100644 --- a/EngagedParty/OrganizationChildRelationship.schema.json +++ b/EngagedParty/OrganizationChildRelationship.schema.json @@ -1,25 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrganizationChildRelationship.schema.json", - "title": "OrganizationChildRelationship", - "definitions": { - "OrganizationChildRelationship": { - "type": "object", - "description": "Child references of an organization in a structure of organizations.", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of the relationship. Could be juridical, hierarchical, geographical, functional for example." - }, - "organization": { - "$ref": "OrganizationRef.schema.json#OrganizationRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrganizationChildRelationship.schema.json", + "title": "OrganizationChildRelationship", + "definitions": { + "OrganizationChildRelationship": { + "$id": "#OrganizationChildRelationship", + "type": "object", + "description": "Child references of an organization in a structure of organizations.", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of the relationship. Could be juridical, hierarchical, geographical, functional for example." + }, + "organization": { + "$ref": "OrganizationRef.schema.json#OrganizationRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/EngagedParty/OrganizationIdentification.schema.json b/EngagedParty/OrganizationIdentification.schema.json index b9bfabdb..a71a064d 100644 --- a/EngagedParty/OrganizationIdentification.schema.json +++ b/EngagedParty/OrganizationIdentification.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrganizationIdentification.schema.json", - "title": "OrganizationIdentification", - "definitions": { - "OrganizationIdentification": { - "$id": "#OrganizationIdentification", - "description": "Represents our registration of information used as proof of identity by an organization", - "type": "object", - "properties": { - "identificationId": { - "type": "string", - "description": "Identifier" - }, - "issuingAuthority": { - "type": "string", - "description": "Authority which has issued the identifier (chamber of commerce...)" - }, - "issuingDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the identifier was issued" - }, - "identificationType": { - "type": "string", - "description": "Type of identification information used to identify the company in a country or internationally" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the identification information is valid." - }, - "attachment": { - "$ref": "AttachmentRefOrValue.schema.json#/definitions/AttachmentRefOrValue" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrganizationIdentification.schema.json", + "title": "OrganizationIdentification", + "definitions": { + "OrganizationIdentification": { + "$id": "#OrganizationIdentification", + "description": "Represents our registration of information used as proof of identity by an organization", + "type": "object", + "properties": { + "identificationId": { + "type": "string", + "description": "Identifier" + }, + "issuingAuthority": { + "type": "string", + "description": "Authority which has issued the identifier (chamber of commerce...)" + }, + "issuingDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the identifier was issued" + }, + "identificationType": { + "type": "string", + "description": "Type of identification information used to identify the company in a country or internationally" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the identification information is valid." + }, + "attachment": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/OrganizationParentRelationship.schema.json b/EngagedParty/OrganizationParentRelationship.schema.json index 749b2eaa..babb4b1f 100644 --- a/EngagedParty/OrganizationParentRelationship.schema.json +++ b/EngagedParty/OrganizationParentRelationship.schema.json @@ -1,25 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrganizationParentRelationship.schema.json", - "title": "OrganizationParentRelationship", - "definitions": { - "OrganizationParentRelationship": { - "type": "object", - "description": "Parent references of an organization in a structure of organizations.", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of the relationship. Could be juridical, hierarchical, geographical, functional for example." - }, - "organization": { - "$ref": "OrganizationRef.schema.json#/definitions/OrganizationRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrganizationParentRelationship.schema.json", + "title": "OrganizationParentRelationship", + "definitions": { + "OrganizationParentRelationship": { + "$id": "#OrganizationParentRelationship", + "type": "object", + "description": "Parent references of an organization in a structure of organizations.", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of the relationship. Could be juridical, hierarchical, geographical, functional for example." + }, + "organization": { + "$ref": "OrganizationRef.schema.json#OrganizationRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/EngagedParty/OrganizationRef.schema.json b/EngagedParty/OrganizationRef.schema.json index 2ac7c297..656d342a 100644 --- a/EngagedParty/OrganizationRef.schema.json +++ b/EngagedParty/OrganizationRef.schema.json @@ -1,18 +1,17 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrganizationRef.schema.json", - "title": "OrganizationRef", - "definitions": { - "OrganizationRef": { - "$id": "#OrganizationRef", - "type": "object", - "properties": { - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrganizationRef.schema.json", + "title": "OrganizationRef", + "definitions": { + "OrganizationRef": { + "$id": "#OrganizationRef", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } + } } \ No newline at end of file diff --git a/EngagedParty/OrganizationStateType.schema.json b/EngagedParty/OrganizationStateType.schema.json index 9ff96b95..8178009b 100644 --- a/EngagedParty/OrganizationStateType.schema.json +++ b/EngagedParty/OrganizationStateType.schema.json @@ -1,17 +1,17 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrganizationStateType.schema.json", - "title": "OrganizationStateType", - "definitions": { - "OrganizationStateType": { - "$id": "#OrganizationStateType", - "type": "string", - "description": "Valid values for the lifecycle state of the organization", - "enum": [ - "initialized", - "validated", - "closed" - ] - } - } +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrganizationStateType.schema.json", + "title": "OrganizationStateType", + "definitions": { + "OrganizationStateType": { + "$id": "#OrganizationStateType", + "type": "string", + "description": "Valid values for the lifecycle state of the organization", + "enum": [ + "initialized", + "validated", + "closed" + ] + } + } } \ No newline at end of file diff --git a/EngagedParty/OtherName.schema.json b/EngagedParty/OtherName.schema.json index 15b5bbb2..abbbb33a 100644 --- a/EngagedParty/OtherName.schema.json +++ b/EngagedParty/OtherName.schema.json @@ -1,55 +1,55 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OtherName.schema.json", - "title": "OtherName", - "definitions": { - "OtherName": { - "$id": "#OtherName", - "description": "To keep track of other names (for example the old name of a woman before marriage or an artist name)", - "type": "object", - "properties": { - "familyName": { - "type": "string", - "description": "Last name" - }, - "formattedName": { - "type": "string", - "description": "A formatted name useful for specific contexts (chinese, japanese, korean...)" - }, - "fullName": { - "type": "string", - "description": "Full name flatten (first, middle, and last name)" - }, - "givenName": { - "type": "string", - "description": "First name" - }, - "middleName": { - "type": "string", - "description": "Middle name" - }, - "nameType": { - "type": "string", - "description": "Co., Inc., Ltd., Plc., Gmbh." - }, - "title": { - "type": "string", - "description": "useful for titles (aristocratic, social...) Dr, Pr, Sir..." - }, - "tradingName": { - "type": "string", - "description": "The name that the organization trades under" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the other name is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OtherName.schema.json", + "title": "OtherName", + "definitions": { + "OtherName": { + "$id": "#OtherName", + "description": "To keep track of other names (for example the old name of a woman before marriage or an artist name)", + "type": "object", + "properties": { + "familyName": { + "type": "string", + "description": "Last name" + }, + "formattedName": { + "type": "string", + "description": "A formatted name useful for specific contexts (chinese, japanese, korean...)" + }, + "fullName": { + "type": "string", + "description": "Full name flatten (first, middle, and last name)" + }, + "givenName": { + "type": "string", + "description": "First name" + }, + "middleName": { + "type": "string", + "description": "Middle name" + }, + "nameType": { + "type": "string", + "description": "Co., Inc., Ltd., Plc., Gmbh." + }, + "title": { + "type": "string", + "description": "useful for titles (aristocratic, social...) Dr, Pr, Sir..." + }, + "tradingName": { + "type": "string", + "description": "The name that the organization trades under" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the other name is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/OtherNameIndividual.schema.json b/EngagedParty/OtherNameIndividual.schema.json index 778c445a..408fdb9e 100644 --- a/EngagedParty/OtherNameIndividual.schema.json +++ b/EngagedParty/OtherNameIndividual.schema.json @@ -1,66 +1,66 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OtherNameIndividual.schema.json", - "title": "OtherNameIndividual", - "definitions": { - "OtherNameIndividual": { - "type": "object", - "description": "Keeps track of other names, for example the old name of a woman before marriage or an artist name.", - "properties": { - "title": { - "type": "string", - "description": "Use for titles (aristrocatic, social, ...): Pr, Dr, Sir,...." - }, - "aristocraticTitle": { - "type": "string", - "description": "e.g. Baron, Graf, Earl,\u2026" - }, - "generation": { - "type": "string", - "description": "e.g. Sr, Jr\u2026" - }, - "givenName": { - "type": "string", - "description": "First name" - }, - "preferredGivenName": { - "type": "string", - "description": "Contains the chosen name by which the person prefers to be addressed. Note: This name may be a name other than a given name, such as a nickname" - }, - "familyNamePrefix": { - "type": "string", - "description": "Family name prefix" - }, - "familyName": { - "type": "string", - "description": "Contains the non-chosen or inherited name. Also known as last name in the Western context" - }, - "legalName": { - "type": "string", - "description": "Legal name or birth name (name one has for official purposes)" - }, - - "middleName": { - "type": "string", - "description": "Middle name or initial" - }, - "fullName": { - "type": "string", - "description": "Full name flatten (first, middle, and last names)" - }, - "formattedName": { - "type": "string", - "description": ". A fully formatted name in one string with all of its pieces in their proper place and all of the necessary punctuation. Useful for specific contexts (Chinese, Japanese, Korean,\u2026)" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#/definitions/TimePeriod" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OtherNameIndividual.schema.json", + "title": "OtherNameIndividual", + "definitions": { + "OtherNameIndividual": { + "$id": "#OtherNameIndividual", + "type": "object", + "description": "Keeps track of other names, for example the old name of a woman before marriage or an artist name.", + "properties": { + "title": { + "type": "string", + "description": "Use for titles (aristrocatic, social, ...): Pr, Dr, Sir,...." + }, + "aristocraticTitle": { + "type": "string", + "description": "e.g. Baron, Graf, Earl,…" + }, + "generation": { + "type": "string", + "description": "e.g. Sr, Jr…" + }, + "givenName": { + "type": "string", + "description": "First name" + }, + "preferredGivenName": { + "type": "string", + "description": "Contains the chosen name by which the person prefers to be addressed. Note: This name may be a name other than a given name, such as a nickname" + }, + "familyNamePrefix": { + "type": "string", + "description": "Family name prefix" + }, + "familyName": { + "type": "string", + "description": "Contains the non-chosen or inherited name. Also known as last name in the Western context" + }, + "legalName": { + "type": "string", + "description": "Legal name or birth name (name one has for official purposes)" + }, + "middleName": { + "type": "string", + "description": "Middle name or initial" + }, + "fullName": { + "type": "string", + "description": "Full name flatten (first, middle, and last names)" + }, + "formattedName": { + "type": "string", + "description": ". A fully formatted name in one string with all of its pieces in their proper place and all of the necessary punctuation. Useful for specific contexts (Chinese, Japanese, Korean,…)" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/OtherNameOrganization.schema.json b/EngagedParty/OtherNameOrganization.schema.json index 27477ea5..eea9579f 100644 --- a/EngagedParty/OtherNameOrganization.schema.json +++ b/EngagedParty/OtherNameOrganization.schema.json @@ -1,33 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OtherNameOrganization.schema.json", - "title": "OtherNameOrganization", - "definitions": { - "OtherNameOrganization": { - "type": "object", - "description": "Keeps track of other names, for example the old name of an organization.", - "properties": { - "tradingName": { - "type": "string", - "description": "The name that the organization trades under" - }, - "nameType": { - "type": "string", - "description": "Co. , Inc. , Ltd. , Pty Ltd. , Plc; , Gmbh" - }, - "name": { - "type": "string", - "description": "Organization name (department name for example)" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#/definitions/TimePeriod" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OtherNameOrganization.schema.json", + "title": "OtherNameOrganization", + "definitions": { + "OtherNameOrganization": { + "$id": "#OtherNameOrganization", + "type": "object", + "description": "Keeps track of other names, for example the old name of an organization.", + "properties": { + "tradingName": { + "type": "string", + "description": "The name that the organization trades under" + }, + "nameType": { + "type": "string", + "description": "Co. , Inc. , Ltd. , Pty Ltd. , Plc; , Gmbh" + }, + "name": { + "type": "string", + "description": "Organization name (department name for example)" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/PartnershipType.schema.json b/EngagedParty/PartnershipType.schema.json index 2af2b64c..07bf6bfc 100644 --- a/EngagedParty/PartnershipType.schema.json +++ b/EngagedParty/PartnershipType.schema.json @@ -1,44 +1,44 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartnershipType.schema.json", - "title": "PartnershipType", - "definitions": { - "PartnershipType": { - "$id": "#PartnershipType", - "description": "A partnership type contains all the information for the setup of a partnership of a given kind. This includes the list of identified role types for the partnership with the corresponding agreement specifications.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "description": { - "type": "string", - "description": "An explanatory text regarding this partnership type" - }, - "href": { - "type": "string", - "description": "The reference url for this partnership type" - }, - "id": { - "type": "string", - "description": "The identifier of the partnership type" - }, - "name": { - "type": "string", - "description": "An identifying name for the partnership type." - }, - "roleType": { - "type": "array", - "items": { - "$ref": "RoleType.schema.json#RoleType" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartnershipType.schema.json", + "title": "PartnershipType", + "definitions": { + "PartnershipType": { + "$id": "#PartnershipType", + "description": "A partnership type contains all the information for the setup of a partnership of a given kind. This includes the list of identified role types for the partnership with the corresponding agreement specifications.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "description": { + "type": "string", + "description": "An explanatory text regarding this partnership type" + }, + "href": { + "type": "string", + "description": "The reference url for this partnership type" + }, + "id": { + "type": "string", + "description": "The identifier of the partnership type" + }, + "name": { + "type": "string", + "description": "An identifying name for the partnership type." + }, + "roleType": { + "type": "array", + "items": { + "$ref": "RoleType.schema.json#RoleType" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/PartnershipTypeRef.schema.json b/EngagedParty/PartnershipTypeRef.schema.json index f0ce95ee..3b01ddb6 100644 --- a/EngagedParty/PartnershipTypeRef.schema.json +++ b/EngagedParty/PartnershipTypeRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartnershipTypeRef.schema.json", - "title": "PartnershipTypeRef", - "definitions": { - "PartnershipTypeRef": { - "$id": "#PartnershipTypeRef", - "description": "PartnershipType reference. A partnership type contains all the information for the setup of a partnership of a given kind. This includes the list of identified role types for the partnership with the corresponding agreement specifications.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference url for the partnership type" - }, - "id": { - "type": "string", - "description": "Identifier of the partnership" - }, - "name": { - "type": "string", - "description": "Name of the partnership type" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartnershipTypeRef.schema.json", + "title": "PartnershipTypeRef", + "definitions": { + "PartnershipTypeRef": { + "$id": "#PartnershipTypeRef", + "description": "PartnershipType reference. A partnership type contains all the information for the setup of a partnership of a given kind. This includes the list of identified role types for the partnership with the corresponding agreement specifications.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference url for the partnership type" + }, + "id": { + "type": "string", + "description": "Identifier of the partnership" + }, + "name": { + "type": "string", + "description": "Name of the partnership type" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/Party.schema.json b/EngagedParty/Party.schema.json index c39ec93e..44d570bd 100644 --- a/EngagedParty/Party.schema.json +++ b/EngagedParty/Party.schema.json @@ -1,62 +1,63 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Party.schema.json", - "title": "Party", - "definitions": { - "Party": { - "type": "object", - "description": "Generic Party structure used to define commonalities between sub concepts of Individual and Organization.", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the organization" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the organization" - }, - "externalReference": { - "type": "array", - "items": { - "$ref": "ExternalReference.schema.json#/definitions/ExternalReference" - } - }, - "partyCharacteristic": { - "type": "array", - "items": { - "$ref": "Characteristic.schema.json#/definitions/Characteristic" - } - }, - "taxExemptionCertificate": { - "type": "array", - "items": { - "$ref": "TaxExemptionCertificate.schema.json#/definitions/TaxExemptionCertificate" - } - }, - "creditRating": { - "type": "array", - "items": { - "$ref": "PartyCreditProfile.schema.json#/definitions/PartyCreditProfile" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#/definitions/RelatedParty" - } - }, - "contactMedium": { - "type": "array", - "items": { - "$ref": "ContactMedium.schema.json#/definitions/ContactMedium" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Party.schema.json", + "title": "Party", + "definitions": { + "Party": { + "$id": "#Party", + "type": "object", + "description": "Generic Party structure used to define commonalities between sub concepts of Individual and Organization.", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the organization" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the organization" + }, + "externalReference": { + "type": "array", + "items": { + "$ref": "../Common/ExternalReference.schema.json#ExternalReference" + } + }, + "partyCharacteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "taxExemptionCertificate": { + "type": "array", + "items": { + "$ref": "TaxExemptionCertificate.schema.json#TaxExemptionCertificate" + } + }, + "creditRating": { + "type": "array", + "items": { + "$ref": "PartyCreditProfile.schema.json#PartyCreditProfile" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "RelatedParty.schema.json#RelatedParty" + } + }, + "contactMedium": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/EngagedParty/PartyAccount.schema.json b/EngagedParty/PartyAccount.schema.json index d076db3b..bd3d25f2 100644 --- a/EngagedParty/PartyAccount.schema.json +++ b/EngagedParty/PartyAccount.schema.json @@ -1,42 +1,42 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyAccount.schema.json", - "title": "PartyAccount", - "definitions": { - "PartyAccount": { - "$id": "#PartyAccount", - "description": "Account used for billing or for settlement purposes concerning a given party (an organization or an individual). It is a specialization of entity Account.", - "type": "object", - "required": [ - "name", - "relatedParty" - ], - "properties": { - "paymentStatus": { - "type": "string", - "description": "The condition of the account, such as due, paid, in arrears." - }, - "billStructure": { - "$ref": "../Customer/BillStructure.schema.json#BillStructure" - }, - "paymentPlan": { - "type": "array", - "items": { - "$ref": "../Customer/PaymentPlan.schema.json#PaymentPlan" - } - }, - "financialAccount": { - "$ref": "FinancialAccountRef.schema.json#FinancialAccountRef" - }, - "defaultPaymentMethod": { - "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Account.schema.json#Account" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyAccount.schema.json", + "title": "PartyAccount", + "definitions": { + "PartyAccount": { + "$id": "#PartyAccount", + "description": "Account used for billing or for settlement purposes concerning a given party (an organization or an individual). It is a specialization of entity Account.", + "type": "object", + "required": [ + "name", + "relatedParty" + ], + "properties": { + "paymentStatus": { + "type": "string", + "description": "The condition of the account, such as due, paid, in arrears." + }, + "billStructure": { + "$ref": "../Customer/BillStructure.schema.json#BillStructure" + }, + "paymentPlan": { + "type": "array", + "items": { + "$ref": "../Customer/PaymentPlan.schema.json#PaymentPlan" + } + }, + "financialAccount": { + "$ref": "FinancialAccountRef.schema.json#FinancialAccountRef" + }, + "defaultPaymentMethod": { + "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" } + }, + "allOf": [ + { + "$ref": "Account.schema.json#Account" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/PartyAccountRef.schema.json b/EngagedParty/PartyAccountRef.schema.json index 772145a4..2d5140d5 100644 --- a/EngagedParty/PartyAccountRef.schema.json +++ b/EngagedParty/PartyAccountRef.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyAccountRef.schema.json", - "title": "PartyAccountRef", - "definitions": { - "PartyAccountRef": { - "$id": "#PartyAccountRef", - "description": "PartyAccount reference. A party account is an arrangement that a party has with an enterprise that provides products to the party.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Detailed description of the party account" - }, - "href": { - "type": "string", - "description": "Reference of the party account" - }, - "id": { - "type": "string", - "description": "Unique identifier of the party account" - }, - "name": { - "type": "string", - "description": "Name of the party account" - }, - "status": { - "type": "string", - "description": "The condition of the account, such as due, paid, in arrears." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyAccountRef.schema.json", + "title": "PartyAccountRef", + "definitions": { + "PartyAccountRef": { + "$id": "#PartyAccountRef", + "description": "PartyAccount reference. A party account is an arrangement that a party has with an enterprise that provides products to the party.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Detailed description of the party account" + }, + "href": { + "type": "string", + "description": "Reference of the party account" + }, + "id": { + "type": "string", + "description": "Unique identifier of the party account" + }, + "name": { + "type": "string", + "description": "Name of the party account" + }, + "status": { + "type": "string", + "description": "The condition of the account, such as due, paid, in arrears." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/PartyBill.schema.json b/EngagedParty/PartyBill.schema.json index fa7bb875..f94d47d9 100644 --- a/EngagedParty/PartyBill.schema.json +++ b/EngagedParty/PartyBill.schema.json @@ -1,117 +1,117 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyBill.schema.json", - "title": "PartyBill", - "definitions": { - "PartyBill": { - "$id": "#PartyBill", - "type": "object", - "properties": { - "amountDue": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Amount due for this bill expressed in the given currency" - }, - "billDate": { - "type": "string", - "format": "date-time", - "description": "Bill date" - }, - "billingPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Billing period of the bill (used for onCycle bill only)" - }, - "billNo": { - "type": "string", - "description": "Bill reference known by the customer or the party and displayed on the bill. Could be different from the id." - }, - "category": { - "type": "string", - "description": "Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note" - }, - "href": { - "type": "string", - "description": "Bill unique reference" - }, - "id": { - "type": "string", - "description": "Bill unique identifier" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date of bill last update" - }, - "nextBillDate": { - "type": "string", - "format": "date-time", - "description": "Approximate date of the next bill production given for information (only used for onCycle bill)" - }, - "paymentDueDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the amount due should have been paid" - }, - "remainingAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Remaining amount to be paid for this bill expressed in the given currency" - }, - "runType": { - "type": "string", - "description": "onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close)" - }, - "state": { - "type": "string", - "description": "State that a bill could take during its lifecycle : New, Validated, On Hold, Sent, Partially paid or Settled" - }, - "taxExcludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Total tax excluded amount expressed in the given currency" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Total tax included amount expressed in the given" - }, - "billDocument": { - "type": "array", - "items": { - "$ref": "../Common/FileDocument.schema.json#FileDocument" - }, - "description": "Document(s) associated to the bill" - }, - "paymentItem": { - "type": "array", - "items": { - "$ref": "../Customer/PaymentItem.schema.json#PaymentItem" - }, - "description": "Payment items already lettered on this bill." - }, - "billingAccount": { - "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" - }, - "taxItem": { - "type": "array", - "items": { - "$ref": "../Customer/TaxItem.schema.json#TaxItem" - } - }, - "paymentMethod": { - "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "financialAccount": { - "$ref": "../EngagedParty/FinancialAccountRef.schema.json#FinancialAccountRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyBill.schema.json", + "title": "PartyBill", + "definitions": { + "PartyBill": { + "$id": "#PartyBill", + "type": "object", + "properties": { + "amountDue": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Amount due for this bill expressed in the given currency" + }, + "billDate": { + "type": "string", + "format": "date-time", + "description": "Bill date" + }, + "billingPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Billing period of the bill (used for onCycle bill only)" + }, + "billNo": { + "type": "string", + "description": "Bill reference known by the customer or the party and displayed on the bill. Could be different from the id." + }, + "category": { + "type": "string", + "description": "Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note" + }, + "href": { + "type": "string", + "description": "Bill unique reference" + }, + "id": { + "type": "string", + "description": "Bill unique identifier" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date of bill last update" + }, + "nextBillDate": { + "type": "string", + "format": "date-time", + "description": "Approximate date of the next bill production given for information (only used for onCycle bill)" + }, + "paymentDueDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the amount due should have been paid" + }, + "remainingAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Remaining amount to be paid for this bill expressed in the given currency" + }, + "runType": { + "type": "string", + "description": "onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close)" + }, + "state": { + "type": "string", + "description": "State that a bill could take during its lifecycle : New, Validated, On Hold, Sent, Partially paid or Settled" + }, + "taxExcludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Total tax excluded amount expressed in the given currency" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Total tax included amount expressed in the given" + }, + "billDocument": { + "type": "array", + "items": { + "$ref": "../Common/FileDocument.schema.json#FileDocument" + }, + "description": "Document(s) associated to the bill" + }, + "paymentItem": { + "type": "array", + "items": { + "$ref": "../Customer/PaymentItem.schema.json#PaymentItem" + }, + "description": "Payment items already lettered on this bill." + }, + "billingAccount": { + "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" + }, + "taxItem": { + "type": "array", + "items": { + "$ref": "../Customer/TaxItem.schema.json#TaxItem" + } + }, + "paymentMethod": { + "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "RelatedParty.schema.json#RelatedParty" + } + }, + "financialAccount": { + "$ref": "FinancialAccountRef.schema.json#FinancialAccountRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/PartyCreditProfile.schema.json b/EngagedParty/PartyCreditProfile.schema.json index 715e9cbb..0f96bc1f 100644 --- a/EngagedParty/PartyCreditProfile.schema.json +++ b/EngagedParty/PartyCreditProfile.schema.json @@ -1,38 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyCreditProfile.schema.json", - "title": "PartyCreditProfile", - "definitions": { - "PartyCreditProfile": { - "type": "object", - "description": "An individual might be evaluated for its worthiness and this evaluation might be based on a credit rating given by a credit agency.", - "properties": { - "creditAgencyName": { - "type": "string", - "description": "Name of the credit agency giving the score" - }, - "creditAgencyType": { - "type": "string", - "description": "Type of the credit agency giving the score" - }, - "ratingReference": { - "type": "string", - "description": "Reference corresponding to the credit rating" - }, - "ratingScore": { - "type": "integer", - "format": "int32", - "description": "A measure of a party\u2019s creditworthiness calculated on the basis of a combination of factors such as their income and credit history" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#/definitions/TimePeriod" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyCreditProfile.schema.json", + "title": "PartyCreditProfile", + "definitions": { + "PartyCreditProfile": { + "$id": "#PartyCreditProfile", + "type": "object", + "description": "An individual might be evaluated for its worthiness and this evaluation might be based on a credit rating given by a credit agency.", + "properties": { + "creditAgencyName": { + "type": "string", + "description": "Name of the credit agency giving the score" + }, + "creditAgencyType": { + "type": "string", + "description": "Type of the credit agency giving the score" + }, + "ratingReference": { + "type": "string", + "description": "Reference corresponding to the credit rating" + }, + "ratingScore": { + "type": "integer", + "format": "int32", + "description": "A measure of a party’s creditworthiness calculated on the basis of a combination of factors such as their income and credit history" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/EngagedParty/PartyOrPartyRoleRef.schema.json b/EngagedParty/PartyOrPartyRoleRef.schema.json index effaf310..bbdcbfc2 100644 --- a/EngagedParty/PartyOrPartyRoleRef.schema.json +++ b/EngagedParty/PartyOrPartyRoleRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyOrPartyRoleRef.schema.json", - "title": "PartyOrPartyRoleRef", - "definitions": { - "PartyOrPartyRoleRef": { - "$id": "#PartyOrPartyRoleRef", - "description": "Party reference. A party represents an organization or an individual.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Text describing the referred party" - }, - "href": { - "type": "string", - "description": "Reference of the referred party (such as a partner or any other party role)." - }, - "id": { - "type": "string", - "description": "Unique identifier of the referred party" - }, - "name": { - "type": "string", - "description": "Name of the referred party (such as a partner or any other party role)" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyOrPartyRoleRef.schema.json", + "title": "PartyOrPartyRoleRef", + "definitions": { + "PartyOrPartyRoleRef": { + "$id": "#PartyOrPartyRoleRef", + "description": "Party reference. A party represents an organization or an individual.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Text describing the referred party" + }, + "href": { + "type": "string", + "description": "Reference of the referred party (such as a partner or any other party role)." + }, + "id": { + "type": "string", + "description": "Unique identifier of the referred party" + }, + "name": { + "type": "string", + "description": "Name of the referred party (such as a partner or any other party role)" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/PartyRef.schema.json b/EngagedParty/PartyRef.schema.json index 83b3743f..1f4d8412 100644 --- a/EngagedParty/PartyRef.schema.json +++ b/EngagedParty/PartyRef.schema.json @@ -1,21 +1,20 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyRef.schema.json", - "title": "PartyRef", - "definitions": { - "PartyRef": { - "$id": "#PartyRef", - "type": "object", - "required" : [ - "@referredType" - ], - "properties": { - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyRef.schema.json", + "title": "PartyRef", + "definitions": { + "PartyRef": { + "$id": "#PartyRef", + "type": "object", + "required": [ + "@referredType" + ], + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/PartyRole.schema.json b/EngagedParty/PartyRole.schema.json index 1630f38b..ed2373a6 100644 --- a/EngagedParty/PartyRole.schema.json +++ b/EngagedParty/PartyRole.schema.json @@ -1,96 +1,98 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyRole.schema.json", - "title": "PartyRole", - "definitions": { - "required": [ - "name", - "roleType" - ], - "PartyRole": { - "$id": "#PartyRole", - "description": "The part played by a party in a given context.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Url used to reference the party role." - }, - "id": { - "type": "string", - "description": "Unique identifier for PartyRoles" - }, - "name": { - "type": "string", - "description": "A word, term, or phrase by which the PartyRole is known and distinguished from other PartyRoles." - }, - "status": { - "type": "string", - "description": "Used to track the lifecycle status of the party role." - }, - "statusReason": { - "type": "string", - "description": "A string providing an explanation on the value of the status lifecycle. For instance if the status is Rejected, statusReason will provide the reason for rejection." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The time period that the PartyRole is valid for." - }, - "engagedParty": { - "$ref": "PartyRef.schema.json#PartyRef" - }, - "roleType": { - "$ref": "RoleTypeRef.schema.json#RoleTypeRef" - }, - "account": { - "type": "array", - "items": { - "$ref": "AccountRef.schema.json#AccountRef" - } - }, - "paymentMethod": { - "type": "array", - "items": { - "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" - } - }, - "contactMedium": { - "type": "array", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - }, - "description": "Describes the characteristic of a party role." - }, - "creditProfile": { - "type": "array", - "items": { - "$ref": "../Customer/CreditProfile.schema.json#CreditProfile" - } - }, - "agreement": { - "type": "array", - "items": { - "$ref": "AgreementRef.schema.json#AgreementRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyRole.schema.json", + "title": "PartyRole", + "definitions": { + "required": { + "0": "name", + "1": "roleType", + "$id": "#required", + "type": "object" + }, + "PartyRole": { + "$id": "#PartyRole", + "description": "The part played by a party in a given context.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Url used to reference the party role." + }, + "id": { + "type": "string", + "description": "Unique identifier for PartyRoles" + }, + "name": { + "type": "string", + "description": "A word, term, or phrase by which the PartyRole is known and distinguished from other PartyRoles." + }, + "status": { + "type": "string", + "description": "Used to track the lifecycle status of the party role." + }, + "statusReason": { + "type": "string", + "description": "A string providing an explanation on the value of the status lifecycle. For instance if the status is Rejected, statusReason will provide the reason for rejection." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The time period that the PartyRole is valid for." + }, + "engagedParty": { + "$ref": "PartyRef.schema.json#PartyRef" + }, + "roleType": { + "$ref": "RoleTypeRef.schema.json#RoleTypeRef" + }, + "account": { + "type": "array", + "items": { + "$ref": "AccountRef.schema.json#AccountRef" + } + }, + "paymentMethod": { + "type": "array", + "items": { + "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" + } + }, + "contactMedium": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + }, + "description": "Describes the characteristic of a party role." + }, + "creditProfile": { + "type": "array", + "items": { + "$ref": "../Customer/CreditProfile.schema.json#CreditProfile" + } + }, + "agreement": { + "type": "array", + "items": { + "$ref": "AgreementRef.schema.json#AgreementRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "RelatedParty.schema.json#RelatedParty" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/PartyRoleRef.schema.json b/EngagedParty/PartyRoleRef.schema.json index b510853e..573918af 100644 --- a/EngagedParty/PartyRoleRef.schema.json +++ b/EngagedParty/PartyRoleRef.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyRoleRef.schema.json", - "title": "PartyRoleRef", - "definitions": { - "PartyRoleRef": { - "$id": "#PartyRoleRef", - "description": "Party role reference. A party role represents the part played by a party in a given context.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product" - }, - "name": { - "type": "string", - "description": "The name of the referred party role." - }, - "partyId": { - "type": "string", - "description": "The identifier of the engaged party that is linked to the PartyRole object." - }, - "partyName": { - "type": "string", - "description": "The name of the engaged party that is linked to the PartyRole object." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyRoleRef.schema.json", + "title": "PartyRoleRef", + "definitions": { + "PartyRoleRef": { + "$id": "#PartyRoleRef", + "description": "Party role reference. A party role represents the part played by a party in a given context.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product" + }, + "name": { + "type": "string", + "description": "The name of the referred party role." + }, + "partyId": { + "type": "string", + "description": "The identifier of the engaged party that is linked to the PartyRole object." + }, + "partyName": { + "type": "string", + "description": "The name of the engaged party that is linked to the PartyRole object." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/RelatedParty.schema.json b/EngagedParty/RelatedParty.schema.json index 4e669a8d..3bd75162 100644 --- a/EngagedParty/RelatedParty.schema.json +++ b/EngagedParty/RelatedParty.schema.json @@ -3,29 +3,29 @@ "$id": "RelatedParty.schema.json", "title": "RelatedParty", "definitions": { - "RelatedParty": { - "$id": "#RelatedParty", - "description": "Related Entity reference. A related party defines party or party role linked to a specific entity.", - "type": "object", - "required" : [ - "id", - "@referredType" - ], - "properties": { - "role": { - "type": "string", - "description": "Role played by the related party" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "RelatedParty": { + "$id": "#RelatedParty", + "description": "Related Entity reference. A related party defines party or party role linked to a specific entity.", + "type": "object", + "required": [ + "id", + "@referredType" + ], + "properties": { + "role": { + "type": "string", + "description": "Role played by the related party" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/RelatedPartyRef.schema.json b/EngagedParty/RelatedPartyRef.schema.json index 18549250..4a844880 100644 --- a/EngagedParty/RelatedPartyRef.schema.json +++ b/EngagedParty/RelatedPartyRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedPartyRef.schema.json", - "title": "RelatedPartyRef", - "definitions": { - "RelatedPartyRef": { - "$id": "#RelatedPartyRef", - "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of a related party" - }, - "href": { - "type": "string", - "description": "Reference of the related party, could be a party reference or a party role reference" - }, - "name": { - "type": "string", - "description": "Name of the related party" - }, - "role": { - "type": "string", - "description": "Role of the related party." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedPartyRef.schema.json", + "title": "RelatedPartyRef", + "definitions": { + "RelatedPartyRef": { + "$id": "#RelatedPartyRef", + "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of a related party" + }, + "href": { + "type": "string", + "description": "Reference of the related party, could be a party reference or a party role reference" + }, + "name": { + "type": "string", + "description": "Name of the related party" + }, + "role": { + "type": "string", + "description": "Role of the related party." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/EngagedParty/RelatedPartyRefOrValue.schema.json b/EngagedParty/RelatedPartyRefOrValue.schema.json index b1893e55..8b3797dd 100644 --- a/EngagedParty/RelatedPartyRefOrValue.schema.json +++ b/EngagedParty/RelatedPartyRefOrValue.schema.json @@ -3,30 +3,28 @@ "$id": "RelatedPartyRefOrValue.schema.json", "title": "RelatedPartyRefOrValue", "definitions": { - "RelatedPartyRefOrValue": { - "discriminator": "isRef", - "$id": "#RelatedPartyRefOrValue", - "description": "Entity reference. A related party defines party or party role linked to a specific entity.", - "type": "object", - "properties": { - "isRef": { - "type": "boolean", - "default": true - - }, - "role":{ - "type": "string" - } - }, - "allOf": [ - { - "$ref": "Party.schema.json#Party" - }, - { - "$ref": "PartyRef.schema.json#PartyRef" - } - - ] - } - } -} + "RelatedPartyRefOrValue": { + "discriminator": "isRef", + "$id": "#RelatedPartyRefOrValue", + "description": "Entity reference. A related party defines party or party role linked to a specific entity.", + "type": "object", + "properties": { + "isRef": { + "type": "boolean", + "default": true + }, + "role": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "Party.schema.json#Party" + }, + { + "$ref": "PartyRef.schema.json#PartyRef" + } + ] + } + } +} \ No newline at end of file diff --git a/EngagedParty/RoleType.schema.json b/EngagedParty/RoleType.schema.json index 6ebbb81f..0d5d4122 100644 --- a/EngagedParty/RoleType.schema.json +++ b/EngagedParty/RoleType.schema.json @@ -1,44 +1,44 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RoleType.schema.json", - "title": "RoleType", - "definitions": { - "RoleType": { - "$id": "#RoleType", - "description": "A RoleType represents the type of a PartyRole, defined in the context of a given type of partnership, such as Buyer, Seller.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "description": { - "type": "string", - "description": "An explanatory text documenting the role type" - }, - "name": { - "type": "string", - "description": "The name of the role type." - }, - "requiresBilling": { - "type": "boolean", - "description": "Indicates whether billing operations will be associated to parties playing the role" - }, - "requiresSettlement": { - "type": "boolean", - "description": "Indicates whether settlement operations will be associated to parties playing the role" - }, - "agreementSpecification": { - "type": "array", - "items": { - "$ref": "AgreementSpecificationRef.schema.json#AgreementSpecificationRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RoleType.schema.json", + "title": "RoleType", + "definitions": { + "RoleType": { + "$id": "#RoleType", + "description": "A RoleType represents the type of a PartyRole, defined in the context of a given type of partnership, such as Buyer, Seller.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "description": { + "type": "string", + "description": "An explanatory text documenting the role type" + }, + "name": { + "type": "string", + "description": "The name of the role type." + }, + "requiresBilling": { + "type": "boolean", + "description": "Indicates whether billing operations will be associated to parties playing the role" + }, + "requiresSettlement": { + "type": "boolean", + "description": "Indicates whether settlement operations will be associated to parties playing the role" + }, + "agreementSpecification": { + "type": "array", + "items": { + "$ref": "AgreementSpecificationRef.schema.json#AgreementSpecificationRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/RoleTypeRef.schema.json b/EngagedParty/RoleTypeRef.schema.json index 65d58a77..61ddff5e 100644 --- a/EngagedParty/RoleTypeRef.schema.json +++ b/EngagedParty/RoleTypeRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RoleTypeRef.schema.json", - "title": "RoleTypeRef", - "definitions": { - "RoleTypeRef": { - "$id": "#RoleTypeRef", - "description": "RoleType reference.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the role type. It uniquely identifies the role type within the partnership type." - }, - "partnershipHref": { - "type": "string", - "description": "Reference url of the partnership type containing the role type" - }, - "partnershipId": { - "type": "string", - "description": "The identifier of the partnership type containing the role type" - }, - "partnershipName": { - "type": "string", - "description": "The name of the partnership type defining this role type" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RoleTypeRef.schema.json", + "title": "RoleTypeRef", + "definitions": { + "RoleTypeRef": { + "$id": "#RoleTypeRef", + "description": "RoleType reference.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the role type. It uniquely identifies the role type within the partnership type." + }, + "partnershipHref": { + "type": "string", + "description": "Reference url of the partnership type containing the role type" + }, + "partnershipId": { + "type": "string", + "description": "The identifier of the partnership type containing the role type" + }, + "partnershipName": { + "type": "string", + "description": "The name of the partnership type defining this role type" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/Rule.schema.json b/EngagedParty/Rule.schema.json index 9c6a9e1e..882f9dc9 100644 --- a/EngagedParty/Rule.schema.json +++ b/EngagedParty/Rule.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Rule.schema.json", - "title": "Rule", - "definitions": { - "Rule": { - "$id": "#Rule", - "type": "object", - "properties": { - "consequence": { - "type": "string" - }, - "id": { - "type": "string" - }, - "metric": { - "type": "string" - }, - "operator": { - "type": "string" - }, - "referenceValue": { - "type": "string" - }, - "tolerance": { - "type": "string" - }, - "unit": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Rule.schema.json", + "title": "Rule", + "definitions": { + "Rule": { + "$id": "#Rule", + "type": "object", + "properties": { + "consequence": { + "type": "string" + }, + "id": { + "type": "string" + }, + "metric": { + "type": "string" + }, + "operator": { + "type": "string" + }, + "referenceValue": { + "type": "string" + }, + "tolerance": { + "type": "string" + }, + "unit": { + "type": "string" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/RuleRef.schema.json b/EngagedParty/RuleRef.schema.json index 907b8cfc..ac6732d6 100644 --- a/EngagedParty/RuleRef.schema.json +++ b/EngagedParty/RuleRef.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RuleRef.schema.json", - "title": "RuleRef", - "definitions": { - "RuleRef": { - "$id": "#RuleRef", - "description": "Rule reference. Rule is a common pattern or Template for the SLA parameters, metrics, and thresholds", - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "href": { - "type": "string", - "description": "The reference of the rule" - }, - "id": { - "type": "string", - "description": "The identifier of the referred rule" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RuleRef.schema.json", + "title": "RuleRef", + "definitions": { + "RuleRef": { + "$id": "#RuleRef", + "description": "Rule reference. Rule is a common pattern or Template for the SLA parameters, metrics, and thresholds", + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "href": { + "type": "string", + "description": "The reference of the rule" + }, + "id": { + "type": "string", + "description": "The identifier of the referred rule" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/SLA.schema.json b/EngagedParty/SLA.schema.json index 4866826f..6b48dfbc 100644 --- a/EngagedParty/SLA.schema.json +++ b/EngagedParty/SLA.schema.json @@ -1,69 +1,69 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SLA.schema.json", - "title": "SLA", - "definitions": { - "SLA": { - "$id": "#SLA", - "description": "Part of a business agreement between a Service Provider and a Customer, quantitatively specifying the service performance level the Service Provider commits to deliver.", - "type": "object", - "properties": { - "approvalDate": { - "type": "string", - "format": "date-time" - }, - "approved": { - "type": "boolean" - }, - "description": { - "type": "string", - "description": "Description of the Service Level Agreement (SLA)" - }, - "href": { - "type": "string", - "description": "Reference of the Service Level Agreement (SLA)" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Service Level Agreement (SLA)" - }, - "name": { - "type": "string", - "description": "Name of the Service Level Agreement (SLA)" - }, - "state": { - "type": "string", - "description": "State of the Service Level Agreement (SLA)" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Period where the clauses of the SLA are applicable" - }, - "version": { - "type": "string", - "description": "Version of the Service Level Agreement (SLA)" - }, - "rule": { - "type": "array", - "items": { - "$ref": "Rule.schema.json#Rule" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "template": { - "$ref": "TemplateRef.schema.json#TemplateRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SLA.schema.json", + "title": "SLA", + "definitions": { + "SLA": { + "$id": "#SLA", + "description": "Part of a business agreement between a Service Provider and a Customer, quantitatively specifying the service performance level the Service Provider commits to deliver.", + "type": "object", + "properties": { + "approvalDate": { + "type": "string", + "format": "date-time" + }, + "approved": { + "type": "boolean" + }, + "description": { + "type": "string", + "description": "Description of the Service Level Agreement (SLA)" + }, + "href": { + "type": "string", + "description": "Reference of the Service Level Agreement (SLA)" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Service Level Agreement (SLA)" + }, + "name": { + "type": "string", + "description": "Name of the Service Level Agreement (SLA)" + }, + "state": { + "type": "string", + "description": "State of the Service Level Agreement (SLA)" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Period where the clauses of the SLA are applicable" + }, + "version": { + "type": "string", + "description": "Version of the Service Level Agreement (SLA)" + }, + "rule": { + "type": "array", + "items": { + "$ref": "Rule.schema.json#Rule" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "RelatedParty.schema.json#RelatedParty" + } + }, + "template": { + "$ref": "TemplateRef.schema.json#TemplateRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/SLARef.schema.json b/EngagedParty/SLARef.schema.json index aed4f1bb..a98d0877 100644 --- a/EngagedParty/SLARef.schema.json +++ b/EngagedParty/SLARef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SLARef.schema.json", - "title": "SLARef", - "definitions": { - "SLARef": { - "$id": "#SLARef", - "description": "ServiceLevelAgreement reference: A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so forth. The SLA is a set of appropriate procedures and targets formally or informally agreed between parties in order to achieve and maintain specified Quality of Service.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the service level agreement" - }, - "id": { - "type": "string", - "description": "Unique identifier of service level agreement" - }, - "name": { - "type": "string", - "description": "Name of the service level agreement" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SLARef.schema.json", + "title": "SLARef", + "definitions": { + "SLARef": { + "$id": "#SLARef", + "description": "ServiceLevelAgreement reference: A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so forth. The SLA is a set of appropriate procedures and targets formally or informally agreed between parties in order to achieve and maintain specified Quality of Service.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the service level agreement" + }, + "id": { + "type": "string", + "description": "Unique identifier of service level agreement" + }, + "name": { + "type": "string", + "description": "Name of the service level agreement" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/SLAViolation.schema.json b/EngagedParty/SLAViolation.schema.json index b486ec19..0f2d484d 100644 --- a/EngagedParty/SLAViolation.schema.json +++ b/EngagedParty/SLAViolation.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SLAViolation.schema.json", - "title": "SLAViolation", - "definitions": { - "SLAViolation": { - "$id": "#SLAViolation", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "href": { - "type": "string" - }, - "id": { - "type": "string" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "violation": { - "$ref": "Violation.schema.json#Violation" - }, - "sla": { - "$ref": "SLARef.schema.json#SLARef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SLAViolation.schema.json", + "title": "SLAViolation", + "definitions": { + "SLAViolation": { + "$id": "#SLAViolation", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "href": { + "type": "string" + }, + "id": { + "type": "string" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "RelatedParty.schema.json#RelatedParty" + } + }, + "violation": { + "$ref": "Violation.schema.json#Violation" + }, + "sla": { + "$ref": "SLARef.schema.json#SLARef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/SLAViolationRef.schema.json b/EngagedParty/SLAViolationRef.schema.json index 5ed55036..a4f90d5f 100755 --- a/EngagedParty/SLAViolationRef.schema.json +++ b/EngagedParty/SLAViolationRef.schema.json @@ -1,28 +1,28 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SLAViolationRef.schema.json", - "title": "SLAViolationRef", - "definitions": { - "SLAViolationRef": { - "$id": "#SLAViolationRef", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "id": { - "type": "string" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SLAViolationRef.schema.json", + "title": "SLAViolationRef", + "definitions": { + "SLAViolationRef": { + "$id": "#SLAViolationRef", + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "id": { + "type": "string" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/SettlementAccount.schema.json b/EngagedParty/SettlementAccount.schema.json index b54435d0..4fb18209 100644 --- a/EngagedParty/SettlementAccount.schema.json +++ b/EngagedParty/SettlementAccount.schema.json @@ -1,23 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SettlementAccount.schema.json", - "title": "SettlementAccount", - "definitions": { - "SettlementAccount": { - "$id": "#SettlementAccount", - "description": "A party account used for settlement purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.", - "type": "object", - "required": [ - "name", - "relatedParty" - ], - "properties": { - }, - "allOf": [ - { - "$ref": "../Common/PartyAccount.schema.json#PartyAccount" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SettlementAccount.schema.json", + "title": "SettlementAccount", + "definitions": { + "SettlementAccount": { + "$id": "#SettlementAccount", + "description": "A party account used for settlement purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.", + "type": "object", + "required": [ + "name", + "relatedParty" + ], + "properties": {}, + "allOf": [ + { + "$ref": "PartyAccount.schema.json#PartyAccount" } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/Skill.schema.json b/EngagedParty/Skill.schema.json index 050541ee..386e2a4c 100644 --- a/EngagedParty/Skill.schema.json +++ b/EngagedParty/Skill.schema.json @@ -1,37 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Skill.schema.json", - "title": "Skill", - "definitions": { - "Skill": { - "type": "object", - "description": "Skills evaluated for an individual with a level and possibly with a limited validity when an obsolescence is defined (Ex: the first-aid certificate first level is limited to one year and an update training is required each year to keep the level).", - "properties": { - "skillCode": { - "type": "string", - "description": "Code of the skill" - }, - "skillName": { - "type": "string", - "description": "Name of the skill such as Java language,\u2026" - }, - "evaluatedLevel": { - "type": "string", - "description": "Level of expertise in a skill evaluated for an individual" - }, - "comment": { - "type": "string", - "description": "A free text comment linked to the evaluation done" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#/definitions/TimePeriod" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Skill.schema.json", + "title": "Skill", + "definitions": { + "Skill": { + "$id": "#Skill", + "type": "object", + "description": "Skills evaluated for an individual with a level and possibly with a limited validity when an obsolescence is defined (Ex: the first-aid certificate first level is limited to one year and an update training is required each year to keep the level).", + "properties": { + "skillCode": { + "type": "string", + "description": "Code of the skill" + }, + "skillName": { + "type": "string", + "description": "Name of the skill such as Java language,…" + }, + "evaluatedLevel": { + "type": "string", + "description": "Level of expertise in a skill evaluated for an individual" + }, + "comment": { + "type": "string", + "description": "A free text comment linked to the evaluation done" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/EngagedParty/TaxExemptionCertificate.schema.json b/EngagedParty/TaxExemptionCertificate.schema.json index 5bad5569..fd30cea3 100644 --- a/EngagedParty/TaxExemptionCertificate.schema.json +++ b/EngagedParty/TaxExemptionCertificate.schema.json @@ -1,34 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaxExemptionCertificate.schema.json", - "title": "TaxExemptionCertificate", - "definitions": { - "TaxExemptionCertificate": { - "type": "object", - "description": "A tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the certificate of the tax exemption" - }, - "taxDefinition": { - "type": "array", - "items": { - "$ref": "TaxDefinition.schema.json#/definitions/TaxDefinition" - } - }, - "validFor": { - "$ref": "TimePeriod.schema.json#/definitions/TimePeriod" - }, - "attachment": { - "$ref": "AttachmentRefOrValue.schema.json#/definitions/AttachmentRefOrValue" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaxExemptionCertificate.schema.json", + "title": "TaxExemptionCertificate", + "definitions": { + "TaxExemptionCertificate": { + "$id": "#TaxExemptionCertificate", + "type": "object", + "description": "A tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the certificate of the tax exemption" + }, + "taxDefinition": { + "type": "array", + "items": { + "$ref": "../Common/TaxDefinition.schema.json#TaxDefinition" + } + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + }, + "attachment": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/EngagedParty/TemplateRef.schema.json b/EngagedParty/TemplateRef.schema.json index e013e96e..84bbb1a1 100644 --- a/EngagedParty/TemplateRef.schema.json +++ b/EngagedParty/TemplateRef.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TemplateRef.schema.json", - "title": "TemplateRef", - "definitions": { - "TemplateRef": { - "$id": "#TemplateRef", - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "href": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TemplateRef.schema.json", + "title": "TemplateRef", + "definitions": { + "TemplateRef": { + "$id": "#TemplateRef", + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "href": { + "type": "string" + }, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/EngagedParty/Violation.schema.json b/EngagedParty/Violation.schema.json index 400d571c..fafe78f9 100644 --- a/EngagedParty/Violation.schema.json +++ b/EngagedParty/Violation.schema.json @@ -1,48 +1,48 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Violation.schema.json", - "title": "Violation", - "definitions": { - "Violation": { - "$id": "#Violation", - "type": "object", - "properties": { - "actualValue": { - "type": "string" - }, - "comment": { - "type": "string" - }, - "consequence": { - "type": "string" - }, - "operator": { - "type": "string" - }, - "referenceValue": { - "type": "string" - }, - "tolerance": { - "type": "string" - }, - "unit": { - "type": "string" - }, - "violationAverage": { - "type": "string" - }, - "attachment": { - "$ref": "../Common/AttachmentRef.schema.json#AttachmentRef" - }, - "rule": { - "$ref": "RuleRef.schema.json#RuleRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Violation.schema.json", + "title": "Violation", + "definitions": { + "Violation": { + "$id": "#Violation", + "type": "object", + "properties": { + "actualValue": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "consequence": { + "type": "string" + }, + "operator": { + "type": "string" + }, + "referenceValue": { + "type": "string" + }, + "tolerance": { + "type": "string" + }, + "unit": { + "type": "string" + }, + "violationAverage": { + "type": "string" + }, + "attachment": { + "$ref": "../Common/AttachmentRef.schema.json#AttachmentRef" + }, + "rule": { + "$ref": "RuleRef.schema.json#RuleRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/MarketingSales/MarketSegmentRef.schema.json b/MarketingSales/MarketSegmentRef.schema.json index 4f3539f7..adc7a77b 100644 --- a/MarketingSales/MarketSegmentRef.schema.json +++ b/MarketingSales/MarketSegmentRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "MarketSegmentRef.schema.json", - "title": "MarketSegmentRef", - "definitions": { - "MarketSegmentRef": { - "$id": "#MarketSegmentRef", - "type": "object", - "description": "provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth.", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the market segment" - }, - "href": { - "type": "string", - "description": "Reference of the market segment" - }, - "name": { - "type": "string", - "description": "Name of the market segment" - }, - "@referredType": { - "type": "string", - "description": "(Class) type of the referred market segment" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "MarketSegmentRef.schema.json", + "title": "MarketSegmentRef", + "definitions": { + "MarketSegmentRef": { + "$id": "#MarketSegmentRef", + "type": "object", + "description": "provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth.", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the market segment" + }, + "href": { + "type": "string", + "description": "Reference of the market segment" + }, + "name": { + "type": "string", + "description": "Name of the market segment" + }, + "@referredType": { + "type": "string", + "description": "(Class) type of the referred market segment" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/MarketingSales/MarketingCampaignRef.schema.json b/MarketingSales/MarketingCampaignRef.schema.json index 96e68c45..060b6b14 100644 --- a/MarketingSales/MarketingCampaignRef.schema.json +++ b/MarketingSales/MarketingCampaignRef.schema.json @@ -1,19 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "MarketingCampaignRef.schema.json", - "title": "MarketingCampaignRef", - "definitions": { - "MarketingCampaignRef": { - "$id": "#MarketingCampaignRef", - "description": "MarketingCampaign reference. Marketing campaign represents the carrier-initiated marketing activity which aims at the better recognition about its brand and offerings by the market", - "type": "object", - "properties": { - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "MarketingCampaignRef.schema.json", + "title": "MarketingCampaignRef", + "definitions": { + "MarketingCampaignRef": { + "$id": "#MarketingCampaignRef", + "description": "MarketingCampaign reference. Marketing campaign represents the carrier-initiated marketing activity which aims at the better recognition about its brand and offerings by the market", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } + } } \ No newline at end of file diff --git a/MarketingSales/SalesLead.schema.json b/MarketingSales/SalesLead.schema.json index 37109d4e..ddcad32b 100644 --- a/MarketingSales/SalesLead.schema.json +++ b/MarketingSales/SalesLead.schema.json @@ -1,120 +1,120 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SalesLead.schema.json", - "title": "SalesLead", - "definitions": { - "SalesLead": { - "$id": "#SalesLead", - "description": "A Sales Lead is the identification of a person or organization that has an interest in the goods and/or services provided in the prospect of them becoming Customers with one or more Subscriptions.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the salesLead" - }, - "id": { - "type": "string", - "description": "Unique identifier of the salesLead" - }, - "name": { - "type": "string", - "description": "Name of the salesLead" - }, - "description": { - "type": "string", - "description": "Unique description of the salesLead" - }, - "status": { - "$ref": "SalesLeadStateType.schema.json#/definitions/SalesLeadStateType" - }, - "statusChangeDate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the salesLead creation" - }, - "referredDate": { - "type": "string", - "format": "date-time", - "description": "Date when the prospect information was received (for example, from a trade show)." - }, - "statusChangeReason": { - "type": "string", - "description": "Reason why the status has changed" - }, - "type": { - "type": "string", - "description": "Indicates the nature of the salesLead" - }, - "rating": { - "type": "string", - "description": "Identifies the potential of a salesLead for becoming a sale. Usual ratings for qualified leads are: hot, warm, cold." - }, - "priority": { - "$ref": "SalesLeadPriorityType.schema.json#/definitions/SalesLeadPriorityType" - }, - "estimatedRevenue": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Estimation of the revenue if the salesLead turns into a sale." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the salesLead is valid" - }, - "marketingCampaign": { - "$ref": "../MarketingSales/MarketingCampaignRef.schema.json#MarketingCampaignRef", - "description": "Campaign represents the carrier-initiated marketing activity which aims at the better recognition about its brand and offerings by the market." - }, - "marketSegment": { - "$ref": "../MarketingSales/MarketSegmentRef.schema.json#MarketSegmentRef", - "description": "MarketSegment reference. A Market Segment is a grouping of Parties, GeographicAreas, SalesChannels, and so forth. MarketSegments are the target of MarketingCampaigns, ProductOfferings, ProductPromotions, ProductPlacements, and ProductPrograms from both internal and external (Competitors, and other Providers) perspective." - }, - "channel": { - "$ref": "../Customer/ChannelRef.schema.json#ChannelRef" - }, - "productOffering": { - "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "prospectContact": { - "type": "array", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - }, - "productSpecification": { - "$ref": "../Product/ProductSpecificationRef.schema.json#ProductSpecificationRef" - }, - "category": { - "$ref": "../Product/CategoryRef.schema.json#CategoryRef" - }, - "salesOpportunity": { - "$ref": "../MarketingSales/SalesOpportunityRef.schema.json#SalesOpportunityRef" - }, - "product": { - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SalesLead.schema.json", + "title": "SalesLead", + "definitions": { + "SalesLead": { + "$id": "#SalesLead", + "description": "A Sales Lead is the identification of a person or organization that has an interest in the goods and/or services provided in the prospect of them becoming Customers with one or more Subscriptions.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the salesLead" + }, + "id": { + "type": "string", + "description": "Unique identifier of the salesLead" + }, + "name": { + "type": "string", + "description": "Name of the salesLead" + }, + "description": { + "type": "string", + "description": "Unique description of the salesLead" + }, + "status": { + "$ref": "SalesLeadStateType.schema.json#/definitions/SalesLeadStateType" + }, + "statusChangeDate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the salesLead creation" + }, + "referredDate": { + "type": "string", + "format": "date-time", + "description": "Date when the prospect information was received (for example, from a trade show)." + }, + "statusChangeReason": { + "type": "string", + "description": "Reason why the status has changed" + }, + "type": { + "type": "string", + "description": "Indicates the nature of the salesLead" + }, + "rating": { + "type": "string", + "description": "Identifies the potential of a salesLead for becoming a sale. Usual ratings for qualified leads are: hot, warm, cold." + }, + "priority": { + "$ref": "SalesLeadPriorityType.schema.json#/definitions/SalesLeadPriorityType" + }, + "estimatedRevenue": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Estimation of the revenue if the salesLead turns into a sale." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the salesLead is valid" + }, + "marketingCampaign": { + "$ref": "MarketingCampaignRef.schema.json#MarketingCampaignRef", + "description": "Campaign represents the carrier-initiated marketing activity which aims at the better recognition about its brand and offerings by the market." + }, + "marketSegment": { + "$ref": "MarketSegmentRef.schema.json#MarketSegmentRef", + "description": "MarketSegment reference. A Market Segment is a grouping of Parties, GeographicAreas, SalesChannels, and so forth. MarketSegments are the target of MarketingCampaigns, ProductOfferings, ProductPromotions, ProductPlacements, and ProductPrograms from both internal and external (Competitors, and other Providers) perspective." + }, + "channel": { + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "productOffering": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "prospectContact": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "productSpecification": { + "$ref": "../Product/ProductSpecificationRef.schema.json#ProductSpecificationRef" + }, + "category": { + "$ref": "../Product/CategoryRef.schema.json#CategoryRef" + }, + "salesOpportunity": { + "$ref": "SalesOpportunityRef.schema.json#SalesOpportunityRef" + }, + "product": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/MarketingSales/SalesOpportunityRef.schema.json b/MarketingSales/SalesOpportunityRef.schema.json index 03b14c4b..b4867065 100644 --- a/MarketingSales/SalesOpportunityRef.schema.json +++ b/MarketingSales/SalesOpportunityRef.schema.json @@ -1,19 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SalesOpportunityRef.schema.json", - "title": "SalesOpportunityRef", - "definitions": { - "SalesOpportunityRef": { - "$id": "#SalesOpportunityRef", - "description": "Sales Opportunity is an 'opportunity' to generate revenue from a Sales Account or Sales Lead. Opportunities are the pending deals that need to be tracked and on which Sales Team plans and executes Sales Activities (Events and Tasks). ", - "type": "object", - "properties": { - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SalesOpportunityRef.schema.json", + "title": "SalesOpportunityRef", + "definitions": { + "SalesOpportunityRef": { + "$id": "#SalesOpportunityRef", + "description": "Sales Opportunity is an 'opportunity' to generate revenue from a Sales Account or Sales Lead. Opportunities are the pending deals that need to be tracked and on which Sales Team plans and executes Sales Activities (Events and Tasks). ", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } + } } \ No newline at end of file diff --git a/Product/AlternateProductOfferingProposal.schema.json b/Product/AlternateProductOfferingProposal.schema.json index be0960a1..91870a64 100644 --- a/Product/AlternateProductOfferingProposal.schema.json +++ b/Product/AlternateProductOfferingProposal.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AlternateProductOfferingProposal.schema.json", - "title": "AlternateProductOfferingProposal", - "definitions": { - "AlternateProductOfferingProposal": { - "$id": "#AlternateProductOfferingProposal", - "description": "Alternate product Offering proposal is used when the requested product offering is not available with characteristic and date asked for. An alternate proposal could be a distinct product offering or product Spec close to requested one or same as requested but with a different activation date.", - "type": "object", - "properties": { - "alternateActivationDate": { - "type": "string", - "format": "date-time", - "description": "Alternate activation date in case seller is not able to meet requested expected activation date." - }, - "id": { - "type": "string", - "description": "Identifier of a alternate product offering proposal" - }, - "alternateProduct": { - "$ref": "ProductRefOrValue.schema.json#ProductRefOrValue", - "description": "Alternate product proposal" - }, - "alternateProductOffering": { - "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef", - "description": "Alternate product offering proposal" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AlternateProductOfferingProposal.schema.json", + "title": "AlternateProductOfferingProposal", + "definitions": { + "AlternateProductOfferingProposal": { + "$id": "#AlternateProductOfferingProposal", + "description": "Alternate product Offering proposal is used when the requested product offering is not available with characteristic and date asked for. An alternate proposal could be a distinct product offering or product Spec close to requested one or same as requested but with a different activation date.", + "type": "object", + "properties": { + "alternateActivationDate": { + "type": "string", + "format": "date-time", + "description": "Alternate activation date in case seller is not able to meet requested expected activation date." + }, + "id": { + "type": "string", + "description": "Identifier of a alternate product offering proposal" + }, + "alternateProduct": { + "$ref": "ProductRefOrValue.schema.json#ProductRefOrValue", + "description": "Alternate product proposal" + }, + "alternateProductOffering": { + "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef", + "description": "Alternate product offering proposal" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/BaseProductRefOrValue.schema.json b/Product/BaseProductRefOrValue.schema.json index 73ace030..f53947a4 100644 --- a/Product/BaseProductRefOrValue.schema.json +++ b/Product/BaseProductRefOrValue.schema.json @@ -1,81 +1,79 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BaseProductRefOrValue.schema.json", - "title": "BaseProductRefOrValue", - "definitions": { - "BaseProductRefOrValue": { - "$id": "#BaseProductRefOrValue", - "description": "In the context of a product order or a product offering qualification, this data structure captures the product information useful to order or qualified an existing subscribed product or to a new one. This is a subset of relevant product attributes for ordering and qualification", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product" - }, - "isRef": { - "type": "boolean", - "default": true, - "description": "indicate if ref pattern is used" - - }, - "name": { - "type": "string", - "description": "This is the name of the product." - }, - "productCharacteristic": { - "type": "array", - "items": { - "$ref": "Characteristic.schema.json#Characteristic" - } - }, - "realizingResource": { - "type": "array", - "items": { - "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" - } - }, - "realizingService": { - "type": "array", - "items": { - "$ref": "../Service/ServiceRef.schema.json#ServiceRef" - } - }, - - "isBundle": { - "type": "boolean", - "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." - }, - "productRelationship": { - "type": "array", - "items": { - "$ref": "ProductRelationship.schema.json#ProductRelationship" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "productSpecification": { - "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef" - }, - "relatedPlace": { - "type": "array", - "items": { - "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BaseProductRefOrValue.schema.json", + "title": "BaseProductRefOrValue", + "definitions": { + "BaseProductRefOrValue": { + "$id": "#BaseProductRefOrValue", + "description": "In the context of a product order or a product offering qualification, this data structure captures the product information useful to order or qualified an existing subscribed product or to a new one. This is a subset of relevant product attributes for ordering and qualification", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product" + }, + "isRef": { + "type": "boolean", + "default": true, + "description": "indicate if ref pattern is used" + }, + "name": { + "type": "string", + "description": "This is the name of the product." + }, + "productCharacteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "realizingResource": { + "type": "array", + "items": { + "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" + } + }, + "realizingService": { + "type": "array", + "items": { + "$ref": "../Service/ServiceRef.schema.json#ServiceRef" + } + }, + "isBundle": { + "type": "boolean", + "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." + }, + "productRelationship": { + "type": "array", + "items": { + "$ref": "ProductRelationship.schema.json#ProductRelationship" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "productSpecification": { + "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef" + }, + "relatedPlace": { + "type": "array", + "items": { + "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/BundledProductOffering.schema.json b/Product/BundledProductOffering.schema.json index b5f62f0f..79c1ef47 100644 --- a/Product/BundledProductOffering.schema.json +++ b/Product/BundledProductOffering.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BundledProductOffering.schema.json", - "title": "BundledProductOffering", - "definitions": { - "BundledProductOffering": { - "$id": "#BundledProductOffering", - "type": "object", - "description": "A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering.", - "properties": { - "href": { - "type": "string", - "description": "Unique reference of the BundledProductOffering" - }, - "id": { - "type": "string", - "description": "Unique identifier of the BundledProductOffering" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the BundledProductOffering" - }, - "bundledProductOfferingOption": { - "$ref": "BundledProductOfferingOption.schema.json#BundledProductOfferingOption", - "description": "A set of numbers that specifies the lower and upper limits for a ProductOffering that can be procured as part of the related BundledProductOffering. Values can range from 0 to unbounded." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BundledProductOffering.schema.json", + "title": "BundledProductOffering", + "definitions": { + "BundledProductOffering": { + "$id": "#BundledProductOffering", + "type": "object", + "description": "A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering.", + "properties": { + "href": { + "type": "string", + "description": "Unique reference of the BundledProductOffering" + }, + "id": { + "type": "string", + "description": "Unique identifier of the BundledProductOffering" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the BundledProductOffering" + }, + "bundledProductOfferingOption": { + "$ref": "BundledProductOfferingOption.schema.json#BundledProductOfferingOption", + "description": "A set of numbers that specifies the lower and upper limits for a ProductOffering that can be procured as part of the related BundledProductOffering. Values can range from 0 to unbounded." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/BundledProductOfferingOption.schema.json b/Product/BundledProductOfferingOption.schema.json index 97fbaaf2..4096fe25 100644 --- a/Product/BundledProductOfferingOption.schema.json +++ b/Product/BundledProductOfferingOption.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BundledProductOfferingOption.schema.json", - "title": "BundledProductOfferingOption", - "definitions": { - "BundledProductOfferingOption": { - "$id": "#BundledProductOfferingOption", - "type": "object", - "description": "A set of numbers that specifies the lower and upper limits for a ProductOffering that can be procured as part of the related BundledProductOffering. Values can range from 0 to unbounded", - "properties": { - "numberRelOfferDefault": { - "type": "integer", - "description": "Default number of produc offereings that should be procured as part of the related BundledProductOffering" - }, - "numberRelOfferLowerLimit": { - "type": "integer", - "description": "lower limit for a product offering that can be procured as part of the related BundledProductOffering" - }, - "numberRelOfferUpperLimit": { - "type": "integer", - "description": "upper limit for a product offering that can be procured as part of the related BundledProductOffering" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BundledProductOfferingOption.schema.json", + "title": "BundledProductOfferingOption", + "definitions": { + "BundledProductOfferingOption": { + "$id": "#BundledProductOfferingOption", + "type": "object", + "description": "A set of numbers that specifies the lower and upper limits for a ProductOffering that can be procured as part of the related BundledProductOffering. Values can range from 0 to unbounded", + "properties": { + "numberRelOfferDefault": { + "type": "integer", + "description": "Default number of produc offereings that should be procured as part of the related BundledProductOffering" + }, + "numberRelOfferLowerLimit": { + "type": "integer", + "description": "lower limit for a product offering that can be procured as part of the related BundledProductOffering" + }, + "numberRelOfferUpperLimit": { + "type": "integer", + "description": "upper limit for a product offering that can be procured as part of the related BundledProductOffering" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/BundledProductOfferingPriceRelationship.schema.json b/Product/BundledProductOfferingPriceRelationship.schema.json index 11e88a91..be9de260 100644 --- a/Product/BundledProductOfferingPriceRelationship.schema.json +++ b/Product/BundledProductOfferingPriceRelationship.schema.json @@ -1,30 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BundledProductOfferingPriceRelationship.schema.json", - "title": "BundledProductOfferingPriceRelationship", - "definitions": { - "BundledProductOfferingPriceRelationship": { - "$id": "#BundledProductOfferingPriceRelationship", - "type": "object", - "description": "This represents a bundling pricing relationship, allowing a price to be composed of multiple other prices (e.g. a recurring charge and a onetime charge).", - "properties": { - "href": { - "type": "string", - "description": "hyperlink reference of the bundled product offering price" - }, - "id": { - "type": "string", - "description": "Unique identifier of the bundled product offering price" - }, - "name": { - "type": "string", - "description": "Name of the bundled product offering price" - } }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BundledProductOfferingPriceRelationship.schema.json", + "title": "BundledProductOfferingPriceRelationship", + "definitions": { + "BundledProductOfferingPriceRelationship": { + "$id": "#BundledProductOfferingPriceRelationship", + "type": "object", + "description": "This represents a bundling pricing relationship, allowing a price to be composed of multiple other prices (e.g. a recurring charge and a onetime charge).", + "properties": { + "href": { + "type": "string", + "description": "hyperlink reference of the bundled product offering price" + }, + "id": { + "type": "string", + "description": "Unique identifier of the bundled product offering price" + }, + "name": { + "type": "string", + "description": "Name of the bundled product offering price" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/BundledProductOfferingRef.schema.json b/Product/BundledProductOfferingRef.schema.json index 393d4efe..2be37e8f 100644 --- a/Product/BundledProductOfferingRef.schema.json +++ b/Product/BundledProductOfferingRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BundledProductOfferingRef.schema.json", - "title": "BundledProductOfferingRef", - "definitions": { - "BundledProductOfferingRef": { - "$id": "#BundledProductOfferingRef", - "description": "BundledProductOffering Reference. A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the product offering" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product offering" - }, - "name": { - "type": "string", - "description": "Name of the product offering" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BundledProductOfferingRef.schema.json", + "title": "BundledProductOfferingRef", + "definitions": { + "BundledProductOfferingRef": { + "$id": "#BundledProductOfferingRef", + "description": "BundledProductOffering Reference. A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the product offering" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product offering" + }, + "name": { + "type": "string", + "description": "Name of the product offering" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/BundledProductSpecification.schema.json b/Product/BundledProductSpecification.schema.json index 2e6da908..65943172 100644 --- a/Product/BundledProductSpecification.schema.json +++ b/Product/BundledProductSpecification.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BundledProductSpecification.schema.json", - "title": "BundledProductSpecification", - "definitions": { - "BundledProductSpecification": { - "$id": "#BundledProductSpecification", - "description": "A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the product specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product specification" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the product specification" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BundledProductSpecification.schema.json", + "title": "BundledProductSpecification", + "definitions": { + "BundledProductSpecification": { + "$id": "#BundledProductSpecification", + "description": "A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the product specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product specification" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the product specification" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/CancelOrder.schema.json b/Product/CancelOrder.schema.json index 2095ebc2..b2d36207 100644 --- a/Product/CancelOrder.schema.json +++ b/Product/CancelOrder.schema.json @@ -1,45 +1,45 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CancelOrder.schema.json", - "title": "CancelOrder", - "definitions": { - "CancelOrder": { - "$id": "#CancelOrder", - "description": "A Order cancel is a type of task which can be used to place a request to cancel an order", - "type": "object", - "properties": { - "requestedCancellationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the submitter wants the order to be cancelled" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the cancellation request" - }, - "id": { - "type": "string", - "description": "id of the cancellation request (this is not an order id)" - }, - "effectiveCancellationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order is cancelled." - }, - "cancellationReason": { - "type": "string", - "description": "Reason why the order is cancelled." - }, - "state": { - "description": "Tracks the lifecycle status of the cancellation request, such as Acknowledged, Rejected, InProgress, Pending and so on.", - "$ref": "TaskStateType.schema.json#/definitions/TaskStateType" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CancelOrder.schema.json", + "title": "CancelOrder", + "definitions": { + "CancelOrder": { + "$id": "#CancelOrder", + "description": "A Order cancel is a type of task which can be used to place a request to cancel an order", + "type": "object", + "properties": { + "requestedCancellationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the submitter wants the order to be cancelled" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the cancellation request" + }, + "id": { + "type": "string", + "description": "id of the cancellation request (this is not an order id)" + }, + "effectiveCancellationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order is cancelled." + }, + "cancellationReason": { + "type": "string", + "description": "Reason why the order is cancelled." + }, + "state": { + "description": "Tracks the lifecycle status of the cancellation request, such as Acknowledged, Rejected, InProgress, Pending and so on.", + "$ref": "../Common/TaskStateType.schema.json#TaskStateType" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/CancelProductOrder.schema.json b/Product/CancelProductOrder.schema.json index 4259635b..662f90f4 100644 --- a/Product/CancelProductOrder.schema.json +++ b/Product/CancelProductOrder.schema.json @@ -1,23 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CancelProductOrder.schema.json", - "title": "CancelProductOrder", - "definitions": { - "CancelProductOrder": { - "$id": "#CancelProductOrder", - "description": "Request for cancellation an existing product order", - "type": "object", - "required": ["productOrder"], - "properties": { - "productOrder": { - "$ref": "../Customer/ProductOrderRef.schema.json#ProductOrderRef" - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#CancelOrder" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CancelProductOrder.schema.json", + "title": "CancelProductOrder", + "definitions": { + "CancelProductOrder": { + "$id": "#CancelProductOrder", + "description": "Request for cancellation an existing product order", + "type": "object", + "required": [ + "productOrder" + ], + "properties": { + "productOrder": { + "$ref": "../Customer/ProductOrderRef.schema.json#ProductOrderRef" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#CancelOrderRef" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/Catalog.schema.json b/Product/Catalog.schema.json index 7eeeba56..3e89ab99 100644 --- a/Product/Catalog.schema.json +++ b/Product/Catalog.schema.json @@ -1,70 +1,70 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Catalog.schema.json", - "title": "Catalog", - "definitions": { - "Catalog": { - "$id": "#Catalog", - "description": "A collection of Product Offerings, intended for a specific DistributionChannel, enhanced with additional information such as SLA parameters, invoicing and shipping details", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Unique reference of the catalog" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Catalog" - }, - "description": { - "type": "string", - "description": "Description of this catalog" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the catalog" - }, - "catalogType": { - "type": "string", - "description": "Indicates if the catalog is a product, service or resource catalog" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the catalog is valid" - }, - "version": { - "type": "string", - "description": "Catalog version" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "description": "List of parties involved in this catalog" - }, - "category": { - "type": "array", - "items": { - "$ref": "CategoryRef.schema.json#CategoryRef" - }, - "description": "List of root categories contained in this catalog" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Catalog.schema.json", + "title": "Catalog", + "definitions": { + "Catalog": { + "$id": "#Catalog", + "description": "A collection of Product Offerings, intended for a specific DistributionChannel, enhanced with additional information such as SLA parameters, invoicing and shipping details", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Unique reference of the catalog" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Catalog" + }, + "description": { + "type": "string", + "description": "Description of this catalog" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the catalog" + }, + "catalogType": { + "type": "string", + "description": "Indicates if the catalog is a product, service or resource catalog" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the catalog is valid" + }, + "version": { + "type": "string", + "description": "Catalog version" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "List of parties involved in this catalog" + }, + "category": { + "type": "array", + "items": { + "$ref": "CategoryRef.schema.json#CategoryRef" + }, + "description": "List of root categories contained in this catalog" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/Category.schema.json b/Product/Category.schema.json index 8c49c092..22377c17 100644 --- a/Product/Category.schema.json +++ b/Product/Category.schema.json @@ -1,74 +1,74 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Category.schema.json", - "title": "Category", - "definitions": { - "Category": { - "$id": "#Category", - "type": "object", - "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.", - "properties": { - "description": { - "type": "string", - "description": "Description of the category" - }, - "href": { - "type": "string", - "description": "Reference of the category" - }, - "id": { - "type": "string", - "description": "Unique identifier of the category" - }, - "isRoot": { - "type": "boolean", - "description": "If true, this Boolean indicates that the category is a root of categories" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the category" - }, - "parentId": { - "type": "string", - "description": "Unique identifier of the parent category" - }, - "productOffering": { - "type": "array", - "items": { - "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "description": "A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information." - }, - "subCategory": { - "type": "array", - "items": { - "$ref": "CategoryRef.schema.json#CategoryRef" - }, - "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other (sub-)categories and/or product offerings." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the category is valid" - }, - "version": { - "type": "string", - "description": "Category version" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Category.schema.json", + "title": "Category", + "definitions": { + "Category": { + "$id": "#Category", + "type": "object", + "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.", + "properties": { + "description": { + "type": "string", + "description": "Description of the category" + }, + "href": { + "type": "string", + "description": "Reference of the category" + }, + "id": { + "type": "string", + "description": "Unique identifier of the category" + }, + "isRoot": { + "type": "boolean", + "description": "If true, this Boolean indicates that the category is a root of categories" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the category" + }, + "parentId": { + "type": "string", + "description": "Unique identifier of the parent category" + }, + "productOffering": { + "type": "array", + "items": { + "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "description": "A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information." + }, + "subCategory": { + "type": "array", + "items": { + "$ref": "CategoryRef.schema.json#CategoryRef" + }, + "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other (sub-)categories and/or product offerings." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the category is valid" + }, + "version": { + "type": "string", + "description": "Category version" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Product/CategoryRef.schema.json b/Product/CategoryRef.schema.json index d8b74ae1..bc189966 100644 --- a/Product/CategoryRef.schema.json +++ b/Product/CategoryRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CategoryRef.schema.json", - "title": "CategoryRef", - "definitions": { - "CategoryRef": { - "$id": "#CategoryRef", - "description": "The category for grouping recommendations", - "type": "object", - "properties": { - "version": { - "type": "string", - "description": "Category version" - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CategoryRef.schema.json", + "title": "CategoryRef", + "definitions": { + "CategoryRef": { + "$id": "#CategoryRef", + "description": "The category for grouping recommendations", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "Category version" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ConsumptionSummary.schema.json b/Product/ConsumptionSummary.schema.json index 24a0751e..b3a1b7cf 100644 --- a/Product/ConsumptionSummary.schema.json +++ b/Product/ConsumptionSummary.schema.json @@ -1,47 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ConsumptionSummary.schema.json", - "title": "ConsumptionSummary", - "definitions": { - "ConsumptionSummary": { - "$id": "#ConsumptionSummary", - "type": "object", - "description": "The consumption counters (called ConsumptionSummary in the SID model) detail for example the different kind of consumption done on the bucket.", - "properties": { - "consumptionPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Consumption counter period between a start date time and an end date time. For prepaid bucket, the period of counters is between the start date of the bucket and the effective date of the usage consumption report generation. For postpaid bucket, the period of counters is between the last bill date and the effective date of the usage consumption report generation." - }, - "counterType": { - "type": "string", - "description": "Type of the consumption counter. We can give for example a counter of the used value for a bucket (counterType=used for example) or the value of the consumption done out of the bucket(s) (counterType=outOfBucket for example)" - }, - "level": { - "type": "string", - "description": "Counter level. The counter can be given globally for the bucket or detailed by user or by network product for example in case of shared bucket" - }, - "product": { - "$ref": "NetworkProductRef.schema.json#NetworkProductRef", - "description": "Public identifier associated to the product for which the consumption counter is detailed. If the level of the counter is global (i.e. concerning all the network products), the list of them is not specified. It can be found through the network products listed in the bucket sub-resource" - }, - "user": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty", - "description": "Reference of the user for which the consumption counter is detailed. If the level of the counter is global (i.e. concerning all the users), the list of them is not specified. It can be found through the users listed in the network products of the bucket sub-resource" - }, - "value": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "Numeric value of the bucket counter in a given unit" - }, - "valueName": { - "type": "string", - "description": "Value of the counter in a formatted string used for display needs for example" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ConsumptionSummary.schema.json", + "title": "ConsumptionSummary", + "definitions": { + "ConsumptionSummary": { + "$id": "#ConsumptionSummary", + "type": "object", + "description": "The consumption counters (called ConsumptionSummary in the SID model) detail for example the different kind of consumption done on the bucket.", + "properties": { + "consumptionPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Consumption counter period between a start date time and an end date time. For prepaid bucket, the period of counters is between the start date of the bucket and the effective date of the usage consumption report generation. For postpaid bucket, the period of counters is between the last bill date and the effective date of the usage consumption report generation." + }, + "counterType": { + "type": "string", + "description": "Type of the consumption counter. We can give for example a counter of the used value for a bucket (counterType=used for example) or the value of the consumption done out of the bucket(s) (counterType=outOfBucket for example)" + }, + "level": { + "type": "string", + "description": "Counter level. The counter can be given globally for the bucket or detailed by user or by network product for example in case of shared bucket" + }, + "product": { + "$ref": "NetworkProductRef.schema.json#NetworkProductRef", + "description": "Public identifier associated to the product for which the consumption counter is detailed. If the level of the counter is global (i.e. concerning all the network products), the list of them is not specified. It can be found through the network products listed in the bucket sub-resource" + }, + "user": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty", + "description": "Reference of the user for which the consumption counter is detailed. If the level of the counter is global (i.e. concerning all the users), the list of them is not specified. It can be found through the users listed in the network products of the bucket sub-resource" + }, + "value": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "Numeric value of the bucket counter in a given unit" + }, + "valueName": { + "type": "string", + "description": "Value of the counter in a formatted string used for display needs for example" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/EligibilityUnavailabilityReason.schema.json b/Product/EligibilityUnavailabilityReason.schema.json index e58269b2..fb3361fc 100644 --- a/Product/EligibilityUnavailabilityReason.schema.json +++ b/Product/EligibilityUnavailabilityReason.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EligibilityUnavailabilityReason.schema.json", - "title": "EligibilityUnavailabilityReason", - "definitions": { - "EligibilityUnavailabilityReason": { - "$id": "#EligibilityUnavailabilityReason", - "description": "Reason for eligibility result if the productOfferingQualification result is no (meaning the productOffering or productSpec is not available).", - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Unavailability reason code." - }, - "label": { - "type": "string", - "description": "Unavailability reason label." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EligibilityUnavailabilityReason.schema.json", + "title": "EligibilityUnavailabilityReason", + "definitions": { + "EligibilityUnavailabilityReason": { + "$id": "#EligibilityUnavailabilityReason", + "description": "Reason for eligibility result if the productOfferingQualification result is no (meaning the productOffering or productSpec is not available).", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Unavailability reason code." + }, + "label": { + "type": "string", + "description": "Unavailability reason label." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/LoyaltyAccount.schema.json b/Product/LoyaltyAccount.schema.json index a2065195..dcfd7858 100644 --- a/Product/LoyaltyAccount.schema.json +++ b/Product/LoyaltyAccount.schema.json @@ -1,26 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyAccount.schema.json", - "title": "LoyaltyAccount", - "definitions": { - "LoyaltyAccount": { - "$id": "#LoyaltyAccount", - "description": "A loyalty account, containing loyalty balances.", - "type": "object", - "title": "LoyaltyAccount", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the account." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty member’s loyalty account." - }, - "loyaltyProgramProduct": { - "$ref": "LoyaltyProgramProductRef.schema.json#/definitions/LoyaltyProgramProductRef" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyAccount.schema.json", + "title": "LoyaltyAccount", + "definitions": { + "LoyaltyAccount": { + "$id": "#LoyaltyAccount", + "description": "A loyalty account, containing loyalty balances.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the account." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty member’s loyalty account." + }, + "loyaltyProgramProduct": { + "$ref": "LoyaltyProgramProductRef.schema.json#LoyaltyProgramProductRef" } + } } + } } \ No newline at end of file diff --git a/Product/LoyaltyAccountRef.schema.json b/Product/LoyaltyAccountRef.schema.json index 7b1f1055..7edea9a8 100644 --- a/Product/LoyaltyAccountRef.schema.json +++ b/Product/LoyaltyAccountRef.schema.json @@ -2,22 +2,21 @@ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "LoyaltyAccountRef.schema.json", "title": "LoyaltyAccountRef", - "definitions": { - "LoyaltyAccountRef": { - "$id": "#LoyaltyAccountRef", - "title": "LoyaltyAccountRef", - "description": "Reference to a loyalty account.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the account." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty member’s loyalty account." - } - } - } + "definitions": { + "LoyaltyAccountRef": { + "$id": "#LoyaltyAccountRef", + "description": "Reference to a loyalty account.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the account." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty member’s loyalty account." + } } + } + } } \ No newline at end of file diff --git a/Product/LoyaltyAction.schema.json b/Product/LoyaltyAction.schema.json index ce88ae50..250a39dd 100644 --- a/Product/LoyaltyAction.schema.json +++ b/Product/LoyaltyAction.schema.json @@ -1,74 +1,73 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyAction.schema.json", - "title": "LoyaltyAction", - "definitions": { - "LoyaltyAction": { - "$id": "#LoyaltyAction", - "description": "Contains information on a loyalty action that should be applied should certain conditions be met for a loyalty rule and program.", - "type": "object", - "title": "LoyaltyAction", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty event type." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty event type." - }, - "type": { - "type": "string", - "description": "The type of loyalty action.", - "enum": [ - "LoyaltyEarn", - "CustomerOrder", - "BusinessInteraction" - ] - }, - "actionAttributes": { - "type": "object", - "$ref": "../Common/Any.schema.json#/definitions/Any", - "description": "Additional attributes required to perform the action. These attributes will depend on the type of the loyalty action. For example, if it is a LoyaltyEarn action, there will be a “quantity” attribute value pair indicating how many points should be earned." - }, - "body": { - "type": "object", - "$ref": "../Common/Any.schema.json#/definitions/Any", - "description": "The body if the request that is made when this action i executed. The body is assumed to be of type text/json. Any tokens denoted with {} will be replaced by attributes present in: Member profile, actionAttributes or event attributes in the loyalty event request." - }, - "headers": { - "type": "object", - "$ref": "../Common/Any.schema.json#/definitions/Any", - "description": "The HTTP headers that is added to the action call." - }, - "version": { - "type": "string", - "description": "A string that identifies the version of the loyalty action." - }, - "commonName": { - "type": "string", - "description": "A user-friendly identifier of the loyalty execution point." - }, - "description": { - "type": "string", - "description": "A free-form description of the loyalty execution point." - }, - "action": { - "type": "string", - "description": "The HTTP operation to be used when calling the endpoint", - "enum": [ - "POST", - "PUT", - "GET", - "PATCH", - "DELETE" - ] - }, - "endpoint": { - "type": "string", - "description": "The endpoint to call to trigger a BusinessInteraction, CustomerOrder or LoyaltyEarn." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyAction.schema.json", + "title": "LoyaltyAction", + "definitions": { + "LoyaltyAction": { + "$id": "#LoyaltyAction", + "description": "Contains information on a loyalty action that should be applied should certain conditions be met for a loyalty rule and program.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty event type." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty event type." + }, + "type": { + "type": "string", + "description": "The type of loyalty action.", + "enum": [ + "LoyaltyEarn", + "CustomerOrder", + "BusinessInteraction" + ] + }, + "actionAttributes": { + "type": "object", + "$ref": "../Common/Any.schema.json#Any", + "description": "Additional attributes required to perform the action. These attributes will depend on the type of the loyalty action. For example, if it is a LoyaltyEarn action, there will be a “quantity” attribute value pair indicating how many points should be earned." + }, + "body": { + "type": "object", + "$ref": "../Common/Any.schema.json#Any", + "description": "The body if the request that is made when this action i executed. The body is assumed to be of type text/json. Any tokens denoted with {} will be replaced by attributes present in: Member profile, actionAttributes or event attributes in the loyalty event request." + }, + "headers": { + "type": "object", + "$ref": "../Common/Any.schema.json#Any", + "description": "The HTTP headers that is added to the action call." + }, + "version": { + "type": "string", + "description": "A string that identifies the version of the loyalty action." + }, + "commonName": { + "type": "string", + "description": "A user-friendly identifier of the loyalty execution point." + }, + "description": { + "type": "string", + "description": "A free-form description of the loyalty execution point." + }, + "action": { + "type": "string", + "description": "The HTTP operation to be used when calling the endpoint", + "enum": [ + "POST", + "PUT", + "GET", + "PATCH", + "DELETE" + ] + }, + "endpoint": { + "type": "string", + "description": "The endpoint to call to trigger a BusinessInteraction, CustomerOrder or LoyaltyEarn." } + } } + } } \ No newline at end of file diff --git a/Product/LoyaltyActionRef.schema.json b/Product/LoyaltyActionRef.schema.json index 2d5fab58..1eefc1e0 100644 --- a/Product/LoyaltyActionRef.schema.json +++ b/Product/LoyaltyActionRef.schema.json @@ -1,23 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyActionRef.schema.json", - "title": "LoyaltyActionRef", - "definitions": { - "LoyaltyActionRef": { - "$id": "#LoyaltyActionRef", - "description": "A reference to a loyalty action.", - "type": "object", - "title": "LoyaltyActionRef", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty action." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty action." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyActionRef.schema.json", + "title": "LoyaltyActionRef", + "definitions": { + "LoyaltyActionRef": { + "$id": "#LoyaltyActionRef", + "description": "A reference to a loyalty action.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty action." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty action." } + } } + } } \ No newline at end of file diff --git a/Product/LoyaltyBalance.schema.json b/Product/LoyaltyBalance.schema.json index 161501db..c5cdd24e 100644 --- a/Product/LoyaltyBalance.schema.json +++ b/Product/LoyaltyBalance.schema.json @@ -1,38 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyBalance.schema.json", - "title": "LoyaltyBalance", - "definitions": { - "LoyaltyBalance": { - "$id": "#LoyaltyBalance", - "description": "A loyalty balance, containing a balance unit and value.", - "type": "object", - "title": "LoyaltyBalance", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty balance." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty member’s loyalty balance." - }, - "quantity": { - "type": "object", - "description": "Unit and value of the balance.", - "$ref": "../Common/Money.schema.json#/definitions/Money" - }, - "loyaltyProgramMember": { - "type": "object", - "description": "Reference to the loyaltyProgramMember to whom the loyaltyAccount belongs.", - "$ref": "LoyaltyProgramMemberRef.schema.json#/definitions/LoyaltyProgramMemberRef" - }, - "validFor": { - "type": "object", - "description": "The validity period in which loyalty can be burned using the account.", - "$ref": "../Common/TimePeriod.schema.json#/definitions/TimePeriod" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyBalance.schema.json", + "title": "LoyaltyBalance", + "definitions": { + "LoyaltyBalance": { + "$id": "#LoyaltyBalance", + "description": "A loyalty balance, containing a balance unit and value.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty balance." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty member’s loyalty balance." + }, + "quantity": { + "type": "object", + "description": "Unit and value of the balance.", + "$ref": "../Common/Money.schema.json#Money" + }, + "loyaltyProgramMember": { + "type": "object", + "description": "Reference to the loyaltyProgramMember to whom the loyaltyAccount belongs.", + "$ref": "LoyaltyProgramMemberRef.schema.json#LoyaltyProgramMemberRef" + }, + "validFor": { + "type": "object", + "description": "The validity period in which loyalty can be burned using the account.", + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" } + } } + } } \ No newline at end of file diff --git a/Product/LoyaltyCondition.schema.json b/Product/LoyaltyCondition.schema.json index 393df031..d611668c 100644 --- a/Product/LoyaltyCondition.schema.json +++ b/Product/LoyaltyCondition.schema.json @@ -1,35 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyCondition.schema.json", - "title": "LoyaltyCondition", - "definitions": { - "LoyaltyCondition": { - "$id": "#LoyaltyCondition", - "description": "A condition, comprised of a attribute that will be tested against a value.", - "type": "object", - "title": "LoyaltyCondition", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty condition." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty event type." - }, - "attribute": { - "type": "string", - "description": "The attribute to evaluate." - }, - "operator": { - "type": "string", - "description": "Comparison operator to be used in the evaluation." - }, - "value": { - "type": "string", - "description": "The value of the attribute to be evaluated." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyCondition.schema.json", + "title": "LoyaltyCondition", + "definitions": { + "LoyaltyCondition": { + "$id": "#LoyaltyCondition", + "description": "A condition, comprised of a attribute that will be tested against a value.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty condition." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty event type." + }, + "attribute": { + "type": "string", + "description": "The attribute to evaluate." + }, + "operator": { + "type": "string", + "description": "Comparison operator to be used in the evaluation." + }, + "value": { + "type": "string", + "description": "The value of the attribute to be evaluated." } + } } + } } \ No newline at end of file diff --git a/Product/LoyaltyConditionRef.schema.json b/Product/LoyaltyConditionRef.schema.json index f8a8eea6..dd9c25a5 100644 --- a/Product/LoyaltyConditionRef.schema.json +++ b/Product/LoyaltyConditionRef.schema.json @@ -1,23 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyConditionRef.schema.json", - "title": "LoyaltyConditionRef", - "definitions": { - "LoyaltyConditionRef": { - "$id": "#LoyaltyConditionRef", - "description": "A reference to a loyalty condition.", - "type": "object", - "title": "LoyaltyConditionRef", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty condition." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty condition." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyConditionRef.schema.json", + "title": "LoyaltyConditionRef", + "definitions": { + "LoyaltyConditionRef": { + "$id": "#LoyaltyConditionRef", + "description": "A reference to a loyalty condition.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty condition." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty condition." } + } } + } } \ No newline at end of file diff --git a/Product/LoyaltyEvent.schema.json b/Product/LoyaltyEvent.schema.json index 088d6c55..945f810a 100644 --- a/Product/LoyaltyEvent.schema.json +++ b/Product/LoyaltyEvent.schema.json @@ -1,35 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyEvent.schema.json", - "title": "LoyaltyEvent", - "definitions": { - "LoyaltyEvent": { - "$id": "#LoyaltyEvent", - "description": "A loyalty event notification.", - "type": "object", - "title": "LoyaltyEvent", - "properties": { - "eventId": { - "$ref": "LoyaltyProgramProductRef.schema.json#/definitions/LoyaltyProgramProductRef" - }, - "eventType": { - "type": "string", - "description": "The incoming loyalty event type." - }, - "eventTime": { - "type": "string", - "description": "The time that the event was received." - }, - "memberId": { - "type": "string", - "description": "The loyalty program member ID associated with the event." - }, - "event": { - "type": "object", - "$ref": "../Common/Any.schema.json#/definitions/Any", - "description": "The event attributes." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyEvent.schema.json", + "title": "LoyaltyEvent", + "definitions": { + "LoyaltyEvent": { + "$id": "#LoyaltyEvent", + "description": "A loyalty event notification.", + "type": "object", + "properties": { + "eventId": { + "$ref": "LoyaltyProgramProductRef.schema.json#LoyaltyProgramProductRef" + }, + "eventType": { + "type": "string", + "description": "The incoming loyalty event type." + }, + "eventTime": { + "type": "string", + "description": "The time that the event was received." + }, + "memberId": { + "type": "string", + "description": "The loyalty program member ID associated with the event." + }, + "event": { + "type": "object", + "$ref": "../Common/Any.schema.json#Any", + "description": "The event attributes." } + } } + } } \ No newline at end of file diff --git a/Product/LoyaltyEventType.schema.json b/Product/LoyaltyEventType.schema.json index 19eb2986..4f7094f1 100644 --- a/Product/LoyaltyEventType.schema.json +++ b/Product/LoyaltyEventType.schema.json @@ -1,27 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyEventType.schema.json", - "title": "LoyaltyEventType", - "definitions": { - "LoyaltyEventType": { - "$id": "#LoyaltyEventType", - "description": "An event type used to match filter incoming loyalty events.", - "type": "object", - "title": "LoyaltyEventType", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty event type." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty event type." - }, - "eventType": { - "type": "string", - "description": "The type of loyalty event expected to trigger the loyalty rule evaluation, e.g. a CustomerOrder or an Invoice. The eventType should be unique to prevent existing resources not being reused. An eventType that already exists will result in a 422 error." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyEventType.schema.json", + "title": "LoyaltyEventType", + "definitions": { + "LoyaltyEventType": { + "$id": "#LoyaltyEventType", + "description": "An event type used to match filter incoming loyalty events.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty event type." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty event type." + }, + "eventType": { + "type": "string", + "description": "The type of loyalty event expected to trigger the loyalty rule evaluation, e.g. a CustomerOrder or an Invoice. The eventType should be unique to prevent existing resources not being reused. An eventType that already exists will result in a 422 error." } + } } + } } \ No newline at end of file diff --git a/Product/LoyaltyEventTypeRef.schema.json b/Product/LoyaltyEventTypeRef.schema.json index 23033f03..05e9e336 100644 --- a/Product/LoyaltyEventTypeRef.schema.json +++ b/Product/LoyaltyEventTypeRef.schema.json @@ -1,23 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyEventTypeRef.schema.json", - "title": "LoyaltyEventTypeRef", - "definitions": { - "LoyaltyEventTypeRef": { - "$id": "#LoyaltyEventTypeRef", - "description": "A reference to a loyalty event type.", - "type": "object", - "title": "LoyaltyEventTypeRef", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty event type." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty event type." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyEventTypeRef.schema.json", + "title": "LoyaltyEventTypeRef", + "definitions": { + "LoyaltyEventTypeRef": { + "$id": "#LoyaltyEventTypeRef", + "description": "A reference to a loyalty event type.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty event type." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty event type." } + } } + } } \ No newline at end of file diff --git a/Product/LoyaltyExecutionPoint.schema.json b/Product/LoyaltyExecutionPoint.schema.json index 6c70253b..8773d916 100644 --- a/Product/LoyaltyExecutionPoint.schema.json +++ b/Product/LoyaltyExecutionPoint.schema.json @@ -1,79 +1,79 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyExecutionPoint.schema.json", - "title": "LoyaltyExecutionPoint", - "definitions": { - "LoyaltyAccount": { - "$id": "#LoyaltyExecutionPoint", - "description": "A record of a loyalty action that was applied.", - "type": "object", - "title": "LoyaltyExecutionPoint", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty event type." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty event type." - }, - "type": { - "type": "string", - "description": "The type of loyalty action.", - "enum": [ - "LoyaltyEarn", - "CustomerOrder", - "BusinessInteraction" - ] - }, - "actionAttributes": { - "type": "object", - "$ref": "../Common/Any.schema.json#/definitions/Any", - "description": "Additional attributes required to perform the action. These attributes will depend on the type of the loyalty action. For example, if it is a LoyaltyEarn action, there will be a “quantity” attribute value pair indicating how many points should be earned." - }, - "body": { - "type": "object", - "$ref": "../Common/Any.schema.json#/definitions/Any", - "description": "The body if the request that is made when this action i executed. The body is assumed to be of type text/json. Any tokens denoted with {} will be replaced by attributes present in: Member profile, actionAttributes or event attributes in the loyalty event request." - }, - "headers": { - "type": "object", - "$ref": "../Common/Any.schema.json#/definitions/Any", - "description": "The HTTP headers that is added to the action call." - }, - "version": { - "type": "string", - "description": "A string that identifies the version of the loyalty action." - }, - "commonName": { - "type": "string", - "description": "A user-friendly identifier of the loyalty execution point." - }, - "description": { - "type": "string", - "description": "A free-form description of the loyalty execution point." - }, - "action": { - "type": "string", - "description": "The HTTP operation to be used when calling the endpoint", - "enum": [ - "POST", - "PUT", - "GET", - "PATCH", - "DELETE" - ] - }, - "endpoint": { - "type": "string", - "description": "The endpoint to call to trigger a BusinessInteraction, CustomerOrder or LoyaltyEarn." - }, - "datetime": { - "type": "string", - "description": "The timestamp that the action was applied.", - "format": "date-time" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyExecutionPoint.schema.json", + "title": "LoyaltyExecutionPoint", + "definitions": { + "LoyaltyAccount": { + "$id": "#LoyaltyExecutionPoint", + "description": "A record of a loyalty action that was applied.", + "type": "object", + "title": "LoyaltyExecutionPoint", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty event type." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty event type." + }, + "type": { + "type": "string", + "description": "The type of loyalty action.", + "enum": [ + "LoyaltyEarn", + "CustomerOrder", + "BusinessInteraction" + ] + }, + "actionAttributes": { + "type": "object", + "$ref": "../Common/Any.schema.json#/definitions/Any", + "description": "Additional attributes required to perform the action. These attributes will depend on the type of the loyalty action. For example, if it is a LoyaltyEarn action, there will be a “quantity” attribute value pair indicating how many points should be earned." + }, + "body": { + "type": "object", + "$ref": "../Common/Any.schema.json#/definitions/Any", + "description": "The body if the request that is made when this action i executed. The body is assumed to be of type text/json. Any tokens denoted with {} will be replaced by attributes present in: Member profile, actionAttributes or event attributes in the loyalty event request." + }, + "headers": { + "type": "object", + "$ref": "../Common/Any.schema.json#/definitions/Any", + "description": "The HTTP headers that is added to the action call." + }, + "version": { + "type": "string", + "description": "A string that identifies the version of the loyalty action." + }, + "commonName": { + "type": "string", + "description": "A user-friendly identifier of the loyalty execution point." + }, + "description": { + "type": "string", + "description": "A free-form description of the loyalty execution point." + }, + "action": { + "type": "string", + "description": "The HTTP operation to be used when calling the endpoint", + "enum": [ + "POST", + "PUT", + "GET", + "PATCH", + "DELETE" + ] + }, + "endpoint": { + "type": "string", + "description": "The endpoint to call to trigger a BusinessInteraction, CustomerOrder or LoyaltyEarn." + }, + "datetime": { + "type": "string", + "description": "The timestamp that the action was applied.", + "format": "date-time" } + } } + } } \ No newline at end of file diff --git a/Product/LoyaltyProgramMember.schema.json b/Product/LoyaltyProgramMember.schema.json index 670e3f54..d9b913c7 100644 --- a/Product/LoyaltyProgramMember.schema.json +++ b/Product/LoyaltyProgramMember.schema.json @@ -1,40 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyProgramMember.schema.json", - "title": "LoyaltyProgramMember", - "definitions": { - "LoyaltyProgramMember": { - "id": "$LoyaltyProgramMember", - "description": "A person or group that opts in to a loyalty program.", - "type": "object", - "title": "LoyaltyProgramMember", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty program member." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty program member." - }, - "name": { - "type": "string", - "description": "The loyalty member’s name." - }, - "status": { - "type": "string", - "description": "A free-form field in which the member’s status may be captured, e.g. 'active', 'suspended', .etc." - }, - "ValidFor": { - "$ref": "../Common/TimePeriod.schema.json#/definitions/TimePeriod", - "description": "The period during which the loyalty member is valid for." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyProgramMember.schema.json", + "title": "LoyaltyProgramMember", + "definitions": { + "LoyaltyProgramMember": { + "$id": "#LoyaltyProgramMember", + "description": "A person or group that opts in to a loyalty program.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty program member." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty program member." + }, + "name": { + "type": "string", + "description": "The loyalty member’s name." + }, + "status": { + "type": "string", + "description": "A free-form field in which the member’s status may be captured, e.g. 'active', 'suspended', .etc." + }, + "ValidFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period during which the loyalty member is valid for." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Product/LoyaltyProgramMemberRef.schema.json b/Product/LoyaltyProgramMemberRef.schema.json index 8201cbed..c89e4e6a 100644 --- a/Product/LoyaltyProgramMemberRef.schema.json +++ b/Product/LoyaltyProgramMemberRef.schema.json @@ -1,28 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyProgramMemberRef.schema.json", - "title": "LoyaltyProgramMemberRef", - "definitions": { - "LoyaltyProgramMemberRef": { - "id": "LoyaltyProgramMemberRef", - "description": "Reference to a loyalty member.", - "type": "object", - "title": "LoyaltyProgramMemberRef", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty program member." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty program member." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyProgramMemberRef.schema.json", + "title": "LoyaltyProgramMemberRef", + "definitions": { + "LoyaltyProgramMemberRef": { + "$id": "#LoyaltyProgramMemberRef", + "description": "Reference to a loyalty member.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty program member." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty program member." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Product/LoyaltyProgramProduct.schema.json b/Product/LoyaltyProgramProduct.schema.json index 4a3fc821..829ef1e9 100644 --- a/Product/LoyaltyProgramProduct.schema.json +++ b/Product/LoyaltyProgramProduct.schema.json @@ -1,58 +1,57 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyProgramProduct.schema.json", - "title": "LoyaltyProgramProduct", - "definitions": { - "LoyaltyProgramProduct": { - "id": "$LoyaltyProgramProduct", - "description": "An instance of a loyalty program specification, linked to a specified loyalty member.", - "type": "object", - "title": "LoyaltyProgramProduct", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty program product." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty account." - }, - "name": { - "type": "string", - "description": "A word, term, or phrase by which the product is known and distinguished from other products." - }, - "description": { - "type": "string", - "description": "An explanation of what the product is." - }, - "productStatus": { - "type": "string", - "description": "The condition of the product, such as planned, designed, activated, disconnected." - }, - "characteristic": { - "type": "array", - "description": "Name value pairs of product characteristics.", - "items": { - "$ref": "Characteristic.schema.json#Characteristic" - } - }, - "loyaltyProgramProductSpec": { - "type": "object", - "$ref": "LoyaltyProgramProductSpecRef.schema.json#LoyaltyProgramProductSpecRef" - }, - "loyaltyAccount": { - "type": "object", - "$ref": "LoyaltyAccountRef.schema.json#LoyaltyAccountRef" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#/definitions/TimePeriod" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyProgramProduct.schema.json", + "title": "LoyaltyProgramProduct", + "definitions": { + "LoyaltyProgramProduct": { + "$id": "#LoyaltyProgramProduct", + "description": "An instance of a loyalty program specification, linked to a specified loyalty member.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty program product." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty account." + }, + "name": { + "type": "string", + "description": "A word, term, or phrase by which the product is known and distinguished from other products." + }, + "description": { + "type": "string", + "description": "An explanation of what the product is." + }, + "productStatus": { + "type": "string", + "description": "The condition of the product, such as planned, designed, activated, disconnected." + }, + "characteristic": { + "type": "array", + "description": "Name value pairs of product characteristics.", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "loyaltyProgramProductSpec": { + "type": "object", + "$ref": "LoyaltyProgramProductSpecRef.schema.json#LoyaltyProgramProductSpecRef" + }, + "loyaltyAccount": { + "type": "object", + "$ref": "LoyaltyAccountRef.schema.json#LoyaltyAccountRef" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Product/LoyaltyProgramProductRef.schema.json b/Product/LoyaltyProgramProductRef.schema.json index 1c9eaf8e..d83b628c 100644 --- a/Product/LoyaltyProgramProductRef.schema.json +++ b/Product/LoyaltyProgramProductRef.schema.json @@ -1,28 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyProgramProductRef.schema.json", - "title": "LoyaltyProgramProductRef", - "definitions": { - "LoyaltyProgramProductRef": { - "id": "$LoyaltyProgramProductRef", - "type": "object", - "description": "A reference to a loyalty product.", - "title": "LoyaltyProgramProductRef", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty program product." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty program product." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyProgramProductRef.schema.json", + "title": "LoyaltyProgramProductRef", + "definitions": { + "LoyaltyProgramProductRef": { + "$id": "#LoyaltyProgramProductRef", + "type": "object", + "description": "A reference to a loyalty product.", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty program product." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty program product." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Product/LoyaltyProgramProductSpec.schema.json b/Product/LoyaltyProgramProductSpec.schema.json index 4898cc0b..4bd34183 100644 --- a/Product/LoyaltyProgramProductSpec.schema.json +++ b/Product/LoyaltyProgramProductSpec.schema.json @@ -2,49 +2,48 @@ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "LoyaltyProgramProductSpec.schema.json", "title": "LoyaltyProgramProductSpec", - "definitions": { - "LoyaltyProgramProductSpec": { - "$id": "#LoyaltyProgramProductSpec", - "type": "object", - "description": "A reference to a loyalty program specification.", - "properties": { - "brand": { - "type": "string", - "description": "The manufacturer or trademark of the specification." - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the product specification is." - }, - "id": { - "type": "string", - "description": "Unique identifier for the product specification." - }, - "href": { - "type": "string", - "description": "A reference to the product specification." - }, - "lifeCycleStatus": { - "type": "string", - "description": "The condition of the product specification, such as active, inactive, planned." - }, - "name": { - "type": "string", - "description": "The name of the product specification." - }, - "needsLoyaltyAccount": { - "type": "boolean", - "description": "A narrative that explains in detail what the product specification is." - }, - "productNumber": { - "type": "string", - "productNumber": "An identification number assigned to uniquely identify the specification." - }, - "ValidFor": { - "$ref": "../Common/TimePeriod.schema.json#/definitions/TimePeriod" - } - }, - "title": "LoyaltyProgramProductSpec" - } + "definitions": { + "LoyaltyProgramProductSpec": { + "$id": "#LoyaltyProgramProductSpec", + "type": "object", + "description": "A reference to a loyalty program specification.", + "properties": { + "brand": { + "type": "string", + "description": "The manufacturer or trademark of the specification." + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the product specification is." + }, + "id": { + "type": "string", + "description": "Unique identifier for the product specification." + }, + "href": { + "type": "string", + "description": "A reference to the product specification." + }, + "lifeCycleStatus": { + "type": "string", + "description": "The condition of the product specification, such as active, inactive, planned." + }, + "name": { + "type": "string", + "description": "The name of the product specification." + }, + "needsLoyaltyAccount": { + "type": "boolean", + "description": "A narrative that explains in detail what the product specification is." + }, + "productNumber": { + "type": "string", + "productNumber": "An identification number assigned to uniquely identify the specification." + }, + "ValidFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + } } + } + } } \ No newline at end of file diff --git a/Product/LoyaltyProgramProductSpecRef.schema.json b/Product/LoyaltyProgramProductSpecRef.schema.json index 3f8a38a1..171820c0 100644 --- a/Product/LoyaltyProgramProductSpecRef.schema.json +++ b/Product/LoyaltyProgramProductSpecRef.schema.json @@ -2,22 +2,21 @@ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "LoyaltyProgramProductSpecRef.schema.json", "title": "LoyaltyProgramProductSpecRef", - "definitions": { - "LoyaltyProgramProductSpecRef": { - "$id": "#LoyaltyProgramProductSpecRef", - "description": "A reference to a loyalty program specification.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the product specification." - }, - "href": { - "type": "string", - "description": "A reference to the product specification." - } - }, - "title": "LoyaltyProgramProductSpec" - } + "definitions": { + "LoyaltyProgramProductSpecRef": { + "$id": "#LoyaltyProgramProductSpecRef", + "description": "A reference to a loyalty program specification.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the product specification." + }, + "href": { + "type": "string", + "description": "A reference to the product specification." + } } + } + } } \ No newline at end of file diff --git a/Product/LoyaltyRule.schema.json b/Product/LoyaltyRule.schema.json index 563e97ca..dd7bb279 100644 --- a/Product/LoyaltyRule.schema.json +++ b/Product/LoyaltyRule.schema.json @@ -1,76 +1,75 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyRule.schema.json", - "title": "LoyaltyRule", - "definitions": { - "LoyaltyRule": { - "$id": "#LoyaltyRule", - "description": "Loyalty rule, containing conditions, event types and actions.", - "type": "object", - "title": "LoyaltyBalance", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty rule." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty rule." - }, - "isCNF": { - "type": "boolean", - "description": "Unit and value of the balance." - }, - "hasSubRules": { - "type": "boolean", - "description": "A Boolean attribute that signifies whether this loyalty rule has one or more sub-rules. Sub-rules are used to enforce a hierarchical nesting of rules, so that parent rules may control the execution and other semantics of sub-rules that they contain." - }, - "isMandatoryEvaluation": { - "type": "boolean", - "description": "A Boolean attribute that, if true, signifies that evaluation (and possibly action execution) of this entity is mandatory and must be attempted. If the Mandatory property value of this entity is false, then the evaluation of this entity is considered to be 'best effort' and may be ignored." - }, - "usage": { - "type": "string", - "description": "A free-form string attribute that recommends how this policy object should be used." - }, - "keywords": { - "type": "string", - "description": "A string attribute that defines a set of one or more keywords that a policy administrator may use to assist in characterizing or categorizing a policy object to facilitate search operations." - }, - "policyName": { - "type": "string", - "description": "A generic naming attribute that can be used to identify different policy entities." - }, - "commonName": { - "type": "string", - "description": "A user-friendly identifier of the loyalty rule." - }, - "description": { - "type": "string", - "description": "A free-form description of the rule." - }, - "loyaltyEventType": { - "type": "array", - "description": "References to linked event types.", - "items": { - "$ref": "LoyaltyEventTypeRef.schema.json#LoyaltyEventTypeRef" - } - }, - "loyaltyCondition": { - "type": "array", - "description": "References to linked conditions.", - "items": { - "$ref": "LoyaltyConditionRef.schema.json#LoyaltyConditionRef" - } - }, - "loyaltyAction": { - "type": "array", - "description": "References to linked actions.", - "items": { - "$ref": "LoyaltyActionRef.schema.json#LoyaltyActionRef" - } - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyRule.schema.json", + "title": "LoyaltyRule", + "definitions": { + "LoyaltyRule": { + "$id": "#LoyaltyRule", + "description": "Loyalty rule, containing conditions, event types and actions.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty rule." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty rule." + }, + "isCNF": { + "type": "boolean", + "description": "Unit and value of the balance." + }, + "hasSubRules": { + "type": "boolean", + "description": "A Boolean attribute that signifies whether this loyalty rule has one or more sub-rules. Sub-rules are used to enforce a hierarchical nesting of rules, so that parent rules may control the execution and other semantics of sub-rules that they contain." + }, + "isMandatoryEvaluation": { + "type": "boolean", + "description": "A Boolean attribute that, if true, signifies that evaluation (and possibly action execution) of this entity is mandatory and must be attempted. If the Mandatory property value of this entity is false, then the evaluation of this entity is considered to be 'best effort' and may be ignored." + }, + "usage": { + "type": "string", + "description": "A free-form string attribute that recommends how this policy object should be used." + }, + "keywords": { + "type": "string", + "description": "A string attribute that defines a set of one or more keywords that a policy administrator may use to assist in characterizing or categorizing a policy object to facilitate search operations." + }, + "policyName": { + "type": "string", + "description": "A generic naming attribute that can be used to identify different policy entities." + }, + "commonName": { + "type": "string", + "description": "A user-friendly identifier of the loyalty rule." + }, + "description": { + "type": "string", + "description": "A free-form description of the rule." + }, + "loyaltyEventType": { + "type": "array", + "description": "References to linked event types.", + "items": { + "$ref": "LoyaltyEventTypeRef.schema.json#LoyaltyEventTypeRef" + } + }, + "loyaltyCondition": { + "type": "array", + "description": "References to linked conditions.", + "items": { + "$ref": "LoyaltyConditionRef.schema.json#LoyaltyConditionRef" + } + }, + "loyaltyAction": { + "type": "array", + "description": "References to linked actions.", + "items": { + "$ref": "LoyaltyActionRef.schema.json#LoyaltyActionRef" + } } + } } + } } \ No newline at end of file diff --git a/Product/LoyaltyRuleAction.schema.json b/Product/LoyaltyRuleAction.schema.json index 5054740c..4c8f22fe 100644 --- a/Product/LoyaltyRuleAction.schema.json +++ b/Product/LoyaltyRuleAction.schema.json @@ -1,23 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyRuleAction.schema.json", - "title": "LoyaltyRuleAction", - "definitions": { - "LoyaltyRuleAction": { - "$id": "#LoyaltyRuleAction", - "description": "Resource containing a the ID of a action to link to a loyalty rule.", - "type": "object", - "title": "LoyaltyRuleAction", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty action." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty action." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyRuleAction.schema.json", + "title": "LoyaltyRuleAction", + "definitions": { + "LoyaltyRuleAction": { + "$id": "#LoyaltyRuleAction", + "description": "Resource containing a the ID of a action to link to a loyalty rule.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty action." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty action." } + } } + } } \ No newline at end of file diff --git a/Product/LoyaltyRuleCondition.schema.json b/Product/LoyaltyRuleCondition.schema.json index 6d90160c..b2668147 100644 --- a/Product/LoyaltyRuleCondition.schema.json +++ b/Product/LoyaltyRuleCondition.schema.json @@ -1,23 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyRuleCondition.schema.json", - "title": "LoyaltyRuleCondition", - "definitions": { - "LoyaltyRuleCondition": { - "$id": "#LoyaltyRuleCondition", - "description": "Resource containing a the ID of a condition to link to a loyalty rule.", - "type": "object", - "title": "LoyaltyRuleCondition", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty condition." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty condition." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyRuleCondition.schema.json", + "title": "LoyaltyRuleCondition", + "definitions": { + "LoyaltyRuleCondition": { + "$id": "#LoyaltyRuleCondition", + "description": "Resource containing a the ID of a condition to link to a loyalty rule.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty condition." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty condition." } + } } + } } \ No newline at end of file diff --git a/Product/LoyaltyRuleEventType.schema.json b/Product/LoyaltyRuleEventType.schema.json index 291f86eb..0d025da1 100644 --- a/Product/LoyaltyRuleEventType.schema.json +++ b/Product/LoyaltyRuleEventType.schema.json @@ -1,23 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyRuleEventType.schema.json", - "title": "LoyaltyRuleEventType", - "definitions": { - "LoyaltyRuleEventType": { - "$id": "#LoyaltyRuleEventType", - "description": "Resource containing a the ID of a event type to link to a loyalty rule.", - "type": "object", - "title": "LoyaltyRuleEventType", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty event type." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty event type." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyRuleEventType.schema.json", + "title": "LoyaltyRuleEventType", + "definitions": { + "LoyaltyRuleEventType": { + "$id": "#LoyaltyRuleEventType", + "description": "Resource containing a the ID of a event type to link to a loyalty rule.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty event type." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty event type." } + } } + } } \ No newline at end of file diff --git a/Product/NetworkProduct.schema.json b/Product/NetworkProduct.schema.json index 01ffd2ed..ce6017b2 100644 --- a/Product/NetworkProduct.schema.json +++ b/Product/NetworkProduct.schema.json @@ -1,49 +1,49 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "NetworkProduct.schema.json", - "title": "NetworkProduct", - "definitions": { - "NetworkProduct": { - "$id": "#NetworkProduct", - "type": "object", - "description": "An instantiated network product (specialization of a product) subscribed by a customer.", - "properties": { - "href": { - "type": "string", - "description": "Reference to the network product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the network product" - }, - "name": { - "type": "string", - "description": "Network product name" - }, - "outOfBucketCounter": { - "type": "array", - "description": "Counters detailing usage consumption out of the buckets", - "items": { - "$ref": "ConsumptionSummary.schema.json#ConsumptionSummary" - } - }, - "publicIdentifier": { - "type": "string", - "description": "Public number associated to the network product (msisdn number for mobile line for example)" - }, - "user": { - "type": "array", - "description": "References of the users of the network product", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "NetworkProduct.schema.json", + "title": "NetworkProduct", + "definitions": { + "NetworkProduct": { + "$id": "#NetworkProduct", + "type": "object", + "description": "An instantiated network product (specialization of a product) subscribed by a customer.", + "properties": { + "href": { + "type": "string", + "description": "Reference to the network product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the network product" + }, + "name": { + "type": "string", + "description": "Network product name" + }, + "outOfBucketCounter": { + "type": "array", + "description": "Counters detailing usage consumption out of the buckets", + "items": { + "$ref": "ConsumptionSummary.schema.json#ConsumptionSummary" + } + }, + "publicIdentifier": { + "type": "string", + "description": "Public number associated to the network product (msisdn number for mobile line for example)" + }, + "user": { + "type": "array", + "description": "References of the users of the network product", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/NetworkProductRef.schema.json b/Product/NetworkProductRef.schema.json index 55e556a1..01516aee 100644 --- a/Product/NetworkProductRef.schema.json +++ b/Product/NetworkProductRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "NetworkProductRef.schema.json", - "title": "NetworkProductRef", - "definitions": { - "NetworkProductRef": { - "$id": "#NetworkProductRef", - "type": "object", - "description": "Reference of a product", - "properties": { - "@referredType": { - "type": "string", - "description": "Generic attribute indicating the name of the class type of the referred resource entity" - }, - "href": { - "type": "string", - "description": "Reference to the network product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the network product" - }, - "name": { - "type": "string", - "description": "Network product name" - }, - "publicIdentifier": { - "type": "string", - "description": "Public number associated to the product (msisdn number for mobile line for example)" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "NetworkProductRef.schema.json", + "title": "NetworkProductRef", + "definitions": { + "NetworkProductRef": { + "$id": "#NetworkProductRef", + "type": "object", + "description": "Reference of a product", + "properties": { + "@referredType": { + "type": "string", + "description": "Generic attribute indicating the name of the class type of the referred resource entity" + }, + "href": { + "type": "string", + "description": "Reference to the network product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the network product" + }, + "name": { + "type": "string", + "description": "Network product name" + }, + "publicIdentifier": { + "type": "string", + "description": "Public number associated to the product (msisdn number for mobile line for example)" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/OrderStateType.schema.json b/Product/OrderStateType.schema.json index 769f15eb..44c1e225 100644 --- a/Product/OrderStateType.schema.json +++ b/Product/OrderStateType.schema.json @@ -1,25 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderStateType.schema.json", - "title": "OrderStateType", - "definitions": { - "OrderStateType": { - "$id": "#OrderStateType", - "type": "string", - "description": "Possible values for the state of the order", - "enum": [ - "acknowledged", - "rejected", - "pending", - "held", - "inProgress", - "cancelled", - "completed", - "failed", - "partial", - "assessingCancellation", - "pendingCancellation" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderStateType.schema.json", + "title": "OrderStateType", + "definitions": { + "OrderStateType": { + "$id": "#OrderStateType", + "type": "string", + "description": "Possible values for the state of the order", + "enum": [ + "acknowledged", + "rejected", + "pending", + "held", + "inProgress", + "cancelled", + "completed", + "failed", + "partial", + "assessingCancellation", + "pendingCancellation" + ] } -} + } +} \ No newline at end of file diff --git a/Product/PriceAlteration.schema.json b/Product/PriceAlteration.schema.json index e8185d6c..747a86b3 100644 --- a/Product/PriceAlteration.schema.json +++ b/Product/PriceAlteration.schema.json @@ -1,54 +1,57 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PriceAlteration.schema.json", - "title": "PriceAlteration", - "definitions": { - "PriceAlteration": { - "$id": "#PriceAlteration", - "description": "Is an amount, usually of money, that modifies the price charged for an order item.", - "type": "object", - "required": ["priceType","price"], - "properties": { - "applicationDuration": { - "type": "integer", - "description": "Duration during which the alteration applies on the order item price (for instance 2 months free of charge for the recurring charge)" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail the semantics of this order item price alteration" - }, - "name": { - "type": "string", - "description": "Name of the order item price alteration" - }, - "productOfferingPrice": { - "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" - }, - "priceType": { - "type": "string", - "description": "A category that describes the price such as recurring, one time and usage." - }, - "priority": { - "type": "integer", - "description": "Priority level for applying this alteration among all the defined alterations on the order item price" - }, - "recurringChargePeriod": { - "type": "string", - "description": "Could be month, week..." - }, - "unitOfMeasure": { - "type": "string", - "description": "Could be minutes, GB..." - }, - "price": { - "$ref": "Price.schema.json#Price" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PriceAlteration.schema.json", + "title": "PriceAlteration", + "definitions": { + "PriceAlteration": { + "$id": "#PriceAlteration", + "description": "Is an amount, usually of money, that modifies the price charged for an order item.", + "type": "object", + "required": [ + "priceType", + "price" + ], + "properties": { + "applicationDuration": { + "type": "integer", + "description": "Duration during which the alteration applies on the order item price (for instance 2 months free of charge for the recurring charge)" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail the semantics of this order item price alteration" + }, + "name": { + "type": "string", + "description": "Name of the order item price alteration" + }, + "productOfferingPrice": { + "$ref": "ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" + }, + "priceType": { + "type": "string", + "description": "A category that describes the price such as recurring, one time and usage." + }, + "priority": { + "type": "integer", + "description": "Priority level for applying this alteration among all the defined alterations on the order item price" + }, + "recurringChargePeriod": { + "type": "string", + "description": "Could be month, week..." + }, + "unitOfMeasure": { + "type": "string", + "description": "Could be minutes, GB..." + }, + "price": { + "$ref": "../Customer/Price.schema.json#Price" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/PricingLogicAlgorithm.schema.json b/Product/PricingLogicAlgorithm.schema.json index 636f2741..61af5f22 100644 --- a/Product/PricingLogicAlgorithm.schema.json +++ b/Product/PricingLogicAlgorithm.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PricingLogicAlgorithm.schema.json", - "title": "PricingLogicAlgorithm", - "definitions": { - "PricingLogicAlgorithm": { - "$id": "#PricingLogicAlgorithm", - "type": "object", - "description": "The PricingLogicAlgorithm entity represents an instantiation of an interface specification to external rating function (without a modeled bahavior in SID). Some of the parameters of the interface definiition may be already set (such as price per unit) and some may be gathered during the rating process from the event (such as call duration) or from ProductCharacteristicValues (such as assigned bandwidth)", - "properties": { - "description": { - "type": "string", - "description": "Description of the PricingLogicAlgorithm" - }, - "href": { - "type": "string", - "description": "hyperlink reference of this PricingLogicAlgorithm" - }, - "id": { - "type": "string", - "description": "unique id of the PricingLogicAlgorithm" - }, - "name": { - "type": "string", - "description": "Name given to the PricingLogicAlgorithm" - }, - "plaSpecId": { - "type": "string", - "description": "id of corresponding PricingLogicAlgorithm specification" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the PricingLogicAlgorithm is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PricingLogicAlgorithm.schema.json", + "title": "PricingLogicAlgorithm", + "definitions": { + "PricingLogicAlgorithm": { + "$id": "#PricingLogicAlgorithm", + "type": "object", + "description": "The PricingLogicAlgorithm entity represents an instantiation of an interface specification to external rating function (without a modeled bahavior in SID). Some of the parameters of the interface definiition may be already set (such as price per unit) and some may be gathered during the rating process from the event (such as call duration) or from ProductCharacteristicValues (such as assigned bandwidth)", + "properties": { + "description": { + "type": "string", + "description": "Description of the PricingLogicAlgorithm" + }, + "href": { + "type": "string", + "description": "hyperlink reference of this PricingLogicAlgorithm" + }, + "id": { + "type": "string", + "description": "unique id of the PricingLogicAlgorithm" + }, + "name": { + "type": "string", + "description": "Name given to the PricingLogicAlgorithm" + }, + "plaSpecId": { + "type": "string", + "description": "id of corresponding PricingLogicAlgorithm specification" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the PricingLogicAlgorithm is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/Product.schema.json b/Product/Product.schema.json index 96f9ec8a..fd13fb2b 100644 --- a/Product/Product.schema.json +++ b/Product/Product.schema.json @@ -1,140 +1,141 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Product.schema.json", - "title": "Product", - "definitions": { - "Product": { - "type": "object", - "description": "A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service(s) and / or resource(s).", - "properties": { - "agreement": { - "type": "array", - "items": { - "$ref": "AgreementItemRef.schema.json#/definitions/AgreementItemRef" - } - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#/definitions/BillingAccountRef" - }, - "description": { - "type": "string", - "description": "Is the description of the product. It could be copied from the description of the Product Offering." - }, - "href": { - "type": "string", - "description": "Reference of the product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product" - }, - "isBundle": { - "type": "boolean", - "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." - }, - "isCustomerVisible": { - "type": "boolean", - "description": "If true, the product is visible by the customer." - }, - "name": { - "type": "string", - "description": "Name of the product. It could be the same as the name of the product offering" - }, - "orderDate": { - "type": "string", - "format": "date-time", - "description": "Is the date when the product was ordered" - }, - "productCharacteristic": { - "type": "array", - "items": { - "$ref": "Characteristic.schema.json#/definitions/Characteristic" - } - }, - "productOffering": { - "$ref": "ProductOfferingRef.schema.json#/definitions/ProductOfferingRef" - }, - "productOrderItem": { - "type": "array", - "items": { - "$ref": "RelatedProductOrderItem.schema.json#/definitions/RelatedProductOrderItem" - } - }, - "product": { - "type": "array", - "items": { - "$ref": "ProductRefOrValue.schema.json#/definitions/ProductRefOrValue" - } - }, - "productPrice": { - "type": "array", - "items": { - "$ref": "ProductPrice.schema.json#/definitions/ProductPrice" - } - }, - "productRelationship": { - "type": "array", - "items": { - "$ref": "ProductRelationship.schema.json#/definitions/ProductRelationship" - } - }, - "productSerialNumber": { - "type": "string", - "description": "Is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router." - }, - "productSpecification": { - "$ref": "ProductSpecificationRef.schema.json#/definitions/ProductSpecificationRef" - }, - "productTerm": { - "type": "array", - "items": { - "$ref": "ProductTerm.schema.json#/definitions/ProductTerm" - } - }, - "realizingResource": { - "type": "array", - "items": { - "$ref": "ResourceRef.schema.json#/definitions/ResourceRef" - } - }, - "realizingService": { - "type": "array", - "items": { - "$ref": "ServiceRef.schema.json#/definitions/ServiceRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#/definitions/RelatedParty" - } - }, - "place": { - "type": "array", - "items": { - "$ref": "RelatedPlaceRefOrValue.schema.json#/definitions/RelatedPlaceRefOrValue" - } - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "Is the date from which the product starts" - }, - "status": { - "$ref": "ProductStatusType.schema.json#/definitions/ProductStatusType", - "description": "Is the lifecycle status of the product." - }, - "terminationDate": { - "type": "string", - "format": "date-time", - "description": "Is the date when the product was terminated" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#/Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Product.schema.json", + "title": "Product", + "definitions": { + "Product": { + "$id": "#Product", + "type": "object", + "description": "A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service(s) and / or resource(s).", + "properties": { + "agreement": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementItemRef.schema.json#AgreementItemRef" + } + }, + "billingAccount": { + "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" + }, + "description": { + "type": "string", + "description": "Is the description of the product. It could be copied from the description of the Product Offering." + }, + "href": { + "type": "string", + "description": "Reference of the product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product" + }, + "isBundle": { + "type": "boolean", + "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." + }, + "isCustomerVisible": { + "type": "boolean", + "description": "If true, the product is visible by the customer." + }, + "name": { + "type": "string", + "description": "Name of the product. It could be the same as the name of the product offering" + }, + "orderDate": { + "type": "string", + "format": "date-time", + "description": "Is the date when the product was ordered" + }, + "productCharacteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "productOffering": { + "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "productOrderItem": { + "type": "array", + "items": { + "$ref": "RelatedProductOrderItem.schema.json#RelatedProductOrderItem" + } + }, + "product": { + "type": "array", + "items": { + "$ref": "ProductRefOrValue.schema.json#ProductRefOrValue" + } + }, + "productPrice": { + "type": "array", + "items": { + "$ref": "ProductPrice.schema.json#ProductPrice" + } + }, + "productRelationship": { + "type": "array", + "items": { + "$ref": "ProductRelationship.schema.json#ProductRelationship" + } + }, + "productSerialNumber": { + "type": "string", + "description": "Is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router." + }, + "productSpecification": { + "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef" + }, + "productTerm": { + "type": "array", + "items": { + "$ref": "ProductTerm.schema.json#ProductTerm" + } + }, + "realizingResource": { + "type": "array", + "items": { + "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" + } + }, + "realizingService": { + "type": "array", + "items": { + "$ref": "../Service/ServiceRef.schema.json#ServiceRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "place": { + "type": "array", + "items": { + "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" + } + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "Is the date from which the product starts" + }, + "status": { + "$ref": "ProductStatusType.schema.json#ProductStatusType", + "description": "Is the lifecycle status of the product." + }, + "terminationDate": { + "type": "string", + "format": "date-time", + "description": "Is the date when the product was terminated" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Product/ProductActionType.schema.json b/Product/ProductActionType.schema.json index 0693e373..728d5ad1 100644 --- a/Product/ProductActionType.schema.json +++ b/Product/ProductActionType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductActionType.schema.json", - "title": "ProductActionType", - "definitions": { - "ProductActionType": { - "$id": "#ProductActionType", - "description": "action to be performed on the product", - "type": "string", - "enum": [ - "add", - "modify", - "delete", - "noChange" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductActionType.schema.json", + "title": "ProductActionType", + "definitions": { + "ProductActionType": { + "$id": "#ProductActionType", + "description": "action to be performed on the product", + "type": "string", + "enum": [ + "add", + "modify", + "delete", + "noChange" + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductCharacteristic.schema.json b/Product/ProductCharacteristic.schema.json index e63cd3b0..71ee1d96 100644 --- a/Product/ProductCharacteristic.schema.json +++ b/Product/ProductCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductCharacteristic.schema.json", - "title": "ProductCharacteristic", - "definitions": { - "ProductCharacteristic": { - "$id": "#ProductCharacteristic", - "description": "Characteristics of the product to instantiate or to modify", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "value": { - "type": "string", - "description": "Value of the characteristic" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductCharacteristic.schema.json", + "title": "ProductCharacteristic", + "definitions": { + "ProductCharacteristic": { + "$id": "#ProductCharacteristic", + "description": "Characteristics of the product to instantiate or to modify", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "value": { + "type": "string", + "description": "Value of the characteristic" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductInventoryRelationship.schema.json b/Product/ProductInventoryRelationship.schema.json index 055e0a6e..3b0c6e2e 100644 --- a/Product/ProductInventoryRelationship.schema.json +++ b/Product/ProductInventoryRelationship.schema.json @@ -1,27 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductInventoryRelationship.schema.json", - "title": "ProductInventoryRelationship", - "definitions": { - "ProductInventoryRelationship": { - "$id": "#ProductInventoryRelationship", - "description": "Linked products to the one instantiate, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful", - "type": "object", - "required": ["relationshipType", "product"], - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of the product relationship, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful" - }, - "product": { - "$ref": "ProductRef.schema.json#ProductRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductInventoryRelationship.schema.json", + "title": "ProductInventoryRelationship", + "definitions": { + "ProductInventoryRelationship": { + "$id": "#ProductInventoryRelationship", + "description": "Linked products to the one instantiate, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful", + "type": "object", + "required": [ + "relationshipType", + "product" + ], + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of the product relationship, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful" + }, + "product": { + "$ref": "ProductRef.schema.json#ProductRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductOffering.schema.json b/Product/ProductOffering.schema.json index d5b6db46..e9092108 100644 --- a/Product/ProductOffering.schema.json +++ b/Product/ProductOffering.schema.json @@ -1,150 +1,150 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOffering.schema.json", - "title": "ProductOffering", - "definitions": { - "ProductOffering": { - "$id": "#ProductOffering", - "description": "Represents entities that are orderable from the provider of the catalog, this resource includes pricing information.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the productOffering" - }, - "href": { - "type": "string", - "description": "Reference of the ProductOffering" - }, - "id": { - "type": "string", - "description": "Unique identifier of the productOffering" - }, - "isBundle": { - "type": "boolean", - "description": "isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true)." - }, - "isSellable": { - "type": "boolean", - "description": "A flag indicating if this product offer can be sold stand-alone for sale or not. If this flag is false it indicates that the offer can only be sold within a bundle." - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the productOffering" - }, - "statusReason": { - "type": "string", - "description": "A string providing a complementary information on the value of the lifecycle status attribute." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productOffering is valid" - }, - "version": { - "type": "string", - "description": "ProductOffering version" - }, - "place": { - "type": "array", - "items": { - "$ref": "../Common/PlaceRef.schema.json#PlaceRef" - }, - "description": "Place defines the places where the products are sold or delivered." - }, - "serviceLevelAgreement": { - "$ref": "../EngagedParty/SLARef.schema.json#SLARef", - "description": "A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so forth. The SLA is a set of appropriate procedures and targets formally or informally agreed between parties in order to achieve and maintain specified Quality of Service." - }, - "productSpecification": { - "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef", - "description": "A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role." - }, - "channel": { - "type": "array", - "items": { - "$ref": "../Common/ChannelRef.schema.json#ChannelRef" - }, - "description": "The channel defines the channel for selling product offerings." - }, - "serviceCandidate": { - "$ref": "../Service/ServiceCandidateRef.schema.json#ServiceCandidateRef", - "description": "ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog." - }, - "category": { - "type": "array", - "items": { - "$ref": "CategoryRef.schema.json#CategoryRef" - }, - "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates." - }, - "resourceCandidate": { - "$ref": "../Resource/ResourceCandidateRef.schema.json#ResourceCandidateRef", - "description": "A resource candidate is an entity that makes a ResourceSpecification available to a catalog." - }, - "productOfferingTerm": { - "type": "array", - "items": { - "$ref": "ProductOfferingTerm.schema.json#ProductOfferingTerm" - }, - "description": "A condition under which a ProductOffering is made available to Customers. For instance, a productOffering can be offered with multiple commitment periods." - }, - "productOfferingPrice": { - "type": "array", - "items": { - "$ref": "ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" - }, - "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time and may not represent the actual price paid by a customer." - }, - "agreement": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" - }, - "description": "An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications." - }, - "attachment": { - "type": "array", - "items": { - "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" - }, - "description": "Complements the description of an element (for instance a product) through video, pictures..." - }, - "marketSegment": { - "type": "array", - "items": { - "$ref": "../MarketingSales/MarketSegmentRef.schema.json#MarketSegmentRef" - }, - "description": "provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth." - }, - "bundledProductOffering": { - "type": "array", - "items": { - "$ref": "BundledProductOffering.schema.json#BundledProductOffering" - }, - "description": "A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering." - }, - "prodSpecCharValueUse": { - "type": "array", - "items": { - "$ref": "ProductSpecificationCharacteristicValueUse.schema.json#ProductSpecificationCharacteristicValueUse" - }, - "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOffering.schema.json", + "title": "ProductOffering", + "definitions": { + "ProductOffering": { + "$id": "#ProductOffering", + "description": "Represents entities that are orderable from the provider of the catalog, this resource includes pricing information.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the productOffering" + }, + "href": { + "type": "string", + "description": "Reference of the ProductOffering" + }, + "id": { + "type": "string", + "description": "Unique identifier of the productOffering" + }, + "isBundle": { + "type": "boolean", + "description": "isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true)." + }, + "isSellable": { + "type": "boolean", + "description": "A flag indicating if this product offer can be sold stand-alone for sale or not. If this flag is false it indicates that the offer can only be sold within a bundle." + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the productOffering" + }, + "statusReason": { + "type": "string", + "description": "A string providing a complementary information on the value of the lifecycle status attribute." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productOffering is valid" + }, + "version": { + "type": "string", + "description": "ProductOffering version" + }, + "place": { + "type": "array", + "items": { + "$ref": "../Common/PlaceRef.schema.json#PlaceRef" + }, + "description": "Place defines the places where the products are sold or delivered." + }, + "serviceLevelAgreement": { + "$ref": "../EngagedParty/SLARef.schema.json#SLARef", + "description": "A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so forth. The SLA is a set of appropriate procedures and targets formally or informally agreed between parties in order to achieve and maintain specified Quality of Service." + }, + "productSpecification": { + "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef", + "description": "A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role." + }, + "channel": { + "type": "array", + "items": { + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "description": "The channel defines the channel for selling product offerings." + }, + "serviceCandidate": { + "$ref": "../Service/ServiceCandidateRef.schema.json#ServiceCandidateRef", + "description": "ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog." + }, + "category": { + "type": "array", + "items": { + "$ref": "CategoryRef.schema.json#CategoryRef" + }, + "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates." + }, + "resourceCandidate": { + "$ref": "../Resource/ResourceCandidateRef.schema.json#ResourceCandidateRef", + "description": "A resource candidate is an entity that makes a ResourceSpecification available to a catalog." + }, + "productOfferingTerm": { + "type": "array", + "items": { + "$ref": "ProductOfferingTerm.schema.json#ProductOfferingTerm" + }, + "description": "A condition under which a ProductOffering is made available to Customers. For instance, a productOffering can be offered with multiple commitment periods." + }, + "productOfferingPrice": { + "type": "array", + "items": { + "$ref": "ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" + }, + "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time and may not represent the actual price paid by a customer." + }, + "agreement": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" + }, + "description": "An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications." + }, + "attachment": { + "type": "array", + "items": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + }, + "description": "Complements the description of an element (for instance a product) through video, pictures..." + }, + "marketSegment": { + "type": "array", + "items": { + "$ref": "../MarketingSales/MarketSegmentRef.schema.json#MarketSegmentRef" + }, + "description": "provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth." + }, + "bundledProductOffering": { + "type": "array", + "items": { + "$ref": "BundledProductOffering.schema.json#BundledProductOffering" + }, + "description": "A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering." + }, + "prodSpecCharValueUse": { + "type": "array", + "items": { + "$ref": "ProductSpecificationCharacteristicValueUse.schema.json#ProductSpecificationCharacteristicValueUse" + }, + "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductOfferingPrice.schema.json b/Product/ProductOfferingPrice.schema.json index d2f96a0b..507cba64 100644 --- a/Product/ProductOfferingPrice.schema.json +++ b/Product/ProductOfferingPrice.schema.json @@ -1,149 +1,149 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingPrice.schema.json", - "title": "ProductOfferingPrice", - "definitions": { - "ProductOfferingPrice": { - "$id": "#ProductOfferingPrice", - "description": "Is based on both the basic cost to develop and produce products and the enterprises policy on revenue targets. This price may be further revised through discounting (productOfferPriceAlteration). The price, applied for a productOffering may also be influenced by the productOfferingTerm, the customer selected, eg: a productOffering can be offered with multiple terms, like commitment periods for the contract. The price may be influenced by this productOfferingTerm. A productOffering may be cheaper with a 24 month commitment than with a 12 month commitment.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "unique id of this resource" - }, - "href": { - "type": "string", - "description": "Reference of the ProductOfferingPrice" - }, - "name": { - "type": "string", - "description": "Name of the productOfferingPrice" - }, - "description": { - "type": "string", - "description": "Description of the productOfferingPrice" - }, - "version": { - "type": "string", - "description": "ProductOffering version" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productOfferingPrice is valid" - }, - "priceType": { - "type": "string", - "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth." - }, - "unitOfMeasure": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "A number and unit representing how many (for instance 1 dozen) of an ProductOffering is available at the offered price. Its meaning depends on the priceType. It could be a price, a rate, or a discount." - }, - "recurringChargePeriodType": { - "type": "string", - "description": "The period to repeat the application of the price\nCould be month, week..." - }, - "recurringChargePeriodLength": { - "type": "integer", - "description": "the period of the recurring charge: 1, 2, ... .It sets to zero if it is not applicable" - }, - "@type": { - "type": "string", - "description": "The class type of this Product offering" - }, - "@baseType": { - "type": "string", - "description": "the immediate base class type of this product offering" - }, - "@schemaLocation": { - "type": "string", - "description": "hyperlink reference to the schema describing this resource" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "the last update time of this ProductOfferingPrice" - }, - "isBundle": { - "type": "boolean", - "description": "A flag indicating if this ProductOfferingPrice is composite (bundle) or not" - }, - "lifecycleStatus": { - "type": "string", - "description": "the lifecycle status of this ProductOfferingPrice" - }, - "price": { - "$ref": "../Common/Money.schema.json#Money", - "description": "The amount of money that characterizes the price." - }, - "percentage": { - "type": "number", - "format": "float", - "description": "Percentage to apply for ProductOfferPriceAlteration (Discount)" - }, - "bundledPopRelationship": { - "type": "array", - "items": { - "$ref": "BundledProductOfferingPriceRelationship.schema.json#BundledProductOfferingPriceRelationship" - }, - "description": "this object represents a bundle relationship from a bundle product offering price (parent) to a simple product offering price (child). A simple product offering price may participate in more than one bundle relationship." - }, - "popRelationship": { - "type": "array", - "items": { - "$ref": "ProductOfferingPriceRelationship.schema.json#ProductOfferingPriceRelationship" - }, - "description": "Product Offering Prices related to this Product Offering Price, for example a price alteration such as allowance or discount" - }, - "prodSpecCharValueUse": { - "type": "array", - "items": { - "$ref": "ProductSpecificationCharacteristicValueUse.schema.json#ProductSpecificationCharacteristicValueUse" - }, - "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOfferingPrice to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering and ProcuctOfferingPrice level. The list of values in ProductSpecificationCharacteristicValueUse is a strict subset of the list of values as defined in the corresponding product specification characteristics." - }, - "productOfferingTerm": { - "type": "array", - "items": { - "$ref": "ProductOfferingTerm.schema.json#ProductOfferingTerm" - }, - "description": "A list of conditions under which a ProductOfferingPrice is made available to Customers. For instance, a Product Offering Price can be offered with multiple commitment periods." - }, - "place": { - "type": "array", - "items": { - "$ref": "../Common/PlaceRef.schema.json#PlaceRef" - }, - "description": "Place defines the places where the products are sold or delivered." - }, - "constraint": { - "type": "array", - "items": { - "$ref": "../Common/ConstraintRef.schema.json#ConstraintRef" - }, - "description": "The Constraint resource represents a policy/rule applied to ProductOfferingPrice." - }, - "pricingLogicAlgorithm": { - "type": "array", - "items": { - "$ref": "PricingLogicAlgorithm.schema.json#PricingLogicAlgorithm" - }, - "description": "The PricingLogicAlgorithm entity represents an instantiation of an interface specification to external rating function (without a modeled behavior in SID). Some of the parameters of the interface definition may be already set (such as price per unit) and some may be gathered during the rating process from the event (such as call duration) or from ProductCharacteristicValues (such as assigned bandwidth)." - }, - "tax": { - "type": "array", - "items": { - "$ref": "../Customer/TaxItem.schema.json#TaxItem" - }, - "description": "An amount of money levied on the price of a Product by a legislative body." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingPrice.schema.json", + "title": "ProductOfferingPrice", + "definitions": { + "ProductOfferingPrice": { + "$id": "#ProductOfferingPrice", + "description": "Is based on both the basic cost to develop and produce products and the enterprises policy on revenue targets. This price may be further revised through discounting (productOfferPriceAlteration). The price, applied for a productOffering may also be influenced by the productOfferingTerm, the customer selected, eg: a productOffering can be offered with multiple terms, like commitment periods for the contract. The price may be influenced by this productOfferingTerm. A productOffering may be cheaper with a 24 month commitment than with a 12 month commitment.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "unique id of this resource" + }, + "href": { + "type": "string", + "description": "Reference of the ProductOfferingPrice" + }, + "name": { + "type": "string", + "description": "Name of the productOfferingPrice" + }, + "description": { + "type": "string", + "description": "Description of the productOfferingPrice" + }, + "version": { + "type": "string", + "description": "ProductOffering version" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productOfferingPrice is valid" + }, + "priceType": { + "type": "string", + "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth." + }, + "unitOfMeasure": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "A number and unit representing how many (for instance 1 dozen) of an ProductOffering is available at the offered price. Its meaning depends on the priceType. It could be a price, a rate, or a discount." + }, + "recurringChargePeriodType": { + "type": "string", + "description": "The period to repeat the application of the price\nCould be month, week..." + }, + "recurringChargePeriodLength": { + "type": "integer", + "description": "the period of the recurring charge: 1, 2, ... .It sets to zero if it is not applicable" + }, + "@type": { + "type": "string", + "description": "The class type of this Product offering" + }, + "@baseType": { + "type": "string", + "description": "the immediate base class type of this product offering" + }, + "@schemaLocation": { + "type": "string", + "description": "hyperlink reference to the schema describing this resource" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "the last update time of this ProductOfferingPrice" + }, + "isBundle": { + "type": "boolean", + "description": "A flag indicating if this ProductOfferingPrice is composite (bundle) or not" + }, + "lifecycleStatus": { + "type": "string", + "description": "the lifecycle status of this ProductOfferingPrice" + }, + "price": { + "$ref": "../Common/Money.schema.json#Money", + "description": "The amount of money that characterizes the price." + }, + "percentage": { + "type": "number", + "format": "float", + "description": "Percentage to apply for ProductOfferPriceAlteration (Discount)" + }, + "bundledPopRelationship": { + "type": "array", + "items": { + "$ref": "BundledProductOfferingPriceRelationship.schema.json#BundledProductOfferingPriceRelationship" + }, + "description": "this object represents a bundle relationship from a bundle product offering price (parent) to a simple product offering price (child). A simple product offering price may participate in more than one bundle relationship." + }, + "popRelationship": { + "type": "array", + "items": { + "$ref": "ProductOfferingPriceRelationship.schema.json#ProductOfferingPriceRelationship" + }, + "description": "Product Offering Prices related to this Product Offering Price, for example a price alteration such as allowance or discount" + }, + "prodSpecCharValueUse": { + "type": "array", + "items": { + "$ref": "ProductSpecificationCharacteristicValueUse.schema.json#ProductSpecificationCharacteristicValueUse" + }, + "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOfferingPrice to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering and ProcuctOfferingPrice level. The list of values in ProductSpecificationCharacteristicValueUse is a strict subset of the list of values as defined in the corresponding product specification characteristics." + }, + "productOfferingTerm": { + "type": "array", + "items": { + "$ref": "ProductOfferingTerm.schema.json#ProductOfferingTerm" + }, + "description": "A list of conditions under which a ProductOfferingPrice is made available to Customers. For instance, a Product Offering Price can be offered with multiple commitment periods." + }, + "place": { + "type": "array", + "items": { + "$ref": "../Common/PlaceRef.schema.json#PlaceRef" + }, + "description": "Place defines the places where the products are sold or delivered." + }, + "constraint": { + "type": "array", + "items": { + "$ref": "../Common/ConstraintRef.schema.json#ConstraintRef" + }, + "description": "The Constraint resource represents a policy/rule applied to ProductOfferingPrice." + }, + "pricingLogicAlgorithm": { + "type": "array", + "items": { + "$ref": "PricingLogicAlgorithm.schema.json#PricingLogicAlgorithm" + }, + "description": "The PricingLogicAlgorithm entity represents an instantiation of an interface specification to external rating function (without a modeled behavior in SID). Some of the parameters of the interface definition may be already set (such as price per unit) and some may be gathered during the rating process from the event (such as call duration) or from ProductCharacteristicValues (such as assigned bandwidth)." + }, + "tax": { + "type": "array", + "items": { + "$ref": "../Customer/TaxItem.schema.json#TaxItem" + }, + "description": "An amount of money levied on the price of a Product by a legislative body." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductOfferingPriceRef.schema.json b/Product/ProductOfferingPriceRef.schema.json index a321d00e..1b5dd09c 100644 --- a/Product/ProductOfferingPriceRef.schema.json +++ b/Product/ProductOfferingPriceRef.schema.json @@ -1,19 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingPriceRef.schema.json", - "title": "ProductOfferingPriceRef", - "definitions": { - "ProductOfferingPriceRef": { - "$id": "#ProductOfferingPriceRef", - "description": "ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased", - "type": "object", - "properties": { - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingPriceRef.schema.json", + "title": "ProductOfferingPriceRef", + "definitions": { + "ProductOfferingPriceRef": { + "$id": "#ProductOfferingPriceRef", + "description": "ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductOfferingPriceRelationship.schema.json b/Product/ProductOfferingPriceRelationship.schema.json index 7725672b..dd7590f9 100644 --- a/Product/ProductOfferingPriceRelationship.schema.json +++ b/Product/ProductOfferingPriceRelationship.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingPriceRelationship.schema.json", - "title": "ProductOfferingPriceRelationship", - "definitions": { - "ProductOfferingPriceRelationship": { - "$id": "#ProductOfferingPriceRelationship", - "type": "object", - "description": "Describes a non-composite relationship between product offering prices. For example one price might be an discount alteration for another price.", - "properties": { - "href": { - "type": "string", - "description": "hyperlink reference of the associated product offering price" - }, - "id": { - "type": "string", - "description": "Unique identifier of the associated product offering price" - }, - "name": { - "type": "string", - "description": "Name of the associated product offering price" - }, - "relationshipType": { - "type": "string", - "description": "type of the relationship, for example override, discount, etc." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingPriceRelationship.schema.json", + "title": "ProductOfferingPriceRelationship", + "definitions": { + "ProductOfferingPriceRelationship": { + "$id": "#ProductOfferingPriceRelationship", + "type": "object", + "description": "Describes a non-composite relationship between product offering prices. For example one price might be an discount alteration for another price.", + "properties": { + "href": { + "type": "string", + "description": "hyperlink reference of the associated product offering price" + }, + "id": { + "type": "string", + "description": "Unique identifier of the associated product offering price" + }, + "name": { + "type": "string", + "description": "Name of the associated product offering price" + }, + "relationshipType": { + "type": "string", + "description": "type of the relationship, for example override, discount, etc." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductOfferingQualification.schema.json b/Product/ProductOfferingQualification.schema.json index 90b46877..626f1a51 100644 --- a/Product/ProductOfferingQualification.schema.json +++ b/Product/ProductOfferingQualification.schema.json @@ -1,106 +1,109 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingQualification.schema.json", - "title": "ProductOfferingQualification", - "definitions": { - "ProductOfferingQualification": { - "type": "object", - "required": ["productOfferingQualificationItem"], - "description": "ProductOfferingQualification is used to perform a commercial eligibility. It allows to retrieve a list of productOffering that are commercially available in the context of the interaction (defined be place, channel, party, product).", - "properties": { - "channel": { - "description": "Channel used for the qualification", - "$ref": "ChannelRef.schema.json#/definitions/ChannelRef" - }, - "description": { - "type": "string", - "description": "Description of the productOfferingQualification" - }, - "effectiveQualificationDate": { - "type": "string", - "format": "date-time", - "description": "Effective date to productOfferingQualification completion" - }, - "expectedPOQCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Date when the requester expect to provide an answer for the qualification request" - }, - "expirationDate": { - "type": "string", - "format": "date-time", - "description": "Date the qualification response expires" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the productOfferingQualification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the productOfferingQualification resource" - }, - "instantSyncQualification": { - "type": "boolean", - "description": "An indicator which when the value is \"true\" means that requester expects to get qualifcation result immediately in the response. If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201." - }, - "note": { - "type": "array", - "description": "Free form text associated with the qualification request", - "items": { - "$ref": "Note.schema.json#/definitions/Note" - } - }, - "productOfferingQualificationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the productOfferingQualification has been submitted" - }, - "productOfferingQualificationItem": { - "type": "array", - "description": "Qualification item for a product or a category", - "items": { - "$ref": "ProductOfferingQualificationItem.schema.json#/definitions/ProductOfferingQualificationItem" - }, - "minItems": 1 - }, - "provideAlternative": { - "type": "boolean", - "description": "An indicator which when the value is \"true\" means that alternative solutions should be provided" - }, - "provideOnlyAvailable": { - "type": "boolean", - "description": "An indicator which when the value is \"true\" means that only available product offering must be listed in the response" - }, - "provideUnavailabilityReason": { - "type": "boolean", - "description": "An indicator which when the value is \"true\" means that unavailability reason are expected for non available product offering" - }, - "qualificationResult": { - "type": "string", - "description": "Result of the qualification (example: green, yellow, red)" - }, - "relatedParty": { - "type": "array", - "description": "Party playing a role for this qualification (as requester for example)", - "items": { - "$ref": "RelatedParty.schema.json#/definitions/RelatedParty" - } - }, - "requestedPOQCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Deadline date when the requester expected a qualification answer" - }, - "state": { - "$ref": "TaskStateType.schema.json#/definitions/TaskStateType", - "description": "State of the productOfferingQualification defined in the state engine" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#/Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingQualification.schema.json", + "title": "ProductOfferingQualification", + "definitions": { + "ProductOfferingQualification": { + "$id": "#ProductOfferingQualification", + "type": "object", + "required": [ + "productOfferingQualificationItem" + ], + "description": "ProductOfferingQualification is used to perform a commercial eligibility. It allows to retrieve a list of productOffering that are commercially available in the context of the interaction (defined be place, channel, party, product).", + "properties": { + "channel": { + "description": "Channel used for the qualification", + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "description": { + "type": "string", + "description": "Description of the productOfferingQualification" + }, + "effectiveQualificationDate": { + "type": "string", + "format": "date-time", + "description": "Effective date to productOfferingQualification completion" + }, + "expectedPOQCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Date when the requester expect to provide an answer for the qualification request" + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "Date the qualification response expires" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the productOfferingQualification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the productOfferingQualification resource" + }, + "instantSyncQualification": { + "type": "boolean", + "description": "An indicator which when the value is \"true\" means that requester expects to get qualifcation result immediately in the response. If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201." + }, + "note": { + "type": "array", + "description": "Free form text associated with the qualification request", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "productOfferingQualificationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the productOfferingQualification has been submitted" + }, + "productOfferingQualificationItem": { + "type": "array", + "description": "Qualification item for a product or a category", + "items": { + "$ref": "ProductOfferingQualificationItem.schema.json#ProductOfferingQualificationItem" + }, + "minItems": 1 + }, + "provideAlternative": { + "type": "boolean", + "description": "An indicator which when the value is \"true\" means that alternative solutions should be provided" + }, + "provideOnlyAvailable": { + "type": "boolean", + "description": "An indicator which when the value is \"true\" means that only available product offering must be listed in the response" + }, + "provideUnavailabilityReason": { + "type": "boolean", + "description": "An indicator which when the value is \"true\" means that unavailability reason are expected for non available product offering" + }, + "qualificationResult": { + "type": "string", + "description": "Result of the qualification (example: green, yellow, red)" + }, + "relatedParty": { + "type": "array", + "description": "Party playing a role for this qualification (as requester for example)", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "requestedPOQCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Deadline date when the requester expected a qualification answer" + }, + "state": { + "$ref": "../Common/TaskStateType.schema.json#TaskStateType", + "description": "State of the productOfferingQualification defined in the state engine" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Product/ProductOfferingQualificationItem.schema.json b/Product/ProductOfferingQualificationItem.schema.json index bd07ae72..db19d102 100644 --- a/Product/ProductOfferingQualificationItem.schema.json +++ b/Product/ProductOfferingQualificationItem.schema.json @@ -1,78 +1,78 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingQualificationItem.schema.json", - "title": "ProductOfferingQualificationItem", - "definitions": { - "ProductOfferingQualificationItem": { - "$id": "#ProductOfferingQualificationItem", - "type": "object", - "properties": { - "expectedActivationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the requester look for productOfferingQualification activation" - }, - "id": { - "type": "string", - "description": "Id of the productOfferingQualification item" - }, - "action": { - "description": "Can be \"add\" / \"modify\" / \"no_change\"/ \"delete\" - by default add is considered", - "$ref": "ProductActionType.schema.json#/definitions/ProductActionType" - }, - "qualificationItemResult": { - "type": "string", - "description": "Qualification result for this productOfferingQualification item. It could be:\n\n qualified (request productOffering or productSpecification are available), \n unqualified (requested not available and not alternate available),\n alternate (requested not available but proposal available)\n" - }, - "state": { - "description": "State of the productOfferingQualification item defined in the state engine", - "$ref": "TaskStateType.schema.json#/definitions/TaskStateType" - }, - "eligibilityUnavailabilityReason": { - "type": "array", - "items": { - "$ref": "../Product/EligibilityUnavailabilityReason.schema.json#EligibilityUnavailabilityReason" - } - }, - "category": { - "$ref": "CategoryRef.schema.json#CategoryRef" - }, - "qualificationItemRelationship": { - "type": "array", - "items": { - "$ref": "QualificationItemRelationship.schema.json#QualificationItemRelationship" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "product": { - "$ref": "ProductRefOrValue.schema.json#ProductRefOrValue" - }, - "terminationError": { - "type": "array", - "items": { - "$ref": "../Service/TerminationError.schema.json#TerminationError" - } - }, - "productOffering": { - "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "alternateProductOfferingProposal": { - "type": "array", - "items": { - "$ref": "AlternateProductOfferingProposal.schema.json#AlternateProductOfferingProposal" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingQualificationItem.schema.json", + "title": "ProductOfferingQualificationItem", + "definitions": { + "ProductOfferingQualificationItem": { + "$id": "#ProductOfferingQualificationItem", + "type": "object", + "properties": { + "expectedActivationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the requester look for productOfferingQualification activation" + }, + "id": { + "type": "string", + "description": "Id of the productOfferingQualification item" + }, + "action": { + "description": "Can be \"add\" / \"modify\" / \"no_change\"/ \"delete\" - by default add is considered", + "$ref": "ProductActionType.schema.json#ProductActionType" + }, + "qualificationItemResult": { + "type": "string", + "description": "Qualification result for this productOfferingQualification item. It could be:\n\n qualified (request productOffering or productSpecification are available), \n unqualified (requested not available and not alternate available),\n alternate (requested not available but proposal available)\n" + }, + "state": { + "description": "State of the productOfferingQualification item defined in the state engine", + "$ref": "../Common/TaskStateType.schema.json#TaskStateType" + }, + "eligibilityUnavailabilityReason": { + "type": "array", + "items": { + "$ref": "EligibilityUnavailabilityReason.schema.json#EligibilityUnavailabilityReason" + } + }, + "category": { + "$ref": "CategoryRef.schema.json#CategoryRef" + }, + "qualificationItemRelationship": { + "type": "array", + "items": { + "$ref": "QualificationItemRelationship.schema.json#QualificationItemRelationship" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "product": { + "$ref": "ProductRefOrValue.schema.json#ProductRefOrValue" + }, + "terminationError": { + "type": "array", + "items": { + "$ref": "../Service/TerminationError.schema.json#TerminationError" + } + }, + "productOffering": { + "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "alternateProductOfferingProposal": { + "type": "array", + "items": { + "$ref": "AlternateProductOfferingProposal.schema.json#AlternateProductOfferingProposal" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductOfferingQualificationItemRef.schema.json b/Product/ProductOfferingQualificationItemRef.schema.json index 84811564..4e2fd9f3 100644 --- a/Product/ProductOfferingQualificationItemRef.schema.json +++ b/Product/ProductOfferingQualificationItemRef.schema.json @@ -1,39 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingQualificationItemRef.schema.json", - "title": "ProductOfferingQualificationItemRef", - "definitions": { - "ProductOfferingQualificationItemRef": { - "type": "object", - "description": "It's a productOfferingQualification item that has been executed previously.", - "required": ["id", "productOfferingQualificationId"], - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "productOfferingQualificationHref": { - "type": "string", - "description": "Reference of the related entity." - }, - "productOfferingQualificationId": { - "type": "string", - "description": "Unique identifier of a related entity." - }, - "productOfferingQualificationName": { - "type": "string", - "description": "Name of the related entity." - }, - "id": { - "type": "string", - "description": "Id of an item of a product offering qualification" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#/Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingQualificationItemRef.schema.json", + "title": "ProductOfferingQualificationItemRef", + "definitions": { + "ProductOfferingQualificationItemRef": { + "$id": "#ProductOfferingQualificationItemRef", + "type": "object", + "description": "It's a productOfferingQualification item that has been executed previously.", + "required": [ + "id", + "productOfferingQualificationId" + ], + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "productOfferingQualificationHref": { + "type": "string", + "description": "Reference of the related entity." + }, + "productOfferingQualificationId": { + "type": "string", + "description": "Unique identifier of a related entity." + }, + "productOfferingQualificationName": { + "type": "string", + "description": "Name of the related entity." + }, + "id": { + "type": "string", + "description": "Id of an item of a product offering qualification" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Product/ProductOfferingQualificationRef.schema.json b/Product/ProductOfferingQualificationRef.schema.json index 41c1555b..1763bbc6 100644 --- a/Product/ProductOfferingQualificationRef.schema.json +++ b/Product/ProductOfferingQualificationRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingQualificationRef.schema.json", - "title": "ProductOfferingQualificationRef", - "definitions": { - "ProductOfferingQualificationRef": { - "type": "object", - "description": "It's a productOfferingQualification that has been executed previously", - "properties": { - }, - "allOf": [ - { - "$ref": "EntityRef.schema.json#/EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingQualificationRef.schema.json", + "title": "ProductOfferingQualificationRef", + "definitions": { + "ProductOfferingQualificationRef": { + "$id": "#ProductOfferingQualificationRef", + "type": "object", + "description": "It's a productOfferingQualification that has been executed previously", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductOfferingQualificationStateType.schema.json b/Product/ProductOfferingQualificationStateType.schema.json index 4aba5064..d4a07c6c 100644 --- a/Product/ProductOfferingQualificationStateType.schema.json +++ b/Product/ProductOfferingQualificationStateType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingQualificationStateType.schema.json", - "title": "ProductOfferingQualificationStateType", - "definitions": { - "ProductOfferingQualificationStateType": { - "$id": "#ProductOfferingQualificationStateType", - "type": "string", - "description": "Possible values for the state of the product offering qualification & item", - "enum": [ - "acknowledged", - "terminatedWithError", - "inProgress", - "done" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingQualificationStateType.schema.json", + "title": "ProductOfferingQualificationStateType", + "definitions": { + "ProductOfferingQualificationStateType": { + "$id": "#ProductOfferingQualificationStateType", + "type": "string", + "description": "Possible values for the state of the product offering qualification & item", + "enum": [ + "acknowledged", + "terminatedWithError", + "inProgress", + "done" + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductOfferingRef.schema.json b/Product/ProductOfferingRef.schema.json index 6ee7b1b3..ab8edd37 100644 --- a/Product/ProductOfferingRef.schema.json +++ b/Product/ProductOfferingRef.schema.json @@ -1,19 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingRef.schema.json", - "title": "ProductOfferingRef", - "definitions": { - "ProductOfferingRef": { - "$id": "#ProductOfferingRef", - "description": "ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.", - "type": "object", - "properties": { - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingRef.schema.json", + "title": "ProductOfferingRef", + "definitions": { + "ProductOfferingRef": { + "$id": "#ProductOfferingRef", + "description": "ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductOfferingTerm.schema.json b/Product/ProductOfferingTerm.schema.json index b2a3cd7a..3f2fe44e 100644 --- a/Product/ProductOfferingTerm.schema.json +++ b/Product/ProductOfferingTerm.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingTerm.schema.json", - "title": "ProductOfferingTerm", - "definitions": { - "ProductOfferingTerm": { - "$id": "#ProductOfferingTerm", - "description": "A condition under which a ProductOffering is made available to Customers. For instance, a productOffering can be offered with multiple commitment periods.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the productOfferingTerm" - }, - "duration": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "Duration of the productOfferingTerm" - }, - "name": { - "type": "string", - "description": "Name of the productOfferingTerm" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productOfferingTerm is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingTerm.schema.json", + "title": "ProductOfferingTerm", + "definitions": { + "ProductOfferingTerm": { + "$id": "#ProductOfferingTerm", + "description": "A condition under which a ProductOffering is made available to Customers. For instance, a productOffering can be offered with multiple commitment periods.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the productOfferingTerm" + }, + "duration": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "Duration of the productOfferingTerm" + }, + "name": { + "type": "string", + "description": "Name of the productOfferingTerm" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productOfferingTerm is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductPrice.schema.json b/Product/ProductPrice.schema.json index 2b0d0cec..2728540c 100644 --- a/Product/ProductPrice.schema.json +++ b/Product/ProductPrice.schema.json @@ -1,55 +1,58 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductPrice.schema.json", - "title": "ProductPrice", - "definitions": { - "ProductPrice": { - "$id": "#ProductPrice", - "description": "An amount, usually of money, that represents the actual price paid by a Customer for a purchase, a rent or a lease of a Product. The price is valid for a defined period of time.", - "type": "object", - "required": ["priceType","price"], - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail the semantics of this product price." - }, - "name": { - "type": "string", - "description": "A short descriptive name such as \"Subscription price\"." - }, - "productOfferingPrice": { - "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef" - }, - "priceType": { - "type": "string", - "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth." - }, - "recurringChargePeriod": { - "type": "string", - "description": "Could be month, week..." - }, - "unitOfMeasure": { - "type": "string", - "description": "Could be minutes, GB..." - }, - "productPriceAlteration": { - "type": "array", - "items": { - "$ref": "../Customer/PriceAlteration.schema.json#PriceAlteration" - } - }, - "price": { - "$ref": "../Customer/Price.schema.json#Price" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductPrice.schema.json", + "title": "ProductPrice", + "definitions": { + "ProductPrice": { + "$id": "#ProductPrice", + "description": "An amount, usually of money, that represents the actual price paid by a Customer for a purchase, a rent or a lease of a Product. The price is valid for a defined period of time.", + "type": "object", + "required": [ + "priceType", + "price" + ], + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail the semantics of this product price." + }, + "name": { + "type": "string", + "description": "A short descriptive name such as \"Subscription price\"." + }, + "productOfferingPrice": { + "$ref": "ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" + }, + "billingAccount": { + "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" + }, + "priceType": { + "type": "string", + "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth." + }, + "recurringChargePeriod": { + "type": "string", + "description": "Could be month, week..." + }, + "unitOfMeasure": { + "type": "string", + "description": "Could be minutes, GB..." + }, + "productPriceAlteration": { + "type": "array", + "items": { + "$ref": "PriceAlteration.schema.json#PriceAlteration" + } + }, + "price": { + "$ref": "../Customer/Price.schema.json#Price" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductRef.schema.json b/Product/ProductRef.schema.json index 3cc1818a..385a899c 100644 --- a/Product/ProductRef.schema.json +++ b/Product/ProductRef.schema.json @@ -1,18 +1,17 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductRef.schema.json", - "title": "ProductRef", - "definitions": { - "ProductRef": { - "$id": "#ProductRef", - "type": "object", - "properties": { - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductRef.schema.json", + "title": "ProductRef", + "definitions": { + "ProductRef": { + "$id": "#ProductRef", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductRefOrValue.schema.json b/Product/ProductRefOrValue.schema.json index 9d818c32..9a41704f 100644 --- a/Product/ProductRefOrValue.schema.json +++ b/Product/ProductRefOrValue.schema.json @@ -3,21 +3,19 @@ "$id": "ProductRefOrValue.schema.json", "title": "ProductRefOrValue", "definitions": { - "ProductRefOrValue": { - "$id": "#ProductRefOrValue", - "description": "A product to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the product entity and not the RelatedProductRefOrValue class itself", - "type": "object", - "properties": { - }, - "allOf": [ - { - "$ref": "ProductRef.schema.json#ProductRef" - }, - { - "$ref": "Product.schema.json#Product" - } - - ] - } + "ProductRefOrValue": { + "$id": "#ProductRefOrValue", + "description": "A product to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the product entity and not the RelatedProductRefOrValue class itself", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "ProductRef.schema.json#ProductRef" + }, + { + "$ref": "Product.schema.json#Product" + } + ] + } } } \ No newline at end of file diff --git a/Product/ProductRelationship.schema.json b/Product/ProductRelationship.schema.json index 9f58ce60..4f5b57bf 100644 --- a/Product/ProductRelationship.schema.json +++ b/Product/ProductRelationship.schema.json @@ -1,27 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductRelationship.schema.json", - "title": "ProductRelationship", - "definitions": { - "ProductRelationship": { - "$id": "#ProductRelationship", - "description": "Linked products to the one instantiate, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful", - "type": "object", - "required": ["relationshipType", "product"], - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of the product relationship, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful" - }, - "product": { - "$ref": "ProductRefOrValue.schema.json#ProductRefOrValue" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductRelationship.schema.json", + "title": "ProductRelationship", + "definitions": { + "ProductRelationship": { + "$id": "#ProductRelationship", + "description": "Linked products to the one instantiate, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful", + "type": "object", + "required": [ + "relationshipType", + "product" + ], + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of the product relationship, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful" + }, + "product": { + "$ref": "ProductRefOrValue.schema.json#ProductRefOrValue" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductRequest.schema.json b/Product/ProductRequest.schema.json index 882adb6e..768a4122 100644 --- a/Product/ProductRequest.schema.json +++ b/Product/ProductRequest.schema.json @@ -1,128 +1,128 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductRequest.schema.json", - "title": "ProductRequest", - "definitions": { - "ProductRequest": { - "$id": "#ProductRequest", - "type": "object", - "properties": { - "referredProduct": { - "$ref": "ProductRef.schema.json#ProductRef" - }, - "description": { - "type": "string", - "description": "Is the description of the product. It could be copied from the description of the Product Offering." - }, - "href": { - "type": "string", - "description": "Reference of the product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product" - }, - "isBundle": { - "type": "boolean", - "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." - }, - "isCustomerVisible": { - "type": "boolean", - "description": "If true, the product is visible by the customer." - }, - "name": { - "type": "string", - "description": "Name of the product. It could be the same as the name of the product offering" - }, - "orderDate": { - "type": "string", - "format": "date-time", - "description": "Is the date when the product was ordered" - }, - "productSerialNumber": { - "type": "string", - "description": "Is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router." - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "Is the date from which the product starts" - }, - "status": { - "type": "string", - "description": "Is the lifecycle status of the product." - }, - "terminationDate": { - "type": "string", - "format": "date-time", - "description": "Is the date when the product was terminated" - }, - "realizingService": { - "type": "array", - "items": { - "$ref": "../Service/ServiceRef.schema.json#ServiceRef" - } - }, - "billingAccount": { - "type": "array", - "items": { - "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" - } - }, - "productOffering": { - "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "agreement": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "ProductCharacteristic.schema.json#ProductCharacteristic" - } - }, - "productRelationship": { - "type": "array", - "items": { - "$ref": "ProductRelationship.schema.json#ProductRelationship" - } - }, - "realizingResource": { - "type": "array", - "items": { - "$ref": "../Resource/RealizingResourceRef.schema.json#RealizingResourceRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "productPrice": { - "type": "array", - "items": { - "$ref": "ProductPrice.schema.json#ProductPrice" - } - }, - "productSpecification": { - "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef" - }, - "place": { - "type": "array", - "items": { - "$ref": "../Common/Place.schema.json#Place" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductRequest.schema.json", + "title": "ProductRequest", + "definitions": { + "ProductRequest": { + "$id": "#ProductRequest", + "type": "object", + "properties": { + "referredProduct": { + "$ref": "ProductRef.schema.json#ProductRef" + }, + "description": { + "type": "string", + "description": "Is the description of the product. It could be copied from the description of the Product Offering." + }, + "href": { + "type": "string", + "description": "Reference of the product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product" + }, + "isBundle": { + "type": "boolean", + "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." + }, + "isCustomerVisible": { + "type": "boolean", + "description": "If true, the product is visible by the customer." + }, + "name": { + "type": "string", + "description": "Name of the product. It could be the same as the name of the product offering" + }, + "orderDate": { + "type": "string", + "format": "date-time", + "description": "Is the date when the product was ordered" + }, + "productSerialNumber": { + "type": "string", + "description": "Is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router." + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "Is the date from which the product starts" + }, + "status": { + "type": "string", + "description": "Is the lifecycle status of the product." + }, + "terminationDate": { + "type": "string", + "format": "date-time", + "description": "Is the date when the product was terminated" + }, + "realizingService": { + "type": "array", + "items": { + "$ref": "../Service/ServiceRef.schema.json#ServiceRef" + } + }, + "billingAccount": { + "type": "array", + "items": { + "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" + } + }, + "productOffering": { + "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "agreement": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "ProductCharacteristic.schema.json#ProductCharacteristic" + } + }, + "productRelationship": { + "type": "array", + "items": { + "$ref": "ProductRelationship.schema.json#ProductRelationship" + } + }, + "realizingResource": { + "type": "array", + "items": { + "$ref": "../Resource/RealizingResourceRef.schema.json#RealizingResourceRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "productPrice": { + "type": "array", + "items": { + "$ref": "ProductPrice.schema.json#ProductPrice" + } + }, + "productSpecification": { + "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef" + }, + "place": { + "type": "array", + "items": { + "$ref": "../Common/Place.schema.json#Place" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductRestriction.schema.json b/Product/ProductRestriction.schema.json index 1947f522..7dce1656 100644 --- a/Product/ProductRestriction.schema.json +++ b/Product/ProductRestriction.schema.json @@ -1,58 +1,58 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductRestriction.schema.json", - "title": "ProductRestriction", - "definitions": { - "ProductRestriction": { - "$id": "#ProductRestriction", - "description": "In the context of a product order or a product offering qualification, this data structure captures the product information useful to order or qualified an existing subscribed product or to a new one. This is a subset of relevant product attributes for ordering and qualification", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product" - }, - "name": { - "type": "string", - "description": "This is the name of the product." - }, - "productCharacteristic": { - "type": "array", - "items": { - "$ref": "Characteristic.schema.json#Characteristic" - } - }, - "productRelationship": { - "type": "array", - "items": { - "$ref": "ProductRelationship.schema.json#ProductRelationship" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - } - }, - "productSpecification": { - "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef" - }, - "relatedPlace": { - "type": "array", - "items": { - "$ref": "../Common/RelatedPlace.schema.json#RelatedPlace" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductRestriction.schema.json", + "title": "ProductRestriction", + "definitions": { + "ProductRestriction": { + "$id": "#ProductRestriction", + "description": "In the context of a product order or a product offering qualification, this data structure captures the product information useful to order or qualified an existing subscribed product or to a new one. This is a subset of relevant product attributes for ordering and qualification", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product" + }, + "name": { + "type": "string", + "description": "This is the name of the product." + }, + "productCharacteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "productRelationship": { + "type": "array", + "items": { + "$ref": "ProductRelationship.schema.json#ProductRelationship" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + } + }, + "productSpecification": { + "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef" + }, + "relatedPlace": { + "type": "array", + "items": { + "$ref": "../Common/RelatedPlace.schema.json#RelatedPlace" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductSpecCharRelationship.schema.json b/Product/ProductSpecCharRelationship.schema.json index df51229b..c3309c4e 100644 --- a/Product/ProductSpecCharRelationship.schema.json +++ b/Product/ProductSpecCharRelationship.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecCharRelationship.schema.json", - "title": "ProductSpecCharRelationship", - "definitions": { - "ProductSpecCharRelationship": { - "$id": "#ProductSpecCharRelationship", - "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productSpecCharRelationship is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecCharRelationship.schema.json", + "title": "ProductSpecCharRelationship", + "definitions": { + "ProductSpecCharRelationship": { + "$id": "#ProductSpecCharRelationship", + "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productSpecCharRelationship is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductSpecCharacteristic.schema.json b/Product/ProductSpecCharacteristic.schema.json index c64f5148..ca95d109 100644 --- a/Product/ProductSpecCharacteristic.schema.json +++ b/Product/ProductSpecCharacteristic.schema.json @@ -1,51 +1,51 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecCharacteristic.schema.json", - "title": "ProductSpecCharacteristic", - "definitions": { - "ProductSpecCharacteristic": { - "$id": "#ProductSpecCharacteristic", - "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", - "type": "object", - "properties": { - "configurable": { - "type": "boolean", - "description": "If true, the Boolean indicates that the productSpecCharacteristic is configurable" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the productSpecCharacteristic is" - }, - "name": { - "type": "string", - "description": "Name of the productSpecCharacteristic" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productSpecCharacteristic is valid" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" - }, - "productSpecCharRelationship": { - "type": "array", - "items": { - "$ref": "ProductSpecCharRelationship.schema.json#ProductSpecCharRelationship" - } - }, - "productSpecCharacteristicValue": { - "type": "array", - "items": { - "$ref": "ProductSpecCharacteristicValue.schema.json#ProductSpecCharacteristicValue" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecCharacteristic.schema.json", + "title": "ProductSpecCharacteristic", + "definitions": { + "ProductSpecCharacteristic": { + "$id": "#ProductSpecCharacteristic", + "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", + "type": "object", + "properties": { + "configurable": { + "type": "boolean", + "description": "If true, the Boolean indicates that the productSpecCharacteristic is configurable" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the productSpecCharacteristic is" + }, + "name": { + "type": "string", + "description": "Name of the productSpecCharacteristic" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productSpecCharacteristic is valid" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" + }, + "productSpecCharRelationship": { + "type": "array", + "items": { + "$ref": "ProductSpecCharRelationship.schema.json#ProductSpecCharRelationship" + } + }, + "productSpecCharacteristicValue": { + "type": "array", + "items": { + "$ref": "ProductSpecCharacteristicValue.schema.json#ProductSpecCharacteristicValue" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductSpecCharacteristicValue.schema.json b/Product/ProductSpecCharacteristicValue.schema.json index 78fc1da2..83df6a8e 100644 --- a/Product/ProductSpecCharacteristicValue.schema.json +++ b/Product/ProductSpecCharacteristicValue.schema.json @@ -1,47 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecCharacteristicValue.schema.json", - "title": "ProductSpecCharacteristicValue", - "definitions": { - "ProductSpecCharacteristicValue": { - "$id": "#ProductSpecCharacteristicValue", - "description": "A number or text that can be assigned to a ProductSpecCharacteristic.", - "type": "object", - "properties": { - "default": { - "type": "boolean", - "description": "Indicates if the value is the default value for a characteristic" - }, - "unitOfMeasure": { - "type": "string", - "description": "Could be minutes, GB..." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period of time for which a value is applicable" - }, - "value": { - "type": "string", - "description": "A discrete value that the characteristic can take on" - }, - "valueFrom": { - "type": "string", - "description": "The low range value that a characteristic can take on" - }, - "valueTo": { - "type": "string", - "description": "The upper range value that a characteristic can take on" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecCharacteristicValue.schema.json", + "title": "ProductSpecCharacteristicValue", + "definitions": { + "ProductSpecCharacteristicValue": { + "$id": "#ProductSpecCharacteristicValue", + "description": "A number or text that can be assigned to a ProductSpecCharacteristic.", + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Indicates if the value is the default value for a characteristic" + }, + "unitOfMeasure": { + "type": "string", + "description": "Could be minutes, GB..." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period of time for which a value is applicable" + }, + "value": { + "type": "string", + "description": "A discrete value that the characteristic can take on" + }, + "valueFrom": { + "type": "string", + "description": "The low range value that a characteristic can take on" + }, + "valueTo": { + "type": "string", + "description": "The upper range value that a characteristic can take on" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductSpecification.schema.json b/Product/ProductSpecification.schema.json index 827693ac..d9af7319 100644 --- a/Product/ProductSpecification.schema.json +++ b/Product/ProductSpecification.schema.json @@ -1,117 +1,117 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecification.schema.json", - "title": "ProductSpecification", - "definitions": { - "ProductSpecification": { - "$id": "#ProductSpecification", - "description": "Is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.", - "type": "object", - "properties": { - "brand": { - "type": "string", - "description": "The manufacturer or trademark of the specification" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the product specification is" - }, - "href": { - "type": "string", - "description": "Reference of the product specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product specification" - }, - "isBundle": { - "type": "boolean", - "description": "isBundle determines whether a productSpecification represents a single productSpecification (false), or a bundle of productSpecification (true)." - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the product specification" - }, - "productNumber": { - "type": "string", - "description": "An identification number assigned to uniquely identity the specification" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the product specification is valid" - }, - "version": { - "type": "string", - "description": "Product specification version" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "description": "A related party defines party or party role linked to a specific entity." - }, - "productSpecCharacteristic": { - "type": "array", - "items": { - "$ref": "ProductSpecificationCharacteristic.schema.json#ProductSpecificationCharacteristic" - }, - "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process." - }, - "serviceSpecification": { - "type": "array", - "items": { - "$ref": "../Service/ServiceSpecificationRef.schema.json#ServiceSpecificationRef" - }, - "description": "ServiceSpecification(s) required to realize a ProductSpecification." - }, - "productSpecificationRelationship": { - "type": "array", - "items": { - "$ref": "ProductSpecificationRelationship.schema.json#ProductSpecificationRelationship" - }, - "description": "A migration, substitution, dependency or exclusivity relationship between/among product specifications." - }, - "resourceSpecification": { - "type": "array", - "items": { - "$ref": "../Resource/ResourceSpecificationRef.schema.json#ResourceSpecificationRef" - }, - "description": "The ResourceSpecification is required to realize a ProductSpecification." - }, - "attachment": { - "type": "array", - "items": { - "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" - }, - "description": "Complements the description of an element (for instance a product) through video, pictures..." - }, - "bundledProductSpecification": { - "type": "array", - "items": { - "$ref": "BundledProductSpecification.schema.json#BundledProductSpecification" - }, - "description": "A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification." - }, - "targetProductSchema": { - "description": "A target product schema reference. The reference object to the schema and type of target product which is described by product specification.", - "$ref": "TargetProductSchema.schema.json#TargetProductSchema" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecification.schema.json", + "title": "ProductSpecification", + "definitions": { + "ProductSpecification": { + "$id": "#ProductSpecification", + "description": "Is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.", + "type": "object", + "properties": { + "brand": { + "type": "string", + "description": "The manufacturer or trademark of the specification" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the product specification is" + }, + "href": { + "type": "string", + "description": "Reference of the product specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product specification" + }, + "isBundle": { + "type": "boolean", + "description": "isBundle determines whether a productSpecification represents a single productSpecification (false), or a bundle of productSpecification (true)." + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the product specification" + }, + "productNumber": { + "type": "string", + "description": "An identification number assigned to uniquely identity the specification" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the product specification is valid" + }, + "version": { + "type": "string", + "description": "Product specification version" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "A related party defines party or party role linked to a specific entity." + }, + "productSpecCharacteristic": { + "type": "array", + "items": { + "$ref": "ProductSpecificationCharacteristic.schema.json#ProductSpecificationCharacteristic" + }, + "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process." + }, + "serviceSpecification": { + "type": "array", + "items": { + "$ref": "../Service/ServiceSpecificationRef.schema.json#ServiceSpecificationRef" + }, + "description": "ServiceSpecification(s) required to realize a ProductSpecification." + }, + "productSpecificationRelationship": { + "type": "array", + "items": { + "$ref": "ProductSpecificationRelationship.schema.json#ProductSpecificationRelationship" + }, + "description": "A migration, substitution, dependency or exclusivity relationship between/among product specifications." + }, + "resourceSpecification": { + "type": "array", + "items": { + "$ref": "../Resource/ResourceSpecificationRef.schema.json#ResourceSpecificationRef" + }, + "description": "The ResourceSpecification is required to realize a ProductSpecification." + }, + "attachment": { + "type": "array", + "items": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + }, + "description": "Complements the description of an element (for instance a product) through video, pictures..." + }, + "bundledProductSpecification": { + "type": "array", + "items": { + "$ref": "BundledProductSpecification.schema.json#BundledProductSpecification" + }, + "description": "A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification." + }, + "targetProductSchema": { + "description": "A target product schema reference. The reference object to the schema and type of target product which is described by product specification.", + "$ref": "TargetProductSchema.schema.json#TargetProductSchema" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductSpecificationCharacteristic.schema.json b/Product/ProductSpecificationCharacteristic.schema.json index 7bb95067..73384c37 100644 --- a/Product/ProductSpecificationCharacteristic.schema.json +++ b/Product/ProductSpecificationCharacteristic.schema.json @@ -1,73 +1,73 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationCharacteristic.schema.json", - "title": "ProductSpecificationCharacteristic", - "definitions": { - "ProductSpecificationCharacteristic": { - "$id": "#ProductSpecificationCharacteristic", - "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", - "type": "object", - "properties": { - "configurable": { - "type": "boolean", - "description": "If true, the Boolean indicates that the ProductSpecificationCharacteristic is configurable" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the ProductSpecificationCharacteristic is" - }, - "extensible": { - "type": "boolean", - "description": "An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a product" - }, - "isUnique": { - "type": "boolean", - "description": "An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"" - }, - "maxCardinality": { - "type": "integer", - "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality" - }, - "minCardinality": { - "type": "integer", - "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality" - }, - "name": { - "type": "string", - "description": "Name of the ProductSpecificationCharacteristic" - }, - "regex": { - "type": "string", - "description": "A rule or principle represented in regular expression used to derive the value of a characteristic value" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" - }, - "productSpecCharacteristicValue": { - "type": "array", - "items": { - "$ref": "ProductSpecificationCharacteristicValue.schema.json#ProductSpecificationCharacteristicValue" - }, - "description": "A ProductSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ProductSpecificationCharacteristic object. The values of the attributes in the ProductSpecificationCharacteristicValue object describe the values of the attributes that a corresponding ProductSpecificationCharacteristic object can take on." - }, - "productSpecCharRelationship": { - "type": "array", - "items": { - "$ref": "ProductSpecificationCharacteristicRelationship.schema.json#ProductSpecificationCharacteristicRelationship" - }, - "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the ProductSpecificationCharacteristic is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationCharacteristic.schema.json", + "title": "ProductSpecificationCharacteristic", + "definitions": { + "ProductSpecificationCharacteristic": { + "$id": "#ProductSpecificationCharacteristic", + "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", + "type": "object", + "properties": { + "configurable": { + "type": "boolean", + "description": "If true, the Boolean indicates that the ProductSpecificationCharacteristic is configurable" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the ProductSpecificationCharacteristic is" + }, + "extensible": { + "type": "boolean", + "description": "An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a product" + }, + "isUnique": { + "type": "boolean", + "description": "An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"" + }, + "maxCardinality": { + "type": "integer", + "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality" + }, + "minCardinality": { + "type": "integer", + "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality" + }, + "name": { + "type": "string", + "description": "Name of the ProductSpecificationCharacteristic" + }, + "regex": { + "type": "string", + "description": "A rule or principle represented in regular expression used to derive the value of a characteristic value" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" + }, + "productSpecCharacteristicValue": { + "type": "array", + "items": { + "$ref": "ProductSpecificationCharacteristicValue.schema.json#ProductSpecificationCharacteristicValue" + }, + "description": "A ProductSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ProductSpecificationCharacteristic object. The values of the attributes in the ProductSpecificationCharacteristicValue object describe the values of the attributes that a corresponding ProductSpecificationCharacteristic object can take on." + }, + "productSpecCharRelationship": { + "type": "array", + "items": { + "$ref": "ProductSpecificationCharacteristicRelationship.schema.json#ProductSpecificationCharacteristicRelationship" + }, + "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the ProductSpecificationCharacteristic is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductSpecificationCharacteristicRelationship.schema.json b/Product/ProductSpecificationCharacteristicRelationship.schema.json index 0226479f..67981387 100644 --- a/Product/ProductSpecificationCharacteristicRelationship.schema.json +++ b/Product/ProductSpecificationCharacteristicRelationship.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationCharacteristicRelationship.schema.json", - "title": "ProductSpecificationCharacteristicRelationship", - "definitions": { - "ProductSpecificationCharacteristicRelationship": { - "$id": "#ProductSpecificationCharacteristicRelationship", - "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecificationCharacteristics.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "the identifier of the associated product specification" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to the target product specification" - }, - "charSpecSeq": { - "type": "integer", - "description": "The order in which a CharacteristicSpecification appears within another CharacteristicSpecification that defines a grouping of CharacteristicSpecifications.\n\nFor example, a grouping may represent the name of an individual. The given name is first, the middle name is second, and the last name is third." - }, - "name": { - "type": "string", - "description": "Name of the target product specification characteristic" - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productSpecificationCharacteristicRelationship is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationCharacteristicRelationship.schema.json", + "title": "ProductSpecificationCharacteristicRelationship", + "definitions": { + "ProductSpecificationCharacteristicRelationship": { + "$id": "#ProductSpecificationCharacteristicRelationship", + "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecificationCharacteristics.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "the identifier of the associated product specification" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to the target product specification" + }, + "charSpecSeq": { + "type": "integer", + "description": "The order in which a CharacteristicSpecification appears within another CharacteristicSpecification that defines a grouping of CharacteristicSpecifications.\n\nFor example, a grouping may represent the name of an individual. The given name is first, the middle name is second, and the last name is third." + }, + "name": { + "type": "string", + "description": "Name of the target product specification characteristic" + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productSpecificationCharacteristicRelationship is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductSpecificationCharacteristicValue.schema.json b/Product/ProductSpecificationCharacteristicValue.schema.json index deb3aaef..95e1d7b7 100644 --- a/Product/ProductSpecificationCharacteristicValue.schema.json +++ b/Product/ProductSpecificationCharacteristicValue.schema.json @@ -1,55 +1,55 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationCharacteristicValue.schema.json", - "title": "ProductSpecificationCharacteristicValue", - "definitions": { - "ProductSpecificationCharacteristicValue": { - "$id": "#ProductSpecificationCharacteristicValue", - "description": "A ProductSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ProductSpecificationCharacteristic object. The values of the attributes in the ProductSpecificationCharacteristicValue object describe the values of the attributes that a corresponding ProductSpecificationCharacteristic object can take on.", - "type": "object", - "properties": { - "isDefault": { - "type": "boolean", - "description": "Indicates if the value is the default value for a characteristic" - }, - "rangeInterval": { - "type": "string", - "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." - }, - "regex": { - "type": "string", - "description": "Regular expression to define constraint on the allowed value" - }, - "unitOfMeasure": { - "type": "string", - "description": "A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period of time for which a value is applicable" - }, - "value": { - "$ref": "../Common/Any.schema.json#/definitions/Any", - "description": "A discrete value that the characteristic can take on, or the actual value of the characteristic" - }, - "valueFrom": { - "type": "string", - "description": "The low range value that a characteristic can take on" - }, - "valueTo": { - "type": "string", - "description": "The upper range value that a characteristic can take on" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationCharacteristicValue.schema.json", + "title": "ProductSpecificationCharacteristicValue", + "definitions": { + "ProductSpecificationCharacteristicValue": { + "$id": "#ProductSpecificationCharacteristicValue", + "description": "A ProductSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ProductSpecificationCharacteristic object. The values of the attributes in the ProductSpecificationCharacteristicValue object describe the values of the attributes that a corresponding ProductSpecificationCharacteristic object can take on.", + "type": "object", + "properties": { + "isDefault": { + "type": "boolean", + "description": "Indicates if the value is the default value for a characteristic" + }, + "rangeInterval": { + "type": "string", + "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." + }, + "regex": { + "type": "string", + "description": "Regular expression to define constraint on the allowed value" + }, + "unitOfMeasure": { + "type": "string", + "description": "A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period of time for which a value is applicable" + }, + "value": { + "$ref": "../Common/Any.schema.json#Any", + "description": "A discrete value that the characteristic can take on, or the actual value of the characteristic" + }, + "valueFrom": { + "type": "string", + "description": "The low range value that a characteristic can take on" + }, + "valueTo": { + "type": "string", + "description": "The upper range value that a characteristic can take on" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductSpecificationCharacteristicValueUse.schema.json b/Product/ProductSpecificationCharacteristicValueUse.schema.json index 80aadfae..bab86723 100644 --- a/Product/ProductSpecificationCharacteristicValueUse.schema.json +++ b/Product/ProductSpecificationCharacteristicValueUse.schema.json @@ -1,49 +1,49 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationCharacteristicValueUse.schema.json", - "title": "ProductSpecificationCharacteristicValueUse", - "definitions": { - "ProductSpecificationCharacteristicValueUse": { - "$id": "#ProductSpecificationCharacteristicValueUse", - "type": "object", - "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.", - "properties": { - "name": { - "type": "string", - "description": "Name of the associated productSpecificationCharacteristic" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the productSpecificationCharacteristic is" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" - }, - "minCardinality": { - "type": "integer", - "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality." - }, - "maxCardinality": { - "type": "integer", - "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productSpecificationCharacteristic is valid" - }, - "productSpecCharacteristicValue": { - "type": "array", - "items": { - "$ref": "ProductSpecificationCharacteristicValue.schema.json#ProductSpecificationCharacteristicValue" - }, - "description": "A number or text that can be assigned to a ProductSpecificationCharacteristic." - }, - "productSpecification": { - "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef", - "description": "A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationCharacteristicValueUse.schema.json", + "title": "ProductSpecificationCharacteristicValueUse", + "definitions": { + "ProductSpecificationCharacteristicValueUse": { + "$id": "#ProductSpecificationCharacteristicValueUse", + "type": "object", + "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.", + "properties": { + "name": { + "type": "string", + "description": "Name of the associated productSpecificationCharacteristic" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the productSpecificationCharacteristic is" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" + }, + "minCardinality": { + "type": "integer", + "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality." + }, + "maxCardinality": { + "type": "integer", + "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productSpecificationCharacteristic is valid" + }, + "productSpecCharacteristicValue": { + "type": "array", + "items": { + "$ref": "ProductSpecificationCharacteristicValue.schema.json#ProductSpecificationCharacteristicValue" + }, + "description": "A number or text that can be assigned to a ProductSpecificationCharacteristic." + }, + "productSpecification": { + "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef", + "description": "A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role." } + } } -} + } +} \ No newline at end of file diff --git a/Product/ProductSpecificationRef.schema.json b/Product/ProductSpecificationRef.schema.json index d17cc387..9181158d 100644 --- a/Product/ProductSpecificationRef.schema.json +++ b/Product/ProductSpecificationRef.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationRef.schema.json", - "title": "ProductSpecificationRef", - "definitions": { - "ProductSpecificationRef": { - "$id": "#ProductSpecificationRef", - "description": "Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.", - "type": "object", - "properties": { - - "version": { - "type": "string", - "description": "Version of the product specification" - }, - "targetProductSchema": { - "description": "A target product schema reference. The reference object to the schema and type of target product which is described by product specification.", - "$ref": "TargetProductSchema.schema.json#TargetProductSchema" - } }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationRef.schema.json", + "title": "ProductSpecificationRef", + "definitions": { + "ProductSpecificationRef": { + "$id": "#ProductSpecificationRef", + "description": "Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "Version of the product specification" + }, + "targetProductSchema": { + "description": "A target product schema reference. The reference object to the schema and type of target product which is described by product specification.", + "$ref": "TargetProductSchema.schema.json#TargetProductSchema" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductSpecificationRelationship.schema.json b/Product/ProductSpecificationRelationship.schema.json index 6aa56788..4c8fd480 100644 --- a/Product/ProductSpecificationRelationship.schema.json +++ b/Product/ProductSpecificationRelationship.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationRelationship.schema.json", - "title": "ProductSpecificationRelationship", - "definitions": { - "ProductSpecificationRelationship": { - "$id": "#ProductSpecificationRelationship", - "description": "A migration, substitution, dependency or exclusivity relationship between/among product specifications.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the productSpecification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the productSpecification" - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship such as migration, substitution, dependency, exclusivity" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productSpecificationRelationship is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationRelationship.schema.json", + "title": "ProductSpecificationRelationship", + "definitions": { + "ProductSpecificationRelationship": { + "$id": "#ProductSpecificationRelationship", + "description": "A migration, substitution, dependency or exclusivity relationship between/among product specifications.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the productSpecification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the productSpecification" + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship such as migration, substitution, dependency, exclusivity" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productSpecificationRelationship is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductSpecificationSchemaRef.schema.json b/Product/ProductSpecificationSchemaRef.schema.json index 3b23f912..1f6e3497 100644 --- a/Product/ProductSpecificationSchemaRef.schema.json +++ b/Product/ProductSpecificationSchemaRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationSchemaRef.schema.json", - "title": "ProductSpecificationSchemaRef", - "definitions": { - "ProductSpecificationSchemaRef": { - "$id": "#ProductSpecificationSchemaRef", - "description": "ProductSpecification description could be done with schema use. This information allows to retrieve schema type and location", - "type": "object", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationSchemaRef.schema.json", + "title": "ProductSpecificationSchemaRef", + "definitions": { + "ProductSpecificationSchemaRef": { + "$id": "#ProductSpecificationSchemaRef", + "description": "ProductSpecification description could be done with schema use. This information allows to retrieve schema type and location", + "type": "object", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductStatusType.schema.json b/Product/ProductStatusType.schema.json index baff939b..5d06efb3 100644 --- a/Product/ProductStatusType.schema.json +++ b/Product/ProductStatusType.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductStatusType.schema.json", - "title": "ProductStatusType", - "definitions": { - "ProductStatusType": { - "$id": "#ProductStatusType", - "type": "string", - "description": "Possible values for the status of the product", - "enum": [ - "created", - "pendingActive", - "cancelled", - "active", - "pendingTerminate", - "terminated", - "suspended", - "aborted " - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductStatusType.schema.json", + "title": "ProductStatusType", + "definitions": { + "ProductStatusType": { + "$id": "#ProductStatusType", + "type": "string", + "description": "Possible values for the status of the product", + "enum": [ + "created", + "pendingActive", + "cancelled", + "active", + "pendingTerminate", + "terminated", + "suspended", + "aborted " + ] } -} + } +} \ No newline at end of file diff --git a/Product/ProductTerm.schema.json b/Product/ProductTerm.schema.json index 3ca0a997..cc5ebcca 100644 --- a/Product/ProductTerm.schema.json +++ b/Product/ProductTerm.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductTerm.schema.json", - "title": "ProductTerm", - "definitions": { - "ProductTerm": { - "$id": "#ProductTerm", - "description": "Description of a productTerm linked to this product. This represent a commitment with a duration", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the productTerm" - }, - "duration": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "Duration of the productTerm" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "productTerm validity period" - }, - "name": { - "type": "string", - "description": "Name of the productTerm" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductTerm.schema.json", + "title": "ProductTerm", + "definitions": { + "ProductTerm": { + "$id": "#ProductTerm", + "description": "Description of a productTerm linked to this product. This represent a commitment with a duration", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the productTerm" + }, + "duration": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "Duration of the productTerm" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "productTerm validity period" + }, + "name": { + "type": "string", + "description": "Name of the productTerm" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/Promotion.schema.json b/Product/Promotion.schema.json index 4e32c0b3..bac5d930 100644 --- a/Product/Promotion.schema.json +++ b/Product/Promotion.schema.json @@ -1,58 +1,58 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Promotion.schema.json", - "title": "Promotion", - "definitions": { - "Promotion": { - "$id": "#Promotion", - "description": "Promotion Resource is used to provide the additional discount, voucher, bonus or gift to the customer who meets the pre-defined criteria. Using promotion, the enterprise is able to attract the users and encourage more consumption, especially continuous purchases. Normally Promotion is not regarded as one type of product or product offering. It is often applied when the customer buys the product offerings with the price or amount surpassing the certain limit.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of Promotion" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the Promotion" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Promotion" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Latest update date of the Promotion" - }, - "lifecycleStatus": { - "type": "string", - "description": "Status of the Promotion, including Draft/Test/WaitForApproval/Release/Suspend/Retirement" - }, - "name": { - "type": "string", - "description": "Name of the Promotion" - }, - "promotionType": { - "type": "string", - "description": "Type of the Promotion. The basic type is Award/Discount/Reduction. More types can be extended in future" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the Promotion is valid" - }, - "pattern": { - "type": "array", - "items": { - "$ref": "PromotionPattern.schema.json#PromotionPattern" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Promotion.schema.json", + "title": "Promotion", + "definitions": { + "Promotion": { + "$id": "#Promotion", + "description": "Promotion Resource is used to provide the additional discount, voucher, bonus or gift to the customer who meets the pre-defined criteria. Using promotion, the enterprise is able to attract the users and encourage more consumption, especially continuous purchases. Normally Promotion is not regarded as one type of product or product offering. It is often applied when the customer buys the product offerings with the price or amount surpassing the certain limit.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Promotion" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the Promotion" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Promotion" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Latest update date of the Promotion" + }, + "lifecycleStatus": { + "type": "string", + "description": "Status of the Promotion, including Draft/Test/WaitForApproval/Release/Suspend/Retirement" + }, + "name": { + "type": "string", + "description": "Name of the Promotion" + }, + "promotionType": { + "type": "string", + "description": "Type of the Promotion. The basic type is Award/Discount/Reduction. More types can be extended in future" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the Promotion is valid" + }, + "pattern": { + "type": "array", + "items": { + "$ref": "PromotionPattern.schema.json#PromotionPattern" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/PromotionAction.schema.json b/Product/PromotionAction.schema.json index 1d7680b3..aac9d76e 100644 --- a/Product/PromotionAction.schema.json +++ b/Product/PromotionAction.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PromotionAction.schema.json", - "title": "PromotionAction", - "definitions": { - "PromotionAction": { - "$id": "#PromotionAction", - "description": "Action of the promotion.When the customer meets the conditions in the promotion pattern, the customer can be given the benefits in the action.", - "type": "object", - "properties": { - "actionObjectId": { - "type": "string", - "description": "It refers to the object (entity) ID which is impacted by the promotion action. When the Promotion -> type is 1: Award, the actionObjectId is the sub-account ID; When the Promotion -> type is 2: Discount, it is the offering ID; When the Promotion -> type is 3: reduction, it is the offering ID." - }, - "actionType": { - "type": "string", - "description": "When the Promotion -> type is 1: Award, the action type can be one of the following:voice (minute),data (MB),data (GB),SMS,bonus point,physical gift,voucher,promotion code,an existing offering,currency. More types of action can be extended in future." - }, - "actionValue": { - "type": "number", - "format": "float", - "description": "When the Promotion -> type is 1: Award, it means the amount or value of the awards decided by actionType, such as:Amount of gift,Amount of bonus,Value of discount; When the Promotion -> type is 2: Discount, it means the value of the discount; When the Promotion -> type is 3: reduction, it means the value of the reduced money ." - }, - "id": { - "type": "string", - "description": "Unique identifier." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PromotionAction.schema.json", + "title": "PromotionAction", + "definitions": { + "PromotionAction": { + "$id": "#PromotionAction", + "description": "Action of the promotion.When the customer meets the conditions in the promotion pattern, the customer can be given the benefits in the action.", + "type": "object", + "properties": { + "actionObjectId": { + "type": "string", + "description": "It refers to the object (entity) ID which is impacted by the promotion action. When the Promotion -> type is 1: Award, the actionObjectId is the sub-account ID; When the Promotion -> type is 2: Discount, it is the offering ID; When the Promotion -> type is 3: reduction, it is the offering ID." + }, + "actionType": { + "type": "string", + "description": "When the Promotion -> type is 1: Award, the action type can be one of the following:voice (minute),data (MB),data (GB),SMS,bonus point,physical gift,voucher,promotion code,an existing offering,currency. More types of action can be extended in future." + }, + "actionValue": { + "type": "number", + "format": "float", + "description": "When the Promotion -> type is 1: Award, it means the amount or value of the awards decided by actionType, such as:Amount of gift,Amount of bonus,Value of discount; When the Promotion -> type is 2: Discount, it means the value of the discount; When the Promotion -> type is 3: reduction, it means the value of the reduced money ." + }, + "id": { + "type": "string", + "description": "Unique identifier." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/PromotionCriteria.schema.json b/Product/PromotionCriteria.schema.json index 8079f3ff..e8ad70a6 100644 --- a/Product/PromotionCriteria.schema.json +++ b/Product/PromotionCriteria.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PromotionCriteria.schema.json", - "title": "PromotionCriteria", - "definitions": { - "PromotionCriteria": { - "$id": "#PromotionCriteria", - "description": "Criteria of the promotion.", - "type": "object", - "properties": { - "criteriaOperator": { - "type": "string", - "description": "The logic expression including parameter and operator. including:=,>,<,>=,<=,<>" - }, - "criteriaPara": { - "type": "string", - "description": "The parameter (factor) of the criteria.The basic factors are abstracted from these data sources. There are several detail parameters ." - }, - "criteriaValue": { - "type": "string", - "description": "The value is filled for the comparison of the criteria." - }, - "id": { - "type": "string", - "description": "Unique identifier." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PromotionCriteria.schema.json", + "title": "PromotionCriteria", + "definitions": { + "PromotionCriteria": { + "$id": "#PromotionCriteria", + "description": "Criteria of the promotion.", + "type": "object", + "properties": { + "criteriaOperator": { + "type": "string", + "description": "The logic expression including parameter and operator. including:=,>,<,>=,<=,<>" + }, + "criteriaPara": { + "type": "string", + "description": "The parameter (factor) of the criteria.The basic factors are abstracted from these data sources. There are several detail parameters ." + }, + "criteriaValue": { + "type": "string", + "description": "The value is filled for the comparison of the criteria." + }, + "id": { + "type": "string", + "description": "Unique identifier." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/PromotionCriteriaGroup.schema.json b/Product/PromotionCriteriaGroup.schema.json index 85507bf5..5e9e2978 100644 --- a/Product/PromotionCriteriaGroup.schema.json +++ b/Product/PromotionCriteriaGroup.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PromotionCriteriaGroup.schema.json", - "title": "PromotionCriteriaGroup", - "definitions": { - "PromotionCriteriaGroup": { - "$id": "#PromotionCriteriaGroup", - "description": "The group of the criteria of the promotion. The logical relationship between different groups is decided by the relationTypeInGroup.", - "type": "object", - "properties": { - "groupName": { - "type": "string", - "description": "Name of the group." - }, - "id": { - "type": "string", - "description": "Unique Identifier" - }, - "relationTypeInGroup": { - "type": "string", - "description": "AND/OR,The logical relation type amongst the various criteria inside a promotion criteria group." - }, - "criteria": { - "type": "array", - "items": { - "$ref": "PromotionCriteria.schema.json#PromotionCriteria" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PromotionCriteriaGroup.schema.json", + "title": "PromotionCriteriaGroup", + "definitions": { + "PromotionCriteriaGroup": { + "$id": "#PromotionCriteriaGroup", + "description": "The group of the criteria of the promotion. The logical relationship between different groups is decided by the relationTypeInGroup.", + "type": "object", + "properties": { + "groupName": { + "type": "string", + "description": "Name of the group." + }, + "id": { + "type": "string", + "description": "Unique Identifier" + }, + "relationTypeInGroup": { + "type": "string", + "description": "AND/OR,The logical relation type amongst the various criteria inside a promotion criteria group." + }, + "criteria": { + "type": "array", + "items": { + "$ref": "PromotionCriteria.schema.json#PromotionCriteria" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/PromotionPattern.schema.json b/Product/PromotionPattern.schema.json index 9f5a0a8b..cccb1fba 100644 --- a/Product/PromotionPattern.schema.json +++ b/Product/PromotionPattern.schema.json @@ -1,55 +1,55 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PromotionPattern.schema.json", - "title": "PromotionPattern", - "definitions": { - "PromotionPattern": { - "$id": "#PromotionPattern", - "description": "Detailed pattern of the promotion.The pattern decides the conditions of promotion and the benefit of the promotion to be given to the eligible customer.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description" - }, - "id": { - "type": "string", - "description": "Unique identifier." - }, - "name": { - "type": "string", - "description": "Name" - }, - "priority": { - "type": "integer", - "description": "Priority. Smaller number means high." - }, - "relationTypeAmongGroup": { - "type": "string", - "description": "AND/OR ,The logical relation type amongst the promotion criteria group." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the promotion pattern is valid." - }, - "action": { - "type": "array", - "items": { - "$ref": "PromotionAction.schema.json#PromotionAction" - } - }, - "criteriaGroup": { - "type": "array", - "items": { - "$ref": "PromotionCriteriaGroup.schema.json#PromotionCriteriaGroup" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PromotionPattern.schema.json", + "title": "PromotionPattern", + "definitions": { + "PromotionPattern": { + "$id": "#PromotionPattern", + "description": "Detailed pattern of the promotion.The pattern decides the conditions of promotion and the benefit of the promotion to be given to the eligible customer.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description" + }, + "id": { + "type": "string", + "description": "Unique identifier." + }, + "name": { + "type": "string", + "description": "Name" + }, + "priority": { + "type": "integer", + "description": "Priority. Smaller number means high." + }, + "relationTypeAmongGroup": { + "type": "string", + "description": "AND/OR ,The logical relation type amongst the promotion criteria group." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the promotion pattern is valid." + }, + "action": { + "type": "array", + "items": { + "$ref": "PromotionAction.schema.json#PromotionAction" + } + }, + "criteriaGroup": { + "type": "array", + "items": { + "$ref": "PromotionCriteriaGroup.schema.json#PromotionCriteriaGroup" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/QualificationItemRelationship.schema.json b/Product/QualificationItemRelationship.schema.json index a9c82dd0..15865ad7 100644 --- a/Product/QualificationItemRelationship.schema.json +++ b/Product/QualificationItemRelationship.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QualificationItemRelationship.schema.json", - "title": "QualificationItemRelationship", - "definitions": { - "QualificationItemRelationship": { - "$id": "#QualificationItemRelationship", - "description": "Structure used to describe relationship between productOfferingQualification item from the same ProductOfferingQualification.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Id of the ProductOfferingQualificationItem (from the same ProductOfferingQualificationItem)." - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship (ex: reliesOn, connectedTo, etc...)" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QualificationItemRelationship.schema.json", + "title": "QualificationItemRelationship", + "definitions": { + "QualificationItemRelationship": { + "$id": "#QualificationItemRelationship", + "description": "Structure used to describe relationship between productOfferingQualification item from the same ProductOfferingQualification.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Id of the ProductOfferingQualificationItem (from the same ProductOfferingQualificationItem)." + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship (ex: reliesOn, connectedTo, etc...)" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/QuoteItemStateType.schema.json b/Product/QuoteItemStateType.schema.json index 4c80314b..a673fbd2 100644 --- a/Product/QuoteItemStateType.schema.json +++ b/Product/QuoteItemStateType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteItemStateType.schema.json", - "title": "QuoteItemStateType", - "definitions": { - "QuoteItemStateType": { - "$id": "#QuoteItemStateType", - "type": "string", - "description": "Possible values for the state of the quote item", - "enum": [ - "rejected", - "pending", - "inProgress", - "approved" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteItemStateType.schema.json", + "title": "QuoteItemStateType", + "definitions": { + "QuoteItemStateType": { + "$id": "#QuoteItemStateType", + "type": "string", + "description": "Possible values for the state of the quote item", + "enum": [ + "rejected", + "pending", + "inProgress", + "approved" + ] } -} + } +} \ No newline at end of file diff --git a/Product/QuoteStateType.schema.json b/Product/QuoteStateType.schema.json index 8841431c..407a8a49 100644 --- a/Product/QuoteStateType.schema.json +++ b/Product/QuoteStateType.schema.json @@ -1,20 +1,20 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteStateType.schema.json", - "title": "QuoteStateType", - "definitions": { - "QuoteStateType": { - "$id": "#QuoteStateType", - "type": "string", - "description": "Possible values for the state of the quote", - "enum": [ - "rejected", - "pending", - "inProgress", - "cancelled", - "approved", - "accepted" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteStateType.schema.json", + "title": "QuoteStateType", + "definitions": { + "QuoteStateType": { + "$id": "#QuoteStateType", + "type": "string", + "description": "Possible values for the state of the quote", + "enum": [ + "rejected", + "pending", + "inProgress", + "cancelled", + "approved", + "accepted" + ] } -} + } +} \ No newline at end of file diff --git a/Product/QuoteTerm.schema.json b/Product/QuoteTerm.schema.json index 65874623..1d44368f 100644 --- a/Product/QuoteTerm.schema.json +++ b/Product/QuoteTerm.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteTerm.schema.json", - "title": "QuoteTerm", - "definitions": { - "QuoteTerm": { - "$id": "#QuoteTerm", - "description": "Description of aproduct Term linked to this quoteItem. This represent a commitment with a duration", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the quoteTerm" - }, - "duration": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "Duration of the Term associated with this item" - }, - "name": { - "type": "string", - "description": "Name of the quoteTerm" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteTerm.schema.json", + "title": "QuoteTerm", + "definitions": { + "QuoteTerm": { + "$id": "#QuoteTerm", + "description": "Description of aproduct Term linked to this quoteItem. This represent a commitment with a duration", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the quoteTerm" + }, + "duration": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "Duration of the Term associated with this item" + }, + "name": { + "type": "string", + "description": "Name of the quoteTerm" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/Recommendation.schema.json b/Product/Recommendation.schema.json index 4b31edef..2019bbb5 100644 --- a/Product/Recommendation.schema.json +++ b/Product/Recommendation.schema.json @@ -1,69 +1,69 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Recommendation.schema.json", - "title": "Recommendation", - "definitions": { - "Recommendation": { - "$id": "#Recommendation", - "description": "Recommendation API is used to recommend offering quickly based on the history and real-time context of customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omni-channel.", - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "href": { - "type": "string", - "description": "Hypertext Reference of the recommendation" - }, - "id": { - "type": "string", - "description": "Unique identifier of recommendation" - }, - "name": { - "type": "string", - "description": "Name of recommendation" - }, - "recommendationType": { - "type": "string", - "description": "The type of recommendation" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period in which the recommendation is valid" - }, - "order": { - "$ref": "ProductOrderRef.schema.json#ProductOrderRef" - }, - "location": { - "$ref": "../Common/GeographicLocationRef.schema.json#GeographicLocationRef", - "description": "The geographic location which the recommendation is related to" - }, - "channel": { - "$ref": "../Customer/ChannelRef.schema.json#ChannelRef" - }, - "category": { - "$ref": "../Product/CategoryRef.schema.json#CategoryRef", - "description": "The category for grouping recommendations" - }, - "shoppingCart": { - "$ref": "../Customer/ShoppingCartRef.schema.json#ShoppingCartRef", - "description": "The shopping cart which the recommendation is related to" - }, - "party": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "item": { - "type": "array", - "items": { - "$ref": "RecommendationItem.schema.json#RecommendationItem" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Recommendation.schema.json", + "title": "Recommendation", + "definitions": { + "Recommendation": { + "$id": "#Recommendation", + "description": "Recommendation API is used to recommend offering quickly based on the history and real-time context of customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omni-channel.", + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "href": { + "type": "string", + "description": "Hypertext Reference of the recommendation" + }, + "id": { + "type": "string", + "description": "Unique identifier of recommendation" + }, + "name": { + "type": "string", + "description": "Name of recommendation" + }, + "recommendationType": { + "type": "string", + "description": "The type of recommendation" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period in which the recommendation is valid" + }, + "order": { + "$ref": "../Customer/ProductOrderRef.schema.json#ProductOrderRef" + }, + "location": { + "$ref": "../Common/GeographicLocationRef.schema.json#GeographicLocationRef", + "description": "The geographic location which the recommendation is related to" + }, + "channel": { + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "category": { + "$ref": "CategoryRef.schema.json#CategoryRef", + "description": "The category for grouping recommendations" + }, + "shoppingCart": { + "$ref": "../Customer/ShoppingCartRef.schema.json#ShoppingCartRef", + "description": "The shopping cart which the recommendation is related to" + }, + "party": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "item": { + "type": "array", + "items": { + "$ref": "RecommendationItem.schema.json#RecommendationItem" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/RecommendationItem.schema.json b/Product/RecommendationItem.schema.json index 5db044f8..28c57915 100644 --- a/Product/RecommendationItem.schema.json +++ b/Product/RecommendationItem.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RecommendationItem.schema.json", - "title": "RecommendationItem", - "definitions": { - "RecommendationItem": { - "$id": "#RecommendationItem", - "description": "A list of recommendation items. Every item is a product offering and its rank.", - "type": "object", - "properties": { - "priority": { - "type": "integer", - "description": "The rank of the list of recommended offering." - }, - "offering": { - "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef", - "description": "Recommended product offering" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RecommendationItem.schema.json", + "title": "RecommendationItem", + "definitions": { + "RecommendationItem": { + "$id": "#RecommendationItem", + "description": "A list of recommendation items. Every item is a product offering and its rank.", + "type": "object", + "properties": { + "priority": { + "type": "integer", + "description": "The rank of the list of recommended offering." + }, + "offering": { + "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef", + "description": "Recommended product offering" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/RelatedProductOrderItem.schema.json b/Product/RelatedProductOrderItem.schema.json index 27430ad2..bd280a1a 100644 --- a/Product/RelatedProductOrderItem.schema.json +++ b/Product/RelatedProductOrderItem.schema.json @@ -1,43 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedProductOrderItem.schema.json", - "title": "RelatedProductOrderItem", - "definitions": { - "RelatedProductOrderItem": { - "type": "object", - "description": "RelatedProductOrderItem (ProductOrder item) .The product order item which triggered product creation/change/termination.", - "required": ["orderItemId","productOrderId"], - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "productOrderHref": { - "type": "string", - "description": "Reference of the related entity." - }, - "productOrderId": { - "type": "string", - "description": "Unique identifier of a related entity." - }, - "orderItemAction": { - "type": "string", - "description": "Action of the order item for this product" - }, - "orderItemId": { - "type": "string", - "description": "Identifier of the order item where the product was managed" - }, - "role": { - "type": "string", - "description": "role of the product order item for this product" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#/Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedProductOrderItem.schema.json", + "title": "RelatedProductOrderItem", + "definitions": { + "RelatedProductOrderItem": { + "$id": "#RelatedProductOrderItem", + "type": "object", + "description": "RelatedProductOrderItem (ProductOrder item) .The product order item which triggered product creation/change/termination.", + "required": [ + "orderItemId", + "productOrderId" + ], + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "productOrderHref": { + "type": "string", + "description": "Reference of the related entity." + }, + "productOrderId": { + "type": "string", + "description": "Unique identifier of a related entity." + }, + "orderItemAction": { + "type": "string", + "description": "Action of the order item for this product" + }, + "orderItemId": { + "type": "string", + "description": "Identifier of the order item where the product was managed" + }, + "role": { + "type": "string", + "description": "role of the product order item for this product" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Product/TargetProductSchema.schema.json b/Product/TargetProductSchema.schema.json index 2612c400..533de1bc 100644 --- a/Product/TargetProductSchema.schema.json +++ b/Product/TargetProductSchema.schema.json @@ -1,24 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TargetProductSchema.schema.json", - "title": "TargetProductSchema", - "definitions": { - "TargetProductSchema": { - "$id": "#TargetProductSchema", - "type": "object", - "description": "The reference object to the schema and type of target product which is described by product specification", - "properties": { - "@type": { - "type": "string", - "description": "Class type of the target product" - }, - "@schemaLocation": { - "type": "string", - "format": "uri", - "description": "This field provides a link to the schema describing the target product" - } - }, - "required": ["@type", "@schemaLocation"] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TargetProductSchema.schema.json", + "title": "TargetProductSchema", + "definitions": { + "TargetProductSchema": { + "$id": "#TargetProductSchema", + "type": "object", + "description": "The reference object to the schema and type of target product which is described by product specification", + "properties": { + "@type": { + "type": "string", + "description": "Class type of the target product" + }, + "@schemaLocation": { + "type": "string", + "format": "uri", + "description": "This field provides a link to the schema describing the target product" } + }, + "required": [ + "@type", + "@schemaLocation" + ] } -} + } +} \ No newline at end of file diff --git a/Product/Usage.schema.json b/Product/Usage.schema.json index 4af8fcc3..85e6337b 100644 --- a/Product/Usage.schema.json +++ b/Product/Usage.schema.json @@ -1,65 +1,65 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Usage.schema.json", - "title": "Usage", - "definitions": { - "Usage": { - "$id": "#Usage", - "description": "An occurrence of employing a Product, Service, or Resource for its intended purpose, which is of interest to the business and can have charges applied to it. It is comprised of characteristics, which represent attributes of usage.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time", - "description": "Date of usage" - }, - "description": { - "type": "string", - "description": "Description of usage" - }, - "href": { - "type": "string", - "description": "Reference of usage" - }, - "id": { - "type": "string", - "description": "Usage unique identifier" - }, - "status": { - "type": "string", - "description": "Status of usage" - }, - "usageType": { - "type": "string", - "description": "Type of usage" - }, - "usageSpecification": { - "$ref": "UsageSpecificationRef.schema.json#UsageSpecificationRef" - }, - "usageCharacteristic": { - "type": "array", - "items": { - "$ref": "UsageCharacteristic.schema.json#UsageCharacteristic" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "ratedProductUsage": { - "type": "array", - "items": { - "$ref": "../Common/RatedProductUsage.schema.json#RatedProductUsage" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Usage.schema.json", + "title": "Usage", + "definitions": { + "Usage": { + "$id": "#Usage", + "description": "An occurrence of employing a Product, Service, or Resource for its intended purpose, which is of interest to the business and can have charges applied to it. It is comprised of characteristics, which represent attributes of usage.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "Date of usage" + }, + "description": { + "type": "string", + "description": "Description of usage" + }, + "href": { + "type": "string", + "description": "Reference of usage" + }, + "id": { + "type": "string", + "description": "Usage unique identifier" + }, + "status": { + "type": "string", + "description": "Status of usage" + }, + "usageType": { + "type": "string", + "description": "Type of usage" + }, + "usageSpecification": { + "$ref": "UsageSpecificationRef.schema.json#UsageSpecificationRef" + }, + "usageCharacteristic": { + "type": "array", + "items": { + "$ref": "UsageCharacteristic.schema.json#UsageCharacteristic" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "ratedProductUsage": { + "type": "array", + "items": { + "$ref": "../Common/RatedProductUsage.schema.json#RatedProductUsage" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/UsageCharacteristic.schema.json b/Product/UsageCharacteristic.schema.json index 161e509b..c4b28229 100644 --- a/Product/UsageCharacteristic.schema.json +++ b/Product/UsageCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageCharacteristic.schema.json", - "title": "UsageCharacteristic", - "definitions": { - "UsageCharacteristic": { - "$id": "#UsageCharacteristic", - "description": "Provides the value of a given characteristic", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the usage characteristic" - }, - "value": { - "type": "string", - "description": "A discrete value that the characteristic can take on" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageCharacteristic.schema.json", + "title": "UsageCharacteristic", + "definitions": { + "UsageCharacteristic": { + "$id": "#UsageCharacteristic", + "description": "Provides the value of a given characteristic", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the usage characteristic" + }, + "value": { + "type": "string", + "description": "A discrete value that the characteristic can take on" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/UsageConsumptionReport.schema.json b/Product/UsageConsumptionReport.schema.json index 198f08ab..7478246c 100644 --- a/Product/UsageConsumptionReport.schema.json +++ b/Product/UsageConsumptionReport.schema.json @@ -1,50 +1,50 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageConsumptionReport.schema.json", - "title": "UsageConsumptionReport", - "definitions": { - "UsageConsumptionReport": { - "$id": "#UsageConsumptionReport", - "type": "object", - "description": "An usage consumption report enables to know at a given point the balances and the consumption counters related to various buckets (SMS, Voice, Data for example). It could be calculated for a device identified by a public key (msisdn number for a mobile device for example or PSTN or VOIP number for a fix device), for a subscribed offer or option or for an user.", - "properties": { - "bucket": { - "type": "array", - "description": "Bucket(s) included in the offer or option subscribed.", - "items": { - "$ref": "UsageVolumeProduct.schema.json#UsageVolumeProduct" - } - }, - "description": { - "type": "string", - "description": "Free short text describing the usage consumption report content" - }, - "effectiveDate": { - "type": "string", - "format": "date-time", - "description": "Date and time when the usage consumption report was calculated and generated" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the usage consumption report. The report is calculated at the time of the request by the server. Generally, this report is not recorded by the server. If it is, an unique identifier of the usage consumption report is given by the server" - }, - "id": { - "type": "string", - "description": "The report is calculated at the time of the request by the server. Generally, this report is not recorded by the server. If it is, an unique identifier of the usage consumption report is given by the server" - }, - "name": { - "type": "string", - "description": "Usage consumption report name" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageConsumptionReport.schema.json", + "title": "UsageConsumptionReport", + "definitions": { + "UsageConsumptionReport": { + "$id": "#UsageConsumptionReport", + "type": "object", + "description": "An usage consumption report enables to know at a given point the balances and the consumption counters related to various buckets (SMS, Voice, Data for example). It could be calculated for a device identified by a public key (msisdn number for a mobile device for example or PSTN or VOIP number for a fix device), for a subscribed offer or option or for an user.", + "properties": { + "bucket": { + "type": "array", + "description": "Bucket(s) included in the offer or option subscribed.", + "items": { + "$ref": "UsageVolumeProduct.schema.json#UsageVolumeProduct" + } + }, + "description": { + "type": "string", + "description": "Free short text describing the usage consumption report content" + }, + "effectiveDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the usage consumption report was calculated and generated" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the usage consumption report. The report is calculated at the time of the request by the server. Generally, this report is not recorded by the server. If it is, an unique identifier of the usage consumption report is given by the server" + }, + "id": { + "type": "string", + "description": "The report is calculated at the time of the request by the server. Generally, this report is not recorded by the server. If it is, an unique identifier of the usage consumption report is given by the server" + }, + "name": { + "type": "string", + "description": "Usage consumption report name" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/UsageConsumptionReportRef.schema.json b/Product/UsageConsumptionReportRef.schema.json index 88d21c11..a5f7f36d 100644 --- a/Product/UsageConsumptionReportRef.schema.json +++ b/Product/UsageConsumptionReportRef.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageConsumptionReportRef.schema.json", - "title": "UsageConsumptionReportRef", - "definitions": { - "UsageConsumptionReportRef": { - "$id": "#UsageConsumptionReportRef", - "type": "object", - "description": "Reference of an usage consumption report", - "properties": { - "description": { - "type": "string", - "description": "Free short text describing the usage consumption report content" - }, - "effectiveDate": { - "type": "string", - "format": "date-time", - "description": "Date and time when the usage consumption report was calculated and generated" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the usage consumption report" - }, - "id": { - "type": "string", - "description": "Unique identifier of the usage consumption report given by the server" - }, - "name": { - "type": "string", - "description": "Usage consumption report name" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageConsumptionReportRef.schema.json", + "title": "UsageConsumptionReportRef", + "definitions": { + "UsageConsumptionReportRef": { + "$id": "#UsageConsumptionReportRef", + "type": "object", + "description": "Reference of an usage consumption report", + "properties": { + "description": { + "type": "string", + "description": "Free short text describing the usage consumption report content" + }, + "effectiveDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the usage consumption report was calculated and generated" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the usage consumption report" + }, + "id": { + "type": "string", + "description": "Unique identifier of the usage consumption report given by the server" + }, + "name": { + "type": "string", + "description": "Usage consumption report name" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/UsageConsumptionReportRequest.schema.json b/Product/UsageConsumptionReportRequest.schema.json index e40e833f..1293af61 100644 --- a/Product/UsageConsumptionReportRequest.schema.json +++ b/Product/UsageConsumptionReportRequest.schema.json @@ -1,62 +1,62 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageConsumptionReportRequest.schema.json", - "title": "UsageConsumptionReportRequest", - "definitions": { - "UsageConsumptionReportRequest": { - "$id": "#UsageConsumptionReportRequest", - "type": "object", - "description": "An UsageConsumptionReportRequest allows to manage the calculation request of an usage consumption report", - "properties": { - "bucket": { - "type": "array", - "description": "Reference of the buckets for which the usage consumption report is requested", - "items": { - "$ref": "UsageVolumeProductRef.schema.json#/definitions/UsageVolumeProductRef" - } - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the request creation" - }, - "href": { - "type": "string", - "description": "Reference of the usage consumption report request" - }, - "id": { - "type": "string", - "description": "Unique identifier of the usage consumption report request given by the server" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date when the status was last changed" - }, - "product": { - "$ref": "NetworkProductRef.schema.json#NetworkProductRef", - "description": "Network product reference for which the usage consumption report is requested" - }, - "relatedParty": { - "type": "array", - "description": "Reference and role of the related parties for which the usage consumption report is requested", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "status": { - "type": "string", - "description": "Status of the usage consumption report request (InProgress or done)" - }, - "usageConsumptionReport": { - "$ref": "UsageConsumptionReportRef.schema.json#UsageConsumptionReportRef", - "description": "References of the usage consumption report (given when it has been calculated and the status of the request is done)" - }, - "validPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Validity period" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageConsumptionReportRequest.schema.json", + "title": "UsageConsumptionReportRequest", + "definitions": { + "UsageConsumptionReportRequest": { + "$id": "#UsageConsumptionReportRequest", + "type": "object", + "description": "An UsageConsumptionReportRequest allows to manage the calculation request of an usage consumption report", + "properties": { + "bucket": { + "type": "array", + "description": "Reference of the buckets for which the usage consumption report is requested", + "items": { + "$ref": "UsageVolumeProductRef.schema.json#UsageVolumeProductRef" + } + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the request creation" + }, + "href": { + "type": "string", + "description": "Reference of the usage consumption report request" + }, + "id": { + "type": "string", + "description": "Unique identifier of the usage consumption report request given by the server" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date when the status was last changed" + }, + "product": { + "$ref": "NetworkProductRef.schema.json#NetworkProductRef", + "description": "Network product reference for which the usage consumption report is requested" + }, + "relatedParty": { + "type": "array", + "description": "Reference and role of the related parties for which the usage consumption report is requested", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "status": { + "type": "string", + "description": "Status of the usage consumption report request (InProgress or done)" + }, + "usageConsumptionReport": { + "$ref": "UsageConsumptionReportRef.schema.json#UsageConsumptionReportRef", + "description": "References of the usage consumption report (given when it has been calculated and the status of the request is done)" + }, + "validPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Validity period" } + } } -} + } +} \ No newline at end of file diff --git a/Product/UsageConsumptionReportRequestIn.schema.json b/Product/UsageConsumptionReportRequestIn.schema.json index 79e30c96..d5005a92 100644 --- a/Product/UsageConsumptionReportRequestIn.schema.json +++ b/Product/UsageConsumptionReportRequestIn.schema.json @@ -1,41 +1,41 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageConsumptionReportRequestIn.schema.json", - "title": "UsageConsumptionReportRequestIn", - "definitions": { - "UsageConsumptionReportRequestIn": { - "$id": "#UsageConsumptionReportRequestIn", - "type": "object", - "description": "An UsageConsumptionReportRequest allows to manage the calculation request of an usage consumption report", - "properties": { - "bucket": { - "type": "array", - "description": "Reference of the buckets for which the usage consumption report is requested", - "items": { - "$ref": "UsageVolumeProductRef.schema.json#UsageVolumeProductRef" - } - }, - "product": { - "$ref": "NetworkProductRef.schema.json#/definitions/NetworkProductRef", - "description": "Network product reference for which the usage consumption report is requested" - }, - "relatedParty": { - "type": "array", - "description": "Reference and role of the related parties for which the usage consumption report is requested", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "validPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Validity period" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageConsumptionReportRequestIn.schema.json", + "title": "UsageConsumptionReportRequestIn", + "definitions": { + "UsageConsumptionReportRequestIn": { + "$id": "#UsageConsumptionReportRequestIn", + "type": "object", + "description": "An UsageConsumptionReportRequest allows to manage the calculation request of an usage consumption report", + "properties": { + "bucket": { + "type": "array", + "description": "Reference of the buckets for which the usage consumption report is requested", + "items": { + "$ref": "UsageVolumeProductRef.schema.json#UsageVolumeProductRef" + } + }, + "product": { + "$ref": "NetworkProductRef.schema.json#NetworkProductRef", + "description": "Network product reference for which the usage consumption report is requested" + }, + "relatedParty": { + "type": "array", + "description": "Reference and role of the related parties for which the usage consumption report is requested", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "validPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Validity period" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/UsageSpecCharacteristic.schema.json b/Product/UsageSpecCharacteristic.schema.json index dc95de60..5a1f1981 100644 --- a/Product/UsageSpecCharacteristic.schema.json +++ b/Product/UsageSpecCharacteristic.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageSpecCharacteristic.schema.json", - "title": "UsageSpecCharacteristic", - "definitions": { - "UsageSpecCharacteristic": { - "$id": "#UsageSpecCharacteristic", - "description": "A detailed description of an attribute that defines a particular type of usage, described by its name, category, type, presence and a set of allowed values", - "type": "object", - "properties": { - "configurable": { - "type": "boolean", - "description": "Boolean indicating if usageSpecCharacteristic is configurable or not" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the usage specification characteristic is" - }, - "name": { - "type": "string", - "description": "The name of the usage specification characteristic" - }, - "usageSpecCharacteristicValue": { - "type": "array", - "items": { - "$ref": "UsageSpecCharacteristicValue.schema.json#UsageSpecCharacteristicValue" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageSpecCharacteristic.schema.json", + "title": "UsageSpecCharacteristic", + "definitions": { + "UsageSpecCharacteristic": { + "$id": "#UsageSpecCharacteristic", + "description": "A detailed description of an attribute that defines a particular type of usage, described by its name, category, type, presence and a set of allowed values", + "type": "object", + "properties": { + "configurable": { + "type": "boolean", + "description": "Boolean indicating if usageSpecCharacteristic is configurable or not" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the usage specification characteristic is" + }, + "name": { + "type": "string", + "description": "The name of the usage specification characteristic" + }, + "usageSpecCharacteristicValue": { + "type": "array", + "items": { + "$ref": "UsageSpecCharacteristicValue.schema.json#UsageSpecCharacteristicValue" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/UsageSpecCharacteristicValue.schema.json b/Product/UsageSpecCharacteristicValue.schema.json index 0d1aaa6c..12d4781b 100644 --- a/Product/UsageSpecCharacteristicValue.schema.json +++ b/Product/UsageSpecCharacteristicValue.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageSpecCharacteristicValue.schema.json", - "title": "UsageSpecCharacteristicValue", - "definitions": { - "UsageSpecCharacteristicValue": { - "$id": "#UsageSpecCharacteristicValue", - "description": "A value that can be assigned to a UsageSpecCharacteristic.", - "type": "object", - "properties": { - "default": { - "type": "boolean", - "description": "If true, this is the default value for a characteristic" - }, - "value": { - "type": "string", - "description": "A narrative that explains in detail what the usage specification characteristic is" - }, - "valueFrom": { - "type": "string", - "description": "The low range value that a characteristic can take on" - }, - "valueTo": { - "type": "string", - "description": "The upper range value that a characteristic can take on" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageSpecCharacteristicValue.schema.json", + "title": "UsageSpecCharacteristicValue", + "definitions": { + "UsageSpecCharacteristicValue": { + "$id": "#UsageSpecCharacteristicValue", + "description": "A value that can be assigned to a UsageSpecCharacteristic.", + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "If true, this is the default value for a characteristic" + }, + "value": { + "type": "string", + "description": "A narrative that explains in detail what the usage specification characteristic is" + }, + "valueFrom": { + "type": "string", + "description": "The low range value that a characteristic can take on" + }, + "valueTo": { + "type": "string", + "description": "The upper range value that a characteristic can take on" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/UsageSpecification.schema.json b/Product/UsageSpecification.schema.json index 163a4089..51b17d23 100644 --- a/Product/UsageSpecification.schema.json +++ b/Product/UsageSpecification.schema.json @@ -1,45 +1,45 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageSpecification.schema.json", - "title": "UsageSpecification", - "definitions": { - "UsageSpecification": { - "$id": "#UsageSpecification", - "description": "A detailed description of a usage event that are of interest to the business and can have charges applied to it. It is comprised of characteristics, which define all attributes known for a particular type of usage.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail what the usage specification is" - }, - "href": { - "type": "string", - "description": "Reference of usage specification" - }, - "id": { - "type": "string", - "description": "Usage specification unique identifier" - }, - "name": { - "type": "string", - "description": "The name of the usage specification." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the usage specification is valid" - }, - "usageSpecCharacteristic": { - "type": "array", - "items": { - "$ref": "UsageSpecCharacteristic.schema.json#UsageSpecCharacteristic" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageSpecification.schema.json", + "title": "UsageSpecification", + "definitions": { + "UsageSpecification": { + "$id": "#UsageSpecification", + "description": "A detailed description of a usage event that are of interest to the business and can have charges applied to it. It is comprised of characteristics, which define all attributes known for a particular type of usage.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail what the usage specification is" + }, + "href": { + "type": "string", + "description": "Reference of usage specification" + }, + "id": { + "type": "string", + "description": "Usage specification unique identifier" + }, + "name": { + "type": "string", + "description": "The name of the usage specification." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the usage specification is valid" + }, + "usageSpecCharacteristic": { + "type": "array", + "items": { + "$ref": "UsageSpecCharacteristic.schema.json#UsageSpecCharacteristic" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/UsageSpecificationRef.schema.json b/Product/UsageSpecificationRef.schema.json index e1101e81..b1ace416 100644 --- a/Product/UsageSpecificationRef.schema.json +++ b/Product/UsageSpecificationRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageSpecificationRef.schema.json", - "title": "UsageSpecificationRef", - "definitions": { - "UsageSpecificationRef": { - "$id": "#UsageSpecificationRef", - "description": "UsageSpecification reference. UsageSpecification is a detailed description of a usage event that are of interest to the business and can have charges applied to it. It is comprised of characteristics, which define all attributes known for a particular type of usage.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of usage specification" - }, - "id": { - "type": "string", - "description": "Usage specification unique identifier" - }, - "name": { - "type": "string", - "description": "The name of the usage specification" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageSpecificationRef.schema.json", + "title": "UsageSpecificationRef", + "definitions": { + "UsageSpecificationRef": { + "$id": "#UsageSpecificationRef", + "description": "UsageSpecification reference. UsageSpecification is a detailed description of a usage event that are of interest to the business and can have charges applied to it. It is comprised of characteristics, which define all attributes known for a particular type of usage.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of usage specification" + }, + "id": { + "type": "string", + "description": "Usage specification unique identifier" + }, + "name": { + "type": "string", + "description": "The name of the usage specification" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/UsageVolumeBalance.schema.json b/Product/UsageVolumeBalance.schema.json index 224e2d0c..cd102f30 100644 --- a/Product/UsageVolumeBalance.schema.json +++ b/Product/UsageVolumeBalance.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageVolumeBalance.schema.json", - "title": "UsageVolumeBalance", - "definitions": { - "UsageVolumeBalance": { - "$id": "#UsageVolumeBalance", - "type": "object", - "description": "The balance (called UsageVolumeBalance in the SID model) defines the remaining allowed product usage quantity in terms of volume, time, currency or events. It corresponds to the initial allowed usage quantity minus the usage consumed on the bucket.", - "properties": { - "remainingValue": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "Numeric remaining value for the bucket given in the unit (for example 1.9). This numeric value could be used for calculation for example" - }, - "remainingValueName": { - "type": "string", - "description": "Remaining value in a formatted string for the bucket given in the balance unit (for example 1.9 Gb). This formatted string could be used for display needs for example" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Balance period between a start date time and an end date time. For prepaid bucket, the period of the balance is between the effective date of the usage consumption report generation and the end date of the bucket. For postpaid bucket, the period of the balance is between the effective date of the usage consumption report generation and the next bill date." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageVolumeBalance.schema.json", + "title": "UsageVolumeBalance", + "definitions": { + "UsageVolumeBalance": { + "$id": "#UsageVolumeBalance", + "type": "object", + "description": "The balance (called UsageVolumeBalance in the SID model) defines the remaining allowed product usage quantity in terms of volume, time, currency or events. It corresponds to the initial allowed usage quantity minus the usage consumed on the bucket.", + "properties": { + "remainingValue": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "Numeric remaining value for the bucket given in the unit (for example 1.9). This numeric value could be used for calculation for example" + }, + "remainingValueName": { + "type": "string", + "description": "Remaining value in a formatted string for the bucket given in the balance unit (for example 1.9 Gb). This formatted string could be used for display needs for example" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Balance period between a start date time and an end date time. For prepaid bucket, the period of the balance is between the effective date of the usage consumption report generation and the end date of the bucket. For postpaid bucket, the period of the balance is between the effective date of the usage consumption report generation and the next bill date." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/UsageVolumeProduct.schema.json b/Product/UsageVolumeProduct.schema.json index 308abfb8..5b8f77a7 100644 --- a/Product/UsageVolumeProduct.schema.json +++ b/Product/UsageVolumeProduct.schema.json @@ -1,53 +1,53 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageVolumeProduct.schema.json", - "title": "UsageVolumeProduct", - "definitions": { - "UsageVolumeProduct": { - "$id": "#UsageVolumeProduct", - "type": "object", - "description": "A bucket (called UsageVolumeProduct in the SID model) represents a quantity of usage, as 2 hours national calls or 50 sms for example. It could be either a quantity or an amount in a currency (i.e. It could represent a fixed number of SMS, MMS, minutes of calls, quantity of data, number of events as well as a specific amount in a given currency). It requires one or more network products from which usages will debit the bucket.", - "properties": { - "bucketBalance": { - "type": "array", - "items": { - "$ref": "UsageVolumeBalance.schema.json#UsageVolumeBalance" - } - }, - "bucketCounter": { - "type": "array", - "items": { - "$ref": "ConsumptionSummary.schema.json#ConsumptionSummary" - } - }, - "id": { - "type": "string", - "description": "Unique identifier of the bucket" - }, - "isShared": { - "type": "boolean", - "description": "True if the bucket is shared between several devices or users" - }, - "name": { - "type": "string", - "description": "Bucket name" - }, - "product": { - "type": "array", - "items": { - "$ref": "NetworkProduct.schema.json#NetworkProduct" - } - }, - "usageType": { - "type": "string", - "description": "Type of usage concerned by the bucket, such as voice, sms, data" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageVolumeProduct.schema.json", + "title": "UsageVolumeProduct", + "definitions": { + "UsageVolumeProduct": { + "$id": "#UsageVolumeProduct", + "type": "object", + "description": "A bucket (called UsageVolumeProduct in the SID model) represents a quantity of usage, as 2 hours national calls or 50 sms for example. It could be either a quantity or an amount in a currency (i.e. It could represent a fixed number of SMS, MMS, minutes of calls, quantity of data, number of events as well as a specific amount in a given currency). It requires one or more network products from which usages will debit the bucket.", + "properties": { + "bucketBalance": { + "type": "array", + "items": { + "$ref": "UsageVolumeBalance.schema.json#UsageVolumeBalance" + } + }, + "bucketCounter": { + "type": "array", + "items": { + "$ref": "ConsumptionSummary.schema.json#ConsumptionSummary" + } + }, + "id": { + "type": "string", + "description": "Unique identifier of the bucket" + }, + "isShared": { + "type": "boolean", + "description": "True if the bucket is shared between several devices or users" + }, + "name": { + "type": "string", + "description": "Bucket name" + }, + "product": { + "type": "array", + "items": { + "$ref": "NetworkProduct.schema.json#NetworkProduct" + } + }, + "usageType": { + "type": "string", + "description": "Type of usage concerned by the bucket, such as voice, sms, data" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Product/UsageVolumeProductRef.schema.json b/Product/UsageVolumeProductRef.schema.json index 94c54060..a85e1514 100644 --- a/Product/UsageVolumeProductRef.schema.json +++ b/Product/UsageVolumeProductRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageVolumeProductRef.schema.json", - "title": "UsageVolumeProductRef", - "definitions": { - "UsageVolumeProductRef": { - "$id": "#UsageVolumeProductRef", - "type": "object", - "description": "Reference of a bucket", - "properties": { - "@referredType": { - "type": "string", - "description": "Generic attribute indicating the name of the class type of the referred resource entity" - }, - "id": { - "type": "string", - "description": "Unique identifier of the bucket" - }, - "name": { - "type": "string", - "description": "Bucket name" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageVolumeProductRef.schema.json", + "title": "UsageVolumeProductRef", + "definitions": { + "UsageVolumeProductRef": { + "$id": "#UsageVolumeProductRef", + "type": "object", + "description": "Reference of a bucket", + "properties": { + "@referredType": { + "type": "string", + "description": "Generic attribute indicating the name of the class type of the referred resource entity" + }, + "id": { + "type": "string", + "description": "Unique identifier of the bucket" + }, + "name": { + "type": "string", + "description": "Bucket name" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Resource/LogicalResource.schema.json b/Resource/LogicalResource.schema.json index a982af8d..56b570e9 100644 --- a/Resource/LogicalResource.schema.json +++ b/Resource/LogicalResource.schema.json @@ -1,94 +1,94 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LogicalResource.schema.json", - "title": "LogicalResource", - "definitions": { - "LogicalResource": { - "$id": "#LogicalResource", - "description": "Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses) in the inventory.", - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "The value of the logical resource, such as: 0044746712345 for an MSISDN" - }, - "category": { - "type": "string", - "description": "Category of the concrete resource, such as: Gold, Silver for MSISDN concrete resource" - }, - "description": { - "type": "string", - "description": "Free-text description of the resource" - }, - "endDate": { - "type": "string", - "format": "date-time", - "description": "The date till the resource is effective" - }, - "href": { - "type": "string", - "description": "The URI for the object itself." - }, - "id": { - "type": "string", - "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type" - }, - "lifecycleState": { - "type": "string", - "description": "The life cycle state of the resource" - }, - "name": { - "type": "string", - "description": "A string used to give a name to the resource" - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "A date time( DateTime). The date from which the resource is effective" - }, - "version": { - "type": "string", - "description": "A field that identifies the specific version of an instance of a resource" - }, - "resourceRelationship": { - "type": "array", - "items": { - "$ref": "ResourceRelationship.schema.json#ResourceRelationship" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "ResourceCharacteristic.schema.json#ResourceCharacteristic" - } - }, - "place": { - "$ref": "../Common/Place.schema.json#Place" - }, - "partyRole": { - "type": "array", - "items": { - "$ref": "../EngagedParty/PartyRoleRef.schema.json#PartyRoleRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LogicalResource.schema.json", + "title": "LogicalResource", + "definitions": { + "LogicalResource": { + "$id": "#LogicalResource", + "description": "Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses) in the inventory.", + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The value of the logical resource, such as: 0044746712345 for an MSISDN" + }, + "category": { + "type": "string", + "description": "Category of the concrete resource, such as: Gold, Silver for MSISDN concrete resource" + }, + "description": { + "type": "string", + "description": "Free-text description of the resource" + }, + "endDate": { + "type": "string", + "format": "date-time", + "description": "The date till the resource is effective" + }, + "href": { + "type": "string", + "description": "The URI for the object itself." + }, + "id": { + "type": "string", + "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type" + }, + "lifecycleState": { + "type": "string", + "description": "The life cycle state of the resource" + }, + "name": { + "type": "string", + "description": "A string used to give a name to the resource" + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "A date time( DateTime). The date from which the resource is effective" + }, + "version": { + "type": "string", + "description": "A field that identifies the specific version of an instance of a resource" + }, + "resourceRelationship": { + "type": "array", + "items": { + "$ref": "ResourceRelationship.schema.json#ResourceRelationship" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "ResourceCharacteristic.schema.json#ResourceCharacteristic" + } + }, + "place": { + "$ref": "../Common/Place.schema.json#Place" + }, + "partyRole": { + "type": "array", + "items": { + "$ref": "../EngagedParty/PartyRoleRef.schema.json#PartyRoleRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Resource/PhysicalResource.schema.json b/Resource/PhysicalResource.schema.json index 2b305247..318f7f93 100644 --- a/Resource/PhysicalResource.schema.json +++ b/Resource/PhysicalResource.schema.json @@ -1,107 +1,107 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PhysicalResource.schema.json", - "title": "PhysicalResource", - "definitions": { - "PhysicalResource": { - "$id": "#PhysicalResource", - "description": "Physical resource is a type of resource that describes the common set of attributes shared by all concrete physical resources (e.g. EQUIPMENT) in the inventory.", - "type": "object", - "properties": { - "manufactureDate": { - "type": "string", - "format": "date-time", - "description": "This is a string attribute that defines the date of manufacture of this item in the fixed format \"dd/mm/yyyy\". This is an optional attribute." - }, - "powerState": { - "type": "string", - "description": "This defines the current power status of the hardware item. Values include:\n\n 0: Unknown\n 1: Not Applicable\n 2: No Power Applied\n 3: Full Power Applied\n 4: Power Save - Normal\n 5: Power Save - Degraded\n 6: Power Save - Standby\n 7: Power Save - Critical\n 8: Power Save - Low Power Mode\n 9: Power Save - Unknown\n 10: Power Cycle\n 11: Power Warning\n 12: Power Off" - }, - "serialNumber": { - "type": "string", - "description": "This is a string that represents a manufacturer-allocated number used to identify different instances of the same hardware item. The ModelNumber and PartNumber attributes are used to identify different types of hardware items. This is a REQUIRED attribute." - }, - "versionNumber": { - "type": "string", - "description": "This is a string that identifies the version of this object. This is an optional attribute." - }, - "category": { - "type": "string", - "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" - }, - "description": { - "type": "string", - "description": "free-text description of the resource" - }, - "endDate": { - "type": "string", - "format": "date-time", - "description": "A date time( DateTime). The date till the resource is effective" - }, - "href": { - "type": "string", - "description": "The URI for the object itself." - }, - "id": { - "type": "string", - "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." - }, - "lifecycleState": { - "type": "string", - "description": "The life cycle state of the resource." - }, - "name": { - "type": "string", - "description": "A string used to give a name to the resource" - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "A date time( DateTime). The date from which the resource is effective" - }, - "version": { - "type": "string", - "description": "A field that identifies the specific version of an instance of a resource." - }, - "resourceRelationship": { - "type": "array", - "items": { - "$ref": "ResourceRelationship.schema.json#ResourceRelationship" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "ResourceCharacteristic.schema.json#ResourceCharacteristic" - } - }, - "place": { - "$ref": "../Common/Place.schema.json#Place" - }, - "partyRole": { - "type": "array", - "items": { - "$ref": "../EngagedParty/PartyRoleRef.schema.json#PartyRoleRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PhysicalResource.schema.json", + "title": "PhysicalResource", + "definitions": { + "PhysicalResource": { + "$id": "#PhysicalResource", + "description": "Physical resource is a type of resource that describes the common set of attributes shared by all concrete physical resources (e.g. EQUIPMENT) in the inventory.", + "type": "object", + "properties": { + "manufactureDate": { + "type": "string", + "format": "date-time", + "description": "This is a string attribute that defines the date of manufacture of this item in the fixed format \"dd/mm/yyyy\". This is an optional attribute." + }, + "powerState": { + "type": "string", + "description": "This defines the current power status of the hardware item. Values include:\n\n 0: Unknown\n 1: Not Applicable\n 2: No Power Applied\n 3: Full Power Applied\n 4: Power Save - Normal\n 5: Power Save - Degraded\n 6: Power Save - Standby\n 7: Power Save - Critical\n 8: Power Save - Low Power Mode\n 9: Power Save - Unknown\n 10: Power Cycle\n 11: Power Warning\n 12: Power Off" + }, + "serialNumber": { + "type": "string", + "description": "This is a string that represents a manufacturer-allocated number used to identify different instances of the same hardware item. The ModelNumber and PartNumber attributes are used to identify different types of hardware items. This is a REQUIRED attribute." + }, + "versionNumber": { + "type": "string", + "description": "This is a string that identifies the version of this object. This is an optional attribute." + }, + "category": { + "type": "string", + "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" + }, + "description": { + "type": "string", + "description": "free-text description of the resource" + }, + "endDate": { + "type": "string", + "format": "date-time", + "description": "A date time( DateTime). The date till the resource is effective" + }, + "href": { + "type": "string", + "description": "The URI for the object itself." + }, + "id": { + "type": "string", + "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." + }, + "lifecycleState": { + "type": "string", + "description": "The life cycle state of the resource." + }, + "name": { + "type": "string", + "description": "A string used to give a name to the resource" + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "A date time( DateTime). The date from which the resource is effective" + }, + "version": { + "type": "string", + "description": "A field that identifies the specific version of an instance of a resource." + }, + "resourceRelationship": { + "type": "array", + "items": { + "$ref": "ResourceRelationship.schema.json#ResourceRelationship" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "ResourceCharacteristic.schema.json#ResourceCharacteristic" + } + }, + "place": { + "$ref": "../Common/Place.schema.json#Place" + }, + "partyRole": { + "type": "array", + "items": { + "$ref": "../EngagedParty/PartyRoleRef.schema.json#PartyRoleRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Resource/RealizingResourceRef.schema.json b/Resource/RealizingResourceRef.schema.json index 779e1bfe..7b039216 100644 --- a/Resource/RealizingResourceRef.schema.json +++ b/Resource/RealizingResourceRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RealizingResourceRef.schema.json", - "title": "RealizingResourceRef", - "definitions": { - "RealizingResourceRef": { - "type": "object", - "description": "RealizingResource reference. RealizingResource is a link to the resource that realizes the product.", - "properties": { - }, - "allOf": [ - { - "$ref": "EntityRef.schema.json#/EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RealizingResourceRef.schema.json", + "title": "RealizingResourceRef", + "definitions": { + "RealizingResourceRef": { + "$id": "#RealizingResourceRef", + "type": "object", + "description": "RealizingResource reference. RealizingResource is a link to the resource that realizes the product.", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } + } } \ No newline at end of file diff --git a/Resource/Resource.schema.json b/Resource/Resource.schema.json index 7e3fbea5..ad158e55 100644 --- a/Resource/Resource.schema.json +++ b/Resource/Resource.schema.json @@ -1,90 +1,90 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Resource.schema.json", - "title": "Resource", - "definitions": { - "Resource": { - "$id": "#Resource", - "description": "Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory.", - "type": "object", - "properties": { - "category": { - "type": "string", - "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" - }, - "description": { - "type": "string", - "description": "free-text description of the resource" - }, - "endDate": { - "type": "string", - "format": "date-time", - "description": "A date time( DateTime). The date till the resource is effective" - }, - "href": { - "type": "string", - "description": "The URI for the object itself." - }, - "id": { - "type": "string", - "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." - }, - "lifecycleState": { - "type": "string", - "description": "The life cycle state of the resource." - }, - "name": { - "type": "string", - "description": "A string used to give a name to the resource" - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "A date time( DateTime). The date from which the resource is effective" - }, - "version": { - "type": "string", - "description": "A field that identifies the specific version of an instance of a resource." - }, - "resourceRelationship": { - "type": "array", - "items": { - "$ref": "ResourceRelationship.schema.json#ResourceRelationship" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "ResourceCharacteristic.schema.json#ResourceCharacteristic" - } - }, - "place": { - "$ref": "../Common/Place.schema.json#Place" - }, - "partyRole": { - "type": "array", - "items": { - "$ref": "../EngagedParty/PartyRoleRef.schema.json#PartyRoleRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Resource.schema.json", + "title": "Resource", + "definitions": { + "Resource": { + "$id": "#Resource", + "description": "Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory.", + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" + }, + "description": { + "type": "string", + "description": "free-text description of the resource" + }, + "endDate": { + "type": "string", + "format": "date-time", + "description": "A date time( DateTime). The date till the resource is effective" + }, + "href": { + "type": "string", + "description": "The URI for the object itself." + }, + "id": { + "type": "string", + "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." + }, + "lifecycleState": { + "type": "string", + "description": "The life cycle state of the resource." + }, + "name": { + "type": "string", + "description": "A string used to give a name to the resource" + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "A date time( DateTime). The date from which the resource is effective" + }, + "version": { + "type": "string", + "description": "A field that identifies the specific version of an instance of a resource." + }, + "resourceRelationship": { + "type": "array", + "items": { + "$ref": "ResourceRelationship.schema.json#ResourceRelationship" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "ResourceCharacteristic.schema.json#ResourceCharacteristic" + } + }, + "place": { + "$ref": "../Common/Place.schema.json#Place" + }, + "partyRole": { + "type": "array", + "items": { + "$ref": "../EngagedParty/PartyRoleRef.schema.json#PartyRoleRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Resource/ResourceAlarmRef.schema.json b/Resource/ResourceAlarmRef.schema.json index 2481819a..006f9c13 100644 --- a/Resource/ResourceAlarmRef.schema.json +++ b/Resource/ResourceAlarmRef.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceAlarmRef.schema.json", - "title": "ResourceAlarmRef", - "definitions": { - "ResourceAlarmRef": { - "$id": "#ResourceAlarmRef", - "type": "object", - "description": "A set of alarm ids identifying the alarms that are underlying this problem.", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "changeRequest": { - "$ref": "../Common/ChangeRequestRef.schema.json#/definitions/ChangeRequestRef" - }, - "href": { - "type": "string", - "description": "Reference of the Alarm" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Alarm" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceAlarmRef.schema.json", + "title": "ResourceAlarmRef", + "definitions": { + "ResourceAlarmRef": { + "$id": "#ResourceAlarmRef", + "type": "object", + "description": "A set of alarm ids identifying the alarms that are underlying this problem.", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "changeRequest": { + "$ref": "../Common/ChangeRequestRef.schema.json#ChangeRequestRef" + }, + "href": { + "type": "string", + "description": "Reference of the Alarm" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Alarm" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Resource/ResourceCandidateRef.schema.json b/Resource/ResourceCandidateRef.schema.json index b32923ca..3755c71e 100644 --- a/Resource/ResourceCandidateRef.schema.json +++ b/Resource/ResourceCandidateRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceCandidateRef.schema.json", - "title": "ResourceCandidateRef", - "definitions": { - "ResourceCandidateRef": { - "$id": "#ResourceCandidateRef", - "description": "ResourceCandidate reference: A resource candidate is an entity that makes a ResourceSpecification available to a catalog.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the resource candidate" - }, - "id": { - "type": "string", - "description": "Unique identifier of the resource candidate" - }, - "name": { - "type": "string", - "description": "Name of the resource candidate" - }, - "version": { - "type": "string", - "description": "Version of the resource candidate" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceCandidateRef.schema.json", + "title": "ResourceCandidateRef", + "definitions": { + "ResourceCandidateRef": { + "$id": "#ResourceCandidateRef", + "description": "ResourceCandidate reference: A resource candidate is an entity that makes a ResourceSpecification available to a catalog.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the resource candidate" + }, + "id": { + "type": "string", + "description": "Unique identifier of the resource candidate" + }, + "name": { + "type": "string", + "description": "Name of the resource candidate" + }, + "version": { + "type": "string", + "description": "Version of the resource candidate" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Resource/ResourceCharacteristic.schema.json b/Resource/ResourceCharacteristic.schema.json index 139aec72..8909cbd4 100644 --- a/Resource/ResourceCharacteristic.schema.json +++ b/Resource/ResourceCharacteristic.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceCharacteristic.schema.json", - "title": "ResourceCharacteristic", - "definitions": { - "ResourceCharacteristic": { - "$id": "#ResourceCharacteristic", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "name of the characteristic" - }, - "value": { - "type": "string", - "description": "value of the characteristic" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceCharacteristic.schema.json", + "title": "ResourceCharacteristic", + "definitions": { + "ResourceCharacteristic": { + "$id": "#ResourceCharacteristic", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "name of the characteristic" + }, + "value": { + "type": "string", + "description": "value of the characteristic" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Resource/ResourceOrder.schema.json b/Resource/ResourceOrder.schema.json index 677b196e..c2bd1253 100644 --- a/Resource/ResourceOrder.schema.json +++ b/Resource/ResourceOrder.schema.json @@ -1,93 +1,93 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceOrder.schema.json", - "title": "ResourceOrder", - "definitions": { - "ResourceOrder": { - "$id": "#ResourceOrder", - "description": "A Resource Order is a request to provision a set of Resources (logical and physical) triggered by the request to provision a Service through a Service Order", - "type": "object", - "properties": { - "category": { - "type": "string", - "description": "Used to categorize the order from a business perspective that can be useful for the OM system." - }, - "completionDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order was completed" - }, - "correlationId": { - "type": "string", - "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" - }, - "description": { - "type": "string", - "description": "free-text description of the Resource Order" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the order" - }, - "id": { - "type": "string", - "description": "Identifier of an instance of the Resource Order. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." - }, - "name": { - "type": "string", - "description": "A string used to give a name to the Resource Order" - }, - "orderDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order was created" - }, - "priority": { - "type": "integer", - "description": "A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)" - }, - "requestedCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Requested delivery date from the requestor perspective" - }, - "requestedStartDate": { - "type": "string", - "format": "date-time", - "description": "Order start date wished by the requestor" - }, - "state": { - "type": "string", - "description": "The life cycle state of the resource." - }, - "orderType": { - "type": "string", - "description": "Name of the Resource Order type" - }, - "orderRelationship": { - "type": "array", - "items": { - "$ref": "ResourceOrderRelationship.schema.json#ResourceOrderRelationship" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceOrder.schema.json", + "title": "ResourceOrder", + "definitions": { + "ResourceOrder": { + "$id": "#ResourceOrder", + "description": "A Resource Order is a request to provision a set of Resources (logical and physical) triggered by the request to provision a Service through a Service Order", + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Used to categorize the order from a business perspective that can be useful for the OM system." + }, + "completionDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order was completed" + }, + "correlationId": { + "type": "string", + "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" + }, + "description": { + "type": "string", + "description": "free-text description of the Resource Order" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the order" + }, + "id": { + "type": "string", + "description": "Identifier of an instance of the Resource Order. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." + }, + "name": { + "type": "string", + "description": "A string used to give a name to the Resource Order" + }, + "orderDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order was created" + }, + "priority": { + "type": "integer", + "description": "A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)" + }, + "requestedCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Requested delivery date from the requestor perspective" + }, + "requestedStartDate": { + "type": "string", + "format": "date-time", + "description": "Order start date wished by the requestor" + }, + "state": { + "type": "string", + "description": "The life cycle state of the resource." + }, + "orderType": { + "type": "string", + "description": "Name of the Resource Order type" + }, + "orderRelationship": { + "type": "array", + "items": { + "$ref": "ResourceOrderRelationship.schema.json#ResourceOrderRelationship" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Resource/ResourceOrderItem.schema.json b/Resource/ResourceOrderItem.schema.json index 53065c75..d3ebb348 100644 --- a/Resource/ResourceOrderItem.schema.json +++ b/Resource/ResourceOrderItem.schema.json @@ -1,44 +1,44 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceOrderItem.schema.json", - "title": "ResourceOrderItem", - "definitions": { - "ResourceOrderItem": { - "$id": "#ResourceOrderItem", - "description": "An identified part of the order. A resource order is decomposed into one or more order items.", - "type": "object", - "properties": { - "action": { - "type": "string", - "description": "Can be \"add\" / \"modify\" / \"no_change\"/ \"delete\"" - }, - "id": { - "type": "string", - "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" - }, - "quantity": { - "type": "integer", - "description": "Quantity ordered" - }, - "state": { - "type": "string", - "description": "State of the order item : described in the state machine diagram" - }, - "resourceSpecification": { - "$ref": "ResourceSpecificationRef.schema.json#ResourceSpecificationRef" - }, - "orderItemRelationship": { - "type": "array", - "items": { - "$ref": "ResourceOrderItemRelationship.schema.json#ResourceOrderItemRelationship" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceOrderItem.schema.json", + "title": "ResourceOrderItem", + "definitions": { + "ResourceOrderItem": { + "$id": "#ResourceOrderItem", + "description": "An identified part of the order. A resource order is decomposed into one or more order items.", + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "Can be \"add\" / \"modify\" / \"no_change\"/ \"delete\"" + }, + "id": { + "type": "string", + "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" + }, + "quantity": { + "type": "integer", + "description": "Quantity ordered" + }, + "state": { + "type": "string", + "description": "State of the order item : described in the state machine diagram" + }, + "resourceSpecification": { + "$ref": "ResourceSpecificationRef.schema.json#ResourceSpecificationRef" + }, + "orderItemRelationship": { + "type": "array", + "items": { + "$ref": "ResourceOrderItemRelationship.schema.json#ResourceOrderItemRelationship" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Resource/ResourceOrderItemRef.schema.json b/Resource/ResourceOrderItemRef.schema.json index 1c91a3d6..fddef8a5 100644 --- a/Resource/ResourceOrderItemRef.schema.json +++ b/Resource/ResourceOrderItemRef.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceOrderItemRef.schema.json", - "title": "ResourceOrderItemRef", - "definitions": { - "ResourceOrderItemRef": { - "$id": "#ResourceOrderItemRef", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceOrderItemRef.schema.json", + "title": "ResourceOrderItemRef", + "definitions": { + "ResourceOrderItemRef": { + "$id": "#ResourceOrderItemRef", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Resource/ResourceOrderItemRelationship.schema.json b/Resource/ResourceOrderItemRelationship.schema.json index c1d34f50..5ffeed0e 100644 --- a/Resource/ResourceOrderItemRelationship.schema.json +++ b/Resource/ResourceOrderItemRelationship.schema.json @@ -1,25 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceOrderItemRelationship.schema.json", - "title": "ResourceOrderItemRelationship", - "definitions": { - "ResourceOrderItemRelationship": { - "$id": "#ResourceOrderItemRelationship", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of the order item relationship" - }, - "orderItem": { - "$ref": "ResourceOrderItemRef.schema.json#ResourceOrderItemRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceOrderItemRelationship.schema.json", + "title": "ResourceOrderItemRelationship", + "definitions": { + "ResourceOrderItemRelationship": { + "$id": "#ResourceOrderItemRelationship", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of the order item relationship" + }, + "orderItem": { + "$ref": "ResourceOrderItemRef.schema.json#ResourceOrderItemRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Resource/ResourceOrderRef.schema.json b/Resource/ResourceOrderRef.schema.json index a35aded7..1c9f40df 100644 --- a/Resource/ResourceOrderRef.schema.json +++ b/Resource/ResourceOrderRef.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceOrderRef.schema.json", - "title": "ResourceOrderRef", - "definitions": { - "ResourceOrderRef": { - "$id": "#ResourceOrderRef", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink to access the related Resource Order" - }, - "id": { - "type": "string", - "description": "The unique identifier of the related resource order" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceOrderRef.schema.json", + "title": "ResourceOrderRef", + "definitions": { + "ResourceOrderRef": { + "$id": "#ResourceOrderRef", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink to access the related Resource Order" + }, + "id": { + "type": "string", + "description": "The unique identifier of the related resource order" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Resource/ResourceOrderRelationship.schema.json b/Resource/ResourceOrderRelationship.schema.json index 3b81c336..c90ba4de 100644 --- a/Resource/ResourceOrderRelationship.schema.json +++ b/Resource/ResourceOrderRelationship.schema.json @@ -1,28 +1,28 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceOrderRelationship.schema.json", - "title": "ResourceOrderRelationship", - "definitions": { - "ResourceOrderRelationship": { - "$id": "#ResourceOrderRelationship", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "The type of related order item, such as [dependency] if the order item needs to be [not started] until another order item is complete; [cross-reference] to keep track of the source order (service order)" - }, - "resourceOrder": { - "$ref": "ResourceOrderRef.schema.json#ResourceOrderRef" - }, - "serviceOrder": { - "$ref": "../Service/ServiceOrderRef.schema.json#ServiceOrderRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceOrderRelationship.schema.json", + "title": "ResourceOrderRelationship", + "definitions": { + "ResourceOrderRelationship": { + "$id": "#ResourceOrderRelationship", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of related order item, such as [dependency] if the order item needs to be [not started] until another order item is complete; [cross-reference] to keep track of the source order (service order)" + }, + "resourceOrder": { + "$ref": "ResourceOrderRef.schema.json#ResourceOrderRef" + }, + "serviceOrder": { + "$ref": "../Service/ServiceOrderRef.schema.json#ServiceOrderRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Resource/ResourceRef.schema.json b/Resource/ResourceRef.schema.json index 5b514000..808a9ec1 100644 --- a/Resource/ResourceRef.schema.json +++ b/Resource/ResourceRef.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceRef.schema.json", - "title": "ResourceRef", - "definitions": { - "ResourceRef": { - "$id": "#ResourceRef", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the resource" - }, - "value": { - "type": "string", - "description": "The resource value that can be used to identify a resource with a public key (e.g.: a tel nr, an msisdn)" - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceRef.schema.json", + "title": "ResourceRef", + "definitions": { + "ResourceRef": { + "$id": "#ResourceRef", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the resource" + }, + "value": { + "type": "string", + "description": "The resource value that can be used to identify a resource with a public key (e.g.: a tel nr, an msisdn)" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} + } +} \ No newline at end of file diff --git a/Resource/ResourceRelationship.schema.json b/Resource/ResourceRelationship.schema.json index 543d4455..c303a048 100644 --- a/Resource/ResourceRelationship.schema.json +++ b/Resource/ResourceRelationship.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceRelationship.schema.json", - "title": "ResourceRelationship", - "definitions": { - "ResourceRelationship": { - "$id": "#ResourceRelationship", - "description": "Describes links between resources", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "Semantic of the relationship" - }, - "resource": { - "$ref": "ResourceRef.schema.json#ResourceRef", - "description": "A reference to the resource" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceRelationship.schema.json", + "title": "ResourceRelationship", + "definitions": { + "ResourceRelationship": { + "$id": "#ResourceRelationship", + "description": "Describes links between resources", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "Semantic of the relationship" + }, + "resource": { + "$ref": "ResourceRef.schema.json#ResourceRef", + "description": "A reference to the resource" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Resource/ResourceSpecificationRef.schema.json b/Resource/ResourceSpecificationRef.schema.json index 4b6d6149..aec367c2 100644 --- a/Resource/ResourceSpecificationRef.schema.json +++ b/Resource/ResourceSpecificationRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceSpecificationRef.schema.json", - "title": "ResourceSpecificationRef", - "definitions": { - "ResourceSpecificationRef": { - "$id": "#ResourceSpecificationRef", - "description": "Resource Specification reference: The ResourceSpecification is required to realize a ProductSpecification.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the resource specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the resource specification" - }, - "name": { - "type": "string", - "description": "Name of the requiredResourceSpecification" - }, - "version": { - "type": "string", - "description": "Resource specification version" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceSpecificationRef.schema.json", + "title": "ResourceSpecificationRef", + "definitions": { + "ResourceSpecificationRef": { + "$id": "#ResourceSpecificationRef", + "description": "Resource Specification reference: The ResourceSpecification is required to realize a ProductSpecification.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the resource specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the resource specification" + }, + "name": { + "type": "string", + "description": "Name of the requiredResourceSpecification" + }, + "version": { + "type": "string", + "description": "Resource specification version" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Resource/SupportingResource.schema.json b/Resource/SupportingResource.schema.json index 34811d56..c2c594db 100644 --- a/Resource/SupportingResource.schema.json +++ b/Resource/SupportingResource.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SupportingResource.schema.json", - "title": "SupportingResource", - "definitions": { - "SupportingResource": { - "$id": "#SupportingResource", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the supporting resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of the supporting resource" - }, - "name": { - "type": "string", - "description": "Name of the resource supporting the service" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SupportingResource.schema.json", + "title": "SupportingResource", + "definitions": { + "SupportingResource": { + "$id": "#SupportingResource", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the supporting resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of the supporting resource" + }, + "name": { + "type": "string", + "description": "Name of the resource supporting the service" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/AlternateServiceProposal.schema.json b/Service/AlternateServiceProposal.schema.json index f6021424..96e045d4 100644 --- a/Service/AlternateServiceProposal.schema.json +++ b/Service/AlternateServiceProposal.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AlternateServiceProposal.schema.json", - "title": "AlternateServiceProposal", - "definitions": { - "AlternateServiceProposal": { - "$id": "#AlternateServiceProposal", - "description": "Alternate service proposal is used when the requested service is not available with characteristic and date asked for. An alternate proposal could be a distinct serviceSpecification close to requested one or same as requested but with a different activation date", - "type": "object", - "properties": { - "id": { - "description": "Identifier of a alternate service proposal", - "type": "string" - }, - "alternateServiceAvailabilityDate": { - "description": "Alternate availability date in case seller is not able to meet requested expected availability date for the service", - "type": "string", - "format": "date-time" - }, - "alternateService": { - "$ref": "ServiceRestriction.schema.json#/definitions/ServiceRestriction" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AlternateServiceProposal.schema.json", + "title": "AlternateServiceProposal", + "definitions": { + "AlternateServiceProposal": { + "$id": "#AlternateServiceProposal", + "description": "Alternate service proposal is used when the requested service is not available with characteristic and date asked for. An alternate proposal could be a distinct serviceSpecification close to requested one or same as requested but with a different activation date", + "type": "object", + "properties": { + "id": { + "description": "Identifier of a alternate service proposal", + "type": "string" + }, + "alternateServiceAvailabilityDate": { + "description": "Alternate availability date in case seller is not able to meet requested expected availability date for the service", + "type": "string", + "format": "date-time" + }, + "alternateService": { + "$ref": "ServiceRestriction.schema.json#/definitions/ServiceRestriction" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/AppliedConsequence.schema.json b/Service/AppliedConsequence.schema.json index 2c0350e9..d070396b 100644 --- a/Service/AppliedConsequence.schema.json +++ b/Service/AppliedConsequence.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppliedConsequence.schema.json", - "title": "AppliedConsequence", - "definitions": { - "AppliedConsequence": { - "$id": "#AppliedConsequence", - "type": "object", - "description": "An Applied Consequence defines the action (prescribed action or notification) to take when a \nMeasureThresholdRuleViolation occurs.", - "properties": { - "appliedAction": { - "type": "string", - "description": "The action for a violated threshold. This could be a hyperlink to \nthe action." - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the consequence is." - }, - "name": { - "type": "string", - "description": "A word, term, or phrase by which Consequence is known and \ndistinguished from other MetricDefMeasureConsequences." - }, - "repeatAction": { - "type": "boolean", - "description": "An indicator used to specify that a consequence should cease \nbeing applied if a value is in the same range as the previous value or continue being applied if a value is in the same range as the previous value. \nIf the repeatAction is True, if the consequence is always applied as soon as the MetricMeasure value is in the range of values and if the repeatAction is False, the consequence is applied only if the previous MetricMeasure value was not in the same range." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppliedConsequence.schema.json", + "title": "AppliedConsequence", + "definitions": { + "AppliedConsequence": { + "$id": "#AppliedConsequence", + "type": "object", + "description": "An Applied Consequence defines the action (prescribed action or notification) to take when a \nMeasureThresholdRuleViolation occurs.", + "properties": { + "appliedAction": { + "type": "string", + "description": "The action for a violated threshold. This could be a hyperlink to \nthe action." + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the consequence is." + }, + "name": { + "type": "string", + "description": "A word, term, or phrase by which Consequence is known and \ndistinguished from other MetricDefMeasureConsequences." + }, + "repeatAction": { + "type": "boolean", + "description": "An indicator used to specify that a consequence should cease \nbeing applied if a value is in the same range as the previous value or continue being applied if a value is in the same range as the previous value. \nIf the repeatAction is True, if the consequence is always applied as soon as the MetricMeasure value is in the range of values and if the repeatAction is False, the consequence is applied only if the previous MetricMeasure value was not in the same range." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/BaseService.schema.json b/Service/BaseService.schema.json index e53ee373..465ce5f5 100644 --- a/Service/BaseService.schema.json +++ b/Service/BaseService.schema.json @@ -1,89 +1,89 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BaseService.schema.json", - "title": "BaseService", - "definitions": { - "BaseService": { - "$id": "#BaseService", - "description": "In the context of a service order and depending on the action requested (add/modify/delete/noChange) this data structure captures the configuration to apply to an existing subscribed service or to a new one", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the service", - "type": "string" - }, - "href": { - "description": "Reference of the service", - "type": "string" - }, - "serviceType": { - "description": "Business type of the service", - "type": "string" - }, - "name": { - "description": "Name of the service", - "type": "string" - }, - "state": { - "description": "The life cycle state of the service, such as: [feasibilityChecked], [designed]", - "$ref": "ServiceStateType.schema.json#/definitions/ServiceStateType" - }, - "category": { - "type": "string", - "description": "Is it a customer facing or resource facing service" - }, - "serviceSpecification": { - "description": "The specification from which this service was instantiated", - "$ref": "ServiceSpecificationRef.schema.json#/definitions/ServiceSpecificationRef" - }, - "serviceCharacteristic": { - "type": "array", - "description" : "A list of characteristics that characterize this service (ServiceCharacteristic [*]) ", - "items": { - "$ref": "../Common/Characteristic.schema.json#/definitions/Characteristic" - } - }, - "serviceRelationship": { - "type": "array", - "description" : "A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).", - "items": { - "$ref": "ServiceRelationship.schema.json#/definitions/ServiceRelationship" - } - }, - "supportingService": { - "type": "array", - "description" : "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)", - "items": { - "$ref": "ServiceRef.schema.json#/definitions/ServiceRef" - } - }, - "supportingResource": { - "type": "array", - "description" : "A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources", - "items": { - "$ref": "../Resource/ResourceRef.schema.json#/definitions/ResourceRef" - } - }, - "relatedParty": { - "type": "array", - "description" : "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#/definitions/RelatedParty" - } - }, - "place": { - "type": "array", - "description" : "A list of places (Place [*]). Used to define a place useful for the service (for example a delivery geographical place)", - "items": { - "$ref": "../Common/Place.schema.json#/definitions/Place" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BaseService.schema.json", + "title": "BaseService", + "definitions": { + "BaseService": { + "$id": "#BaseService", + "description": "In the context of a service order and depending on the action requested (add/modify/delete/noChange) this data structure captures the configuration to apply to an existing subscribed service or to a new one", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service", + "type": "string" + }, + "href": { + "description": "Reference of the service", + "type": "string" + }, + "serviceType": { + "description": "Business type of the service", + "type": "string" + }, + "name": { + "description": "Name of the service", + "type": "string" + }, + "state": { + "description": "The life cycle state of the service, such as: [feasibilityChecked], [designed]", + "$ref": "ServiceStateType.schema.json#ServiceStateType" + }, + "category": { + "type": "string", + "description": "Is it a customer facing or resource facing service" + }, + "serviceSpecification": { + "description": "The specification from which this service was instantiated", + "$ref": "ServiceSpecificationRef.schema.json#ServiceSpecificationRef" + }, + "serviceCharacteristic": { + "type": "array", + "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*]) ", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "serviceRelationship": { + "type": "array", + "description": "A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).", + "items": { + "$ref": "ServiceRelationship.schema.json#ServiceRelationship" + } + }, + "supportingService": { + "type": "array", + "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)", + "items": { + "$ref": "ServiceRef.schema.json#ServiceRef" + } + }, + "supportingResource": { + "type": "array", + "description": "A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources", + "items": { + "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" + } + }, + "relatedParty": { + "type": "array", + "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "place": { + "type": "array", + "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a delivery geographical place)", + "items": { + "$ref": "../Common/Place.schema.json#Place" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/FirstAlert.schema.json b/Service/FirstAlert.schema.json index 68da6a10..7b650a8d 100644 --- a/Service/FirstAlert.schema.json +++ b/Service/FirstAlert.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "FirstAlert.schema.json", - "title": "FirstAlert", - "definitions": { - "FirstAlert": { - "$id": "#FirstAlert", - "type": "object", - "description": "Indicates what first alerted the system to the problem. It is not the root cause of the Service Problem. Examples: Threshold crossing alert", - "properties": { - "href": { - "type": "string", - "description": "Reference of the object" - }, - "id": { - "type": "string", - "description": "Unique identifier of the object" - }, - "alertType": { - "type": "string", - "description": "Type of the object" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "FirstAlert.schema.json", + "title": "FirstAlert", + "definitions": { + "FirstAlert": { + "$id": "#FirstAlert", + "type": "object", + "description": "Indicates what first alerted the system to the problem. It is not the root cause of the Service Problem. Examples: Threshold crossing alert", + "properties": { + "href": { + "type": "string", + "description": "Reference of the object" + }, + "id": { + "type": "string", + "description": "Unique identifier of the object" + }, + "alertType": { + "type": "string", + "description": "Type of the object" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ImpactPattern.schema.json b/Service/ImpactPattern.schema.json index c0a74eb1..afe5ca63 100644 --- a/Service/ImpactPattern.schema.json +++ b/Service/ImpactPattern.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ImpactPattern.schema.json", - "title": "ImpactPattern", - "definitions": { - "ImpactPattern": { - "$id": "#ImpactPattern", - "type": "object", - "description": "Define the patterns of impact (optional), such as other service characteristics- Used when defining impact through another pattern than the pre-defined attributes", - "properties": { - "description": { - "type": "string", - "description": "Basic description of the impact pattern" - }, - "extensionInfo": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - }, - "description": "A generic list of any type of elements. Used for extensions or loose element encapsulation from other namespaces" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ImpactPattern.schema.json", + "title": "ImpactPattern", + "definitions": { + "ImpactPattern": { + "$id": "#ImpactPattern", + "type": "object", + "description": "Define the patterns of impact (optional), such as other service characteristics- Used when defining impact through another pattern than the pre-defined attributes", + "properties": { + "description": { + "type": "string", + "description": "Basic description of the impact pattern" + }, + "extensionInfo": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + }, + "description": "A generic list of any type of elements. Used for extensions or loose element encapsulation from other namespaces" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/MeasureThresholdRuleViolation.schema.json b/Service/MeasureThresholdRuleViolation.schema.json index d46f44b3..f3f351aa 100644 --- a/Service/MeasureThresholdRuleViolation.schema.json +++ b/Service/MeasureThresholdRuleViolation.schema.json @@ -1,62 +1,62 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "MeasureThresholdRuleViolation.schema.json", - "title": "MeasureThresholdRuleViolation", - "definitions": { - "MeasureThresholdRuleViolation": { - "$id": "#MeasureThresholdRuleViolation", - "description": "A measureThresholdRuleViolation is a violation of a rule that defines the in the \nMericDefMeasureThresholdRule.", - "type": "object", - "properties": { - "conformanceComparatorLower": { - "type": "string", - "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetLower." - }, - "conformanceComparatorUpper": { - "type": "string", - "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetUpper." - }, - "conformanceTargetLower": { - "type": "string", - "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the lower limit. The value should be less than the conformanceTargetUpper. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." - }, - "conformanceTargetUpper": { - "type": "string", - "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the Upper limit. The value should be greater than the conformanceTargetLower. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." - }, - "description": { - "type": "string", - "description": "Description for the MetricDefMeasureThresholdRule ." - }, - "name": { - "type": "string", - "description": "Name for the MetricDefMeasureThresholdRule ." - }, - "numberOfAllowedCrossing": { - "type": "integer", - "description": "The number of allowed crossing occurrences in reference to the \ntolerancePeriod without a consequence being initiated." - }, - "thresholdRuleSeverity": { - "type": "string", - "description": "A threshold can be generated in different severity levels. A \ncrossing for each level may require a different condition and possibly trigger a different consequence." - }, - "tolerancePeriod": { - "description": "An interval of time of allowed crossing occurrences before a \nconsequence being initiated.", - "$ref": "../Common/Duration.schema.json#Duration" - }, - "appliedConsequence": { - "type": "array", - "description": "An Applied Consequence defines the action (prescribed action or notification) to take when a MeasureThresholdRuleViolation occurs.", - "items": { - "$ref": "AppliedConsequence.schema.json#AppliedConsequence" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "MeasureThresholdRuleViolation.schema.json", + "title": "MeasureThresholdRuleViolation", + "definitions": { + "MeasureThresholdRuleViolation": { + "$id": "#MeasureThresholdRuleViolation", + "description": "A measureThresholdRuleViolation is a violation of a rule that defines the in the \nMericDefMeasureThresholdRule.", + "type": "object", + "properties": { + "conformanceComparatorLower": { + "type": "string", + "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetLower." + }, + "conformanceComparatorUpper": { + "type": "string", + "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetUpper." + }, + "conformanceTargetLower": { + "type": "string", + "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the lower limit. The value should be less than the conformanceTargetUpper. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." + }, + "conformanceTargetUpper": { + "type": "string", + "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the Upper limit. The value should be greater than the conformanceTargetLower. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." + }, + "description": { + "type": "string", + "description": "Description for the MetricDefMeasureThresholdRule ." + }, + "name": { + "type": "string", + "description": "Name for the MetricDefMeasureThresholdRule ." + }, + "numberOfAllowedCrossing": { + "type": "integer", + "description": "The number of allowed crossing occurrences in reference to the \ntolerancePeriod without a consequence being initiated." + }, + "thresholdRuleSeverity": { + "type": "string", + "description": "A threshold can be generated in different severity levels. A \ncrossing for each level may require a different condition and possibly trigger a different consequence." + }, + "tolerancePeriod": { + "description": "An interval of time of allowed crossing occurrences before a \nconsequence being initiated.", + "$ref": "../Common/Duration.schema.json#Duration" + }, + "appliedConsequence": { + "type": "array", + "description": "An Applied Consequence defines the action (prescribed action or notification) to take when a MeasureThresholdRuleViolation occurs.", + "items": { + "$ref": "AppliedConsequence.schema.json#AppliedConsequence" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/MetricDefMeasureConsequence.schema.json b/Service/MetricDefMeasureConsequence.schema.json index e0c4a227..0a408759 100644 --- a/Service/MetricDefMeasureConsequence.schema.json +++ b/Service/MetricDefMeasureConsequence.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "MetricDefMeasureConsequence.schema.json", - "title": "MetricDefMeasureConsequence", - "definitions": { - "MetricDefMeasureConsequence": { - "$id": "#MetricDefMeasureConsequence", - "description": "A MetricDefMeasureConsequence defines the action (prescribed action or notification) to take when a \nMetricDefMeasureThresholdRule is crossed.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail what the consequence is." - }, - "name": { - "type": "string", - "description": "A word, term, or phrase by which a \nMetricDefMeasureConsequence is known and distinguished from other MetricDefMeasureConsequences." - }, - "prescribeAction": { - "type": "string", - "description": "Recommended remedy for a violated threshold. This could be \nthe hyperlink to the action." - }, - "repeatAction": { - "type": "boolean", - "description": "An indicator used to specify that a consequence should cease \nbeing applied if a value is in the same range as the previous value or continue being applied if a value is in the same range as the previous value. \nIf the repeatAction is True, if the consequence is always applied as soon as the MetricMeasure value is in the range of values and if the repeatAction is False, the consequence is applied only if the previous MetricMeasure value was not in the same range." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "A valid duration of a thing." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "MetricDefMeasureConsequence.schema.json", + "title": "MetricDefMeasureConsequence", + "definitions": { + "MetricDefMeasureConsequence": { + "$id": "#MetricDefMeasureConsequence", + "description": "A MetricDefMeasureConsequence defines the action (prescribed action or notification) to take when a \nMetricDefMeasureThresholdRule is crossed.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail what the consequence is." + }, + "name": { + "type": "string", + "description": "A word, term, or phrase by which a \nMetricDefMeasureConsequence is known and distinguished from other MetricDefMeasureConsequences." + }, + "prescribeAction": { + "type": "string", + "description": "Recommended remedy for a violated threshold. This could be \nthe hyperlink to the action." + }, + "repeatAction": { + "type": "boolean", + "description": "An indicator used to specify that a consequence should cease \nbeing applied if a value is in the same range as the previous value or continue being applied if a value is in the same range as the previous value. \nIf the repeatAction is True, if the consequence is always applied as soon as the MetricMeasure value is in the range of values and if the repeatAction is False, the consequence is applied only if the previous MetricMeasure value was not in the same range." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "A valid duration of a thing." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/MetricDefMeasureThresholdRule.schema.json b/Service/MetricDefMeasureThresholdRule.schema.json index b1f006e4..e11bce6d 100644 --- a/Service/MetricDefMeasureThresholdRule.schema.json +++ b/Service/MetricDefMeasureThresholdRule.schema.json @@ -1,62 +1,62 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "MetricDefMeasureThresholdRule.schema.json", - "title": "MetricDefMeasureThresholdRule", - "definitions": { - "MetricDefMeasureThresholdRule": { - "$id": "#MetricDefMeasureThresholdRule", - "description": "A MetricDefMeasureThresholdRule is a rule that defines the condition (raise or clear) to achieve to apply \nconsequences when a threshold is crossed or ceased to be crossed. It also defines the severity of the \nraise or clear of the threshold.", - "type": "object", - "properties": { - "conformanceComparatorLower": { - "type": "string", - "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to Service Test Management API REST Specification compare with the conformanceTargetLower." - }, - "conformanceComparatorUpper": { - "type": "string", - "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetUpper." - }, - "conformanceTargetLower": { - "type": "string", - "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the lower limit. The value should be less than the conformanceTargetUpper. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." - }, - "conformanceTargetUpper": { - "type": "string", - "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the Upper limit. The value should be greater than the conformanceTargetLower. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." - }, - "consequence": { - "type": "array", - "description": "A list of consequences (actions, notifications) that will arise if the threshold is crossed", - "items": { - "$ref": "MetricDefMeasureConsequence.schema.json#/definitions/MetricDefMeasureConsequence" - } - }, - "description": { - "type": "string", - "description": "Description for the MetricDefMeasureThresholdRule ." - }, - "name": { - "type": "string", - "description": "Name for the MetricDefMeasureThresholdRule ." - }, - "numberOfAllowedCrossing": { - "type": "integer", - "description": "The number of allowed crossing occurrences in reference to the \ntolerancePeriod without a consequence being initiated." - }, - "thresholdRuleSeverity": { - "type": "string", - "description": "A threshold can be generated in different severity levels. A \ncrossing for each level may require a different condition and possibly trigger a different consequence." - }, - "tolerancePeriod": { - "description": "An interval of time of allowed crossing occurrences before a consequence being initiated.", - "$ref": "../Common/Duration.schema.json#Duration" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "MetricDefMeasureThresholdRule.schema.json", + "title": "MetricDefMeasureThresholdRule", + "definitions": { + "MetricDefMeasureThresholdRule": { + "$id": "#MetricDefMeasureThresholdRule", + "description": "A MetricDefMeasureThresholdRule is a rule that defines the condition (raise or clear) to achieve to apply \nconsequences when a threshold is crossed or ceased to be crossed. It also defines the severity of the \nraise or clear of the threshold.", + "type": "object", + "properties": { + "conformanceComparatorLower": { + "type": "string", + "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to Service Test Management API REST Specification compare with the conformanceTargetLower." + }, + "conformanceComparatorUpper": { + "type": "string", + "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetUpper." + }, + "conformanceTargetLower": { + "type": "string", + "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the lower limit. The value should be less than the conformanceTargetUpper. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." + }, + "conformanceTargetUpper": { + "type": "string", + "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the Upper limit. The value should be greater than the conformanceTargetLower. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." + }, + "consequence": { + "type": "array", + "description": "A list of consequences (actions, notifications) that will arise if the threshold is crossed", + "items": { + "$ref": "MetricDefMeasureConsequence.schema.json#MetricDefMeasureConsequence" + } + }, + "description": { + "type": "string", + "description": "Description for the MetricDefMeasureThresholdRule ." + }, + "name": { + "type": "string", + "description": "Name for the MetricDefMeasureThresholdRule ." + }, + "numberOfAllowedCrossing": { + "type": "integer", + "description": "The number of allowed crossing occurrences in reference to the \ntolerancePeriod without a consequence being initiated." + }, + "thresholdRuleSeverity": { + "type": "string", + "description": "A threshold can be generated in different severity levels. A \ncrossing for each level may require a different condition and possibly trigger a different consequence." + }, + "tolerancePeriod": { + "description": "An interval of time of allowed crossing occurrences before a consequence being initiated.", + "$ref": "../Common/Duration.schema.json#Duration" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ProblemAcknowledgement.schema.json b/Service/ProblemAcknowledgement.schema.json index a63fffd4..953434d3 100644 --- a/Service/ProblemAcknowledgement.schema.json +++ b/Service/ProblemAcknowledgement.schema.json @@ -1,45 +1,45 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProblemAcknowledgement.schema.json", - "title": "ProblemAcknowledgement", - "definitions": { - "ProblemAcknowledgement": { - "$id": "#ProblemAcknowledgement", - "type": "object", - "description": "Task resource that requests acknowledgement of problems by the problem handler.", - "properties": { - "href": { - "type": "string", - "description": "Reference to this task resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of this task resource" - }, - "problem": { - "description": "The problems to be acknowledged, relevant in the input to this task", - "type": "array", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "ackProblem": { - "description": "The problems that were acknowledged, populated in the output to this task", - "type": "array", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "trackingRecord": { - "description": "A record of the action taken in this acknowledgement", - "$ref": "TrackingRecord.schema.json#TrackingRecord" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProblemAcknowledgement.schema.json", + "title": "ProblemAcknowledgement", + "definitions": { + "ProblemAcknowledgement": { + "$id": "#ProblemAcknowledgement", + "type": "object", + "description": "Task resource that requests acknowledgement of problems by the problem handler.", + "properties": { + "href": { + "type": "string", + "description": "Reference to this task resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of this task resource" + }, + "problem": { + "description": "The problems to be acknowledged, relevant in the input to this task", + "type": "array", + "items": { + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "ackProblem": { + "description": "The problems that were acknowledged, populated in the output to this task", + "type": "array", + "items": { + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "trackingRecord": { + "description": "A record of the action taken in this acknowledgement", + "$ref": "TrackingRecord.schema.json#TrackingRecord" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Service/ProblemGroup.schema.json b/Service/ProblemGroup.schema.json index 7af8418e..5946ee4a 100644 --- a/Service/ProblemGroup.schema.json +++ b/Service/ProblemGroup.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProblemGroup.schema.json", - "title": "ProblemGroup", - "definitions": { - "ProblemGroup" : { - "$id": "#ProblemGroup", - "description": "Task resource that requests Service Problems to be grouped together into a parent and set of children", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference to this task resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of this task resource" - }, - "childProblem": { - "type": "array", - "description": "List of problems to be grouped under a parent problem", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "parentProblem": { - "description": "The parent problem to which the problems are to be grouped", - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProblemGroup.schema.json", + "title": "ProblemGroup", + "definitions": { + "ProblemGroup": { + "$id": "#ProblemGroup", + "description": "Task resource that requests Service Problems to be grouped together into a parent and set of children", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference to this task resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of this task resource" + }, + "childProblem": { + "type": "array", + "description": "List of problems to be grouped under a parent problem", + "items": { + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "parentProblem": { + "description": "The parent problem to which the problems are to be grouped", + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Service/ProblemUnacknowledgement.schema.json b/Service/ProblemUnacknowledgement.schema.json index fa0b2004..810be1b4 100644 --- a/Service/ProblemUnacknowledgement.schema.json +++ b/Service/ProblemUnacknowledgement.schema.json @@ -1,45 +1,45 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProblemUnacknowledgement.schema.json", - "title": "ProblemUnacknowledgement", - "definitions": { - "ProblemUnacknowledgement": { - "$id": "#ProblemUnacknowledgement", - "type": "object", - "description": "Task resource that requests unacknowledgement of problems, rolling back the status of the problems from Acknowledged to Submitted.", - "properties": { - "href": { - "type": "string", - "description": "Reference to this task resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of this task resource" - }, - "problem": { - "description": "The problems to be unacknowledged, relevant in the input to this task", - "type": "array", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "unackProblem": { - "description": "The problems that were unacknowledged, populated in the output to this task", - "type": "array", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "trackingRecord": { - "description": "A record of the action taken in this acknowledgement", - "$ref": "TrackingRecord.schema.json#TrackingRecord" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProblemUnacknowledgement.schema.json", + "title": "ProblemUnacknowledgement", + "definitions": { + "ProblemUnacknowledgement": { + "$id": "#ProblemUnacknowledgement", + "type": "object", + "description": "Task resource that requests unacknowledgement of problems, rolling back the status of the problems from Acknowledged to Submitted.", + "properties": { + "href": { + "type": "string", + "description": "Reference to this task resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of this task resource" + }, + "problem": { + "description": "The problems to be unacknowledged, relevant in the input to this task", + "type": "array", + "items": { + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "unackProblem": { + "description": "The problems that were unacknowledged, populated in the output to this task", + "type": "array", + "items": { + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "trackingRecord": { + "description": "A record of the action taken in this acknowledgement", + "$ref": "TrackingRecord.schema.json#TrackingRecord" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Service/ProblemUngroup.schema.json b/Service/ProblemUngroup.schema.json index 25e1c931..19339cf4 100644 --- a/Service/ProblemUngroup.schema.json +++ b/Service/ProblemUngroup.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProblemUngroup.schema.json", - "title": "ProblemUngroup", - "definitions": { - "ProblemUngroup" : { - "$id": "#ProblemUngroup", - "description": "Task resource that requests Service Problems to be ungrouped from a parent", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference to this task resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of this task resource" - }, - "childProblem": { - "type": "array", - "description": "List of problems to be ungrouped from a parent problem", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "parentProblem": { - "description": "The parent problem from which the problems are to be ungrouped", - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProblemUngroup.schema.json", + "title": "ProblemUngroup", + "definitions": { + "ProblemUngroup": { + "$id": "#ProblemUngroup", + "description": "Task resource that requests Service Problems to be ungrouped from a parent", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference to this task resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of this task resource" + }, + "childProblem": { + "type": "array", + "description": "List of problems to be ungrouped from a parent problem", + "items": { + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "parentProblem": { + "description": "The parent problem from which the problems are to be ungrouped", + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } + } } \ No newline at end of file diff --git a/Service/Service.schema.json b/Service/Service.schema.json index c041cb92..a4fdb645 100644 --- a/Service/Service.schema.json +++ b/Service/Service.schema.json @@ -1,69 +1,67 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Service.schema.json", - "title": "Service", - "definitions": { - "Service": { - "$id": "#Service", - "description": "Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.", - "type": "object", - "properties": { - - "description": { - "description": "Free-text description of the service", - "type": "string" - }, - - "isServiceEnabled": { - "type": "boolean", - "description": "If FALSE, this particular Service has NOT been enabled for use" - }, - "hasStarted": { - "type": "boolean", - "description": "If TRUE, this Service has already been started" - }, - "startMode": { - "type": "string", - "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above" - }, - "isStateful": { - "type": "boolean", - "description": "If TRUE, this Service can be changed without affecting any other services" - }, - "serviceDate": { - "description": "Date when the service was created (whatever its status).", - "type": "string" - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "Date when the service starts" - }, - "endDate": { - "type": "string", - "format": "date-time", - "description": "Date when the service ends" - }, - "serviceOrder": { - "type": "array", - "description" : "A list of service orders related to this service", - "items": { - "$ref": "ServiceOrderRef.schema.json#/definitions/ServiceOrderRef" - } - }, - "note": { - "type": "array", - "description" : "A list of notes made on this service", - "items": { - "$ref": "../Common/Note.schema.json#/definitions/Note" - } - } - }, - "allOf": [ - { - "$ref": "../Service/BaseService.schema.json#BaseService" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Service.schema.json", + "title": "Service", + "definitions": { + "Service": { + "$id": "#Service", + "description": "Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.", + "type": "object", + "properties": { + "description": { + "description": "Free-text description of the service", + "type": "string" + }, + "isServiceEnabled": { + "type": "boolean", + "description": "If FALSE, this particular Service has NOT been enabled for use" + }, + "hasStarted": { + "type": "boolean", + "description": "If TRUE, this Service has already been started" + }, + "startMode": { + "type": "string", + "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above" + }, + "isStateful": { + "type": "boolean", + "description": "If TRUE, this Service can be changed without affecting any other services" + }, + "serviceDate": { + "description": "Date when the service was created (whatever its status).", + "type": "string" + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "Date when the service starts" + }, + "endDate": { + "type": "string", + "format": "date-time", + "description": "Date when the service ends" + }, + "serviceOrder": { + "type": "array", + "description": "A list of service orders related to this service", + "items": { + "$ref": "ServiceOrderRef.schema.json#ServiceOrderRef" + } + }, + "note": { + "type": "array", + "description": "A list of notes made on this service", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } } + }, + "allOf": [ + { + "$ref": "BaseService.schema.json#BaseService" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceCandidate.schema.json b/Service/ServiceCandidate.schema.json index 6f91e473..54c72732 100644 --- a/Service/ServiceCandidate.schema.json +++ b/Service/ServiceCandidate.schema.json @@ -1,63 +1,63 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceCandidate.schema.json", - "title": "ServiceCandidate", - "definitions": { - "ServiceCandidate": { - "$id": "#ServiceCandidate", - "description": "ServiceCandidate is an entity that makes a service specification available to a catalog. A\nServiceCandidate and its associated service specification may be published - made visible - in any number of service catalogs, or in none. One service specification can be composed of other service specifications.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of this REST resource" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to this REST resource" - }, - "name": { - "type": "string", - "description": "Name given to this REST resource" - }, - "description": { - "type": "string", - "description": "Description of this REST resource" - }, - "version": { - "type": "string", - "description": "the version of service candidate" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which this REST resource is valid" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update of this REST resource" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status of the service candidate." - }, - "category": { - "type": "array", - "description": "List of categories for this candidate", - "items": { - "$ref": "ServiceCategoryRef.schema.json#ServiceCategoryRef" - } - }, - "serviceSpecification": { - "description": "The service specification implied by this candidate", - "$ref": "ServiceSpecificationRef.schema.json#ServiceSpecificationRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceCandidate.schema.json", + "title": "ServiceCandidate", + "definitions": { + "ServiceCandidate": { + "$id": "#ServiceCandidate", + "description": "ServiceCandidate is an entity that makes a service specification available to a catalog. A\nServiceCandidate and its associated service specification may be published - made visible - in any number of service catalogs, or in none. One service specification can be composed of other service specifications.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of this REST resource" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to this REST resource" + }, + "name": { + "type": "string", + "description": "Name given to this REST resource" + }, + "description": { + "type": "string", + "description": "Description of this REST resource" + }, + "version": { + "type": "string", + "description": "the version of service candidate" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which this REST resource is valid" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update of this REST resource" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status of the service candidate." + }, + "category": { + "type": "array", + "description": "List of categories for this candidate", + "items": { + "$ref": "ServiceCategoryRef.schema.json#ServiceCategoryRef" + } + }, + "serviceSpecification": { + "description": "The service specification implied by this candidate", + "$ref": "ServiceSpecificationRef.schema.json#ServiceSpecificationRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceCandidateRef.schema.json b/Service/ServiceCandidateRef.schema.json index da1c4a91..e9d41d4d 100644 --- a/Service/ServiceCandidateRef.schema.json +++ b/Service/ServiceCandidateRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceCandidateRef.schema.json", - "title": "ServiceCandidateRef", - "definitions": { - "ServiceCandidateRef": { - "$id": "#ServiceCandidateRef", - "description": "ServiceCandidate reference. ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Unique reference of the service candidate" - }, - "id": { - "type": "string", - "description": "Unique identifier of the service candidate" - }, - "name": { - "type": "string", - "description": "Name of the service candidate" - }, - "version": { - "type": "string", - "description": "Version of the service candidate" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceCandidateRef.schema.json", + "title": "ServiceCandidateRef", + "definitions": { + "ServiceCandidateRef": { + "$id": "#ServiceCandidateRef", + "description": "ServiceCandidate reference. ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Unique reference of the service candidate" + }, + "id": { + "type": "string", + "description": "Unique identifier of the service candidate" + }, + "name": { + "type": "string", + "description": "Name of the service candidate" + }, + "version": { + "type": "string", + "description": "Version of the service candidate" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceCatalog.schema.json b/Service/ServiceCatalog.schema.json index d4b8c43f..9d1dc572 100644 --- a/Service/ServiceCatalog.schema.json +++ b/Service/ServiceCatalog.schema.json @@ -1,66 +1,66 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceCatalog.schema.json", - "title": "ServiceCatalog", - "definitions": { - "ServiceCatalog": { - "$id": "#ServiceCatalog", - "description": "The root entity for service catalog management.\nA service catalog is a group of service specifications made available through service candidates that an organization provides to the consumers (internal consumers like its employees or B2B customers or B2C customers). \nA service catalog typically includes name, description and time period that is valid for. It will have a list of ServiceCandidate catalog items. A ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog.\nA ServiceCandidate and its associated ServiceSpecification may be \"published\" - made visible -in any number of ServiceCatalogs, or in none.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the ServiceCatalog" - }, - "href": { - "type": "string", - "description": "Unique reference of the service catalog" - }, - "name": { - "type": "string", - "description": "Name of the service catalog" - }, - "description": { - "type": "string", - "description": "Description of this catalog" - }, - "version": { - "type": "string", - "description": "ServiceCatalog version" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the service catalog is valid" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "category": { - "type": "array", - "description": "List of service categories associated with this catalog", - "items": { - "$ref": "ServiceCategoryRef.schema.json#ServiceCategoryRef" - } - }, - "relatedParty": { - "type": "array", - "description": "List of parties or party roles related to this category", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceCatalog.schema.json", + "title": "ServiceCatalog", + "definitions": { + "ServiceCatalog": { + "$id": "#ServiceCatalog", + "description": "The root entity for service catalog management.\nA service catalog is a group of service specifications made available through service candidates that an organization provides to the consumers (internal consumers like its employees or B2B customers or B2C customers). \nA service catalog typically includes name, description and time period that is valid for. It will have a list of ServiceCandidate catalog items. A ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog.\nA ServiceCandidate and its associated ServiceSpecification may be \"published\" - made visible -in any number of ServiceCatalogs, or in none.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the ServiceCatalog" + }, + "href": { + "type": "string", + "description": "Unique reference of the service catalog" + }, + "name": { + "type": "string", + "description": "Name of the service catalog" + }, + "description": { + "type": "string", + "description": "Description of this catalog" + }, + "version": { + "type": "string", + "description": "ServiceCatalog version" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the service catalog is valid" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "category": { + "type": "array", + "description": "List of service categories associated with this catalog", + "items": { + "$ref": "ServiceCategoryRef.schema.json#ServiceCategoryRef" + } + }, + "relatedParty": { + "type": "array", + "description": "List of parties or party roles related to this category", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceCategory.schema.json b/Service/ServiceCategory.schema.json index e3c8406d..f7309279 100644 --- a/Service/ServiceCategory.schema.json +++ b/Service/ServiceCategory.schema.json @@ -1,74 +1,74 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceCategory.schema.json", - "title": "ServiceCategory", - "definitions": { - "ServiceCategory": { - "$id": "#ServiceCategory", - "description": "The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the category" - }, - "href": { - "type": "string", - "description": "Reference of the category" - }, - "name": { - "type": "string", - "description": "Name of the category" - }, - "description": { - "type": "string", - "description": "Description of the category" - }, - "version": { - "type": "string", - "description": "ServiceCategory version" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the category is valid" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "parentId": { - "type": "string", - "description": "Unique identifier of the parent category" - }, - "isRoot": { - "type": "boolean", - "description": "If true, this Boolean indicates that the category is a root of categories" - }, - "serviceCandidate": { - "type": "array", - "description": "List of service candidates associated with this category", - "items": { - "$ref": "ServiceCandidateRef.schema.json#ServiceCandidateRef" - } - }, - "category": { - "type": "array", - "description": "List of child categories in the tree for in this category", - "items": { - "$ref": "ServiceCategoryRef.schema.json#ServiceCategoryRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceCategory.schema.json", + "title": "ServiceCategory", + "definitions": { + "ServiceCategory": { + "$id": "#ServiceCategory", + "description": "The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the category" + }, + "href": { + "type": "string", + "description": "Reference of the category" + }, + "name": { + "type": "string", + "description": "Name of the category" + }, + "description": { + "type": "string", + "description": "Description of the category" + }, + "version": { + "type": "string", + "description": "ServiceCategory version" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the category is valid" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "parentId": { + "type": "string", + "description": "Unique identifier of the parent category" + }, + "isRoot": { + "type": "boolean", + "description": "If true, this Boolean indicates that the category is a root of categories" + }, + "serviceCandidate": { + "type": "array", + "description": "List of service candidates associated with this category", + "items": { + "$ref": "ServiceCandidateRef.schema.json#ServiceCandidateRef" + } + }, + "category": { + "type": "array", + "description": "List of child categories in the tree for in this category", + "items": { + "$ref": "ServiceCategoryRef.schema.json#ServiceCategoryRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceCategoryRef.schema.json b/Service/ServiceCategoryRef.schema.json index 28e99ac3..38dbfa8f 100644 --- a/Service/ServiceCategoryRef.schema.json +++ b/Service/ServiceCategoryRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceCategoryRef.schema.json", - "title": "ServiceCategoryRef", - "definitions": { - "ServiceCategoryRef": { - "$id": "#ServiceCategoryRef", - "description": "The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hypertext Reference of the category" - }, - "id": { - "type": "string", - "description": "Unique identifier of category" - }, - "name": { - "type": "string", - "description": "Name of the category." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceCategoryRef.schema.json", + "title": "ServiceCategoryRef", + "definitions": { + "ServiceCategoryRef": { + "$id": "#ServiceCategoryRef", + "description": "The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hypertext Reference of the category" + }, + "id": { + "type": "string", + "description": "Unique identifier of category" + }, + "name": { + "type": "string", + "description": "Name of the category." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceCharacteristic.schema.json b/Service/ServiceCharacteristic.schema.json index 6e0a924e..24e36b3f 100644 --- a/Service/ServiceCharacteristic.schema.json +++ b/Service/ServiceCharacteristic.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceCharacteristic.schema.json", - "title": "ServiceCharacteristic", - "definitions": { - "ServiceCharacteristic": { - "$id": "#ServiceCharacteristic", - "description": "is a list of name value pairs that define the service characteristics", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "valueType": { - "type": "string", - "description": "Data type of the characteristic" - }, - "value": { - "description": "Actual value of the characteristio", - "$ref": "../Common/Value.schema.json#Value" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceCharacteristic.schema.json", + "title": "ServiceCharacteristic", + "definitions": { + "ServiceCharacteristic": { + "$id": "#ServiceCharacteristic", + "description": "is a list of name value pairs that define the service characteristics", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "valueType": { + "type": "string", + "description": "Data type of the characteristic" + }, + "value": { + "description": "Actual value of the characteristio", + "$ref": "../Common/Value.schema.json#Value" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceEligibilityUnavailabilityReason.schema.json b/Service/ServiceEligibilityUnavailabilityReason.schema.json index 18c43b37..c8d6613d 100644 --- a/Service/ServiceEligibilityUnavailabilityReason.schema.json +++ b/Service/ServiceEligibilityUnavailabilityReason.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceEligibilityUnavailabilityReason.schema.json", - "title": "ServiceEligibilityUnavailabilityReason", - "definitions": { - "ServiceEligibilityUnavailabilityReason": { - "$id": "#ServiceEligibilityUnavailabilityReason", - "description": "Reason for eligibility result if the ServiceQualification result is no (meaning the Service is not available)", - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Unavailability reason code" - }, - "label": { - "type": "string", - "description": "Unavailability reason label" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceEligibilityUnavailabilityReason.schema.json", + "title": "ServiceEligibilityUnavailabilityReason", + "definitions": { + "ServiceEligibilityUnavailabilityReason": { + "$id": "#ServiceEligibilityUnavailabilityReason", + "description": "Reason for eligibility result if the ServiceQualification result is no (meaning the Service is not available)", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Unavailability reason code" + }, + "label": { + "type": "string", + "description": "Unavailability reason label" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceLevelObjective.schema.json b/Service/ServiceLevelObjective.schema.json index 5f2fa4c6..43f629ea 100644 --- a/Service/ServiceLevelObjective.schema.json +++ b/Service/ServiceLevelObjective.schema.json @@ -1,74 +1,74 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceLevelObjective.schema.json", - "title": "ServiceLevelObjective", - "definitions": { - "ServiceLevelObjective": { - "$id": "#ServiceLevelObjective", - "description": "Service level objectives are defined in terms of parameters and metrics, thresholds, and tolerances \nassociated with the parameters.", - "type": "object", - "properties": { - "conformanceComparator": { - "type": "string", - "description": "An operator that specifies whether a Service Level Objective is \nviolated above or below the conformanceTarget." - }, - "conformancePeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "An interval of time during which the Conformance Target must be measured." - }, - "conformanceTarget": { - "type": "string", - "description": "A value used to determine if Service Level Objective is met. \nThe data type should be adjusted case by case." - }, - "graceTimes": { - "type": "string", - "description": "The number of times an objective can remain un-updated without \na violation of a Service Level Agreement in reference to a measurement period and/or Service Level Agreement reporting period." - }, - "href": { - "type": "string", - "description": "The hyperlink to access a service level objective." - }, - "id": { - "type": "string", - "description": "The identifier of a service level objectives." - }, - "name": { - "type": "string", - "description": "The name of the service level objectives." - }, - "thresholdTarget": { - "type": "string", - "description": "A value that used to specify when a warning should be used \nthat indicates an objective is danger of not being met. Notice, the data type should be adjusted case by case." - }, - "tolerancePeriod": { - "description": "A value that specifies the allowable time variation of a conformance", - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - }, - "toleranceTarget": { - "type": "string", - "description": "A value that specifies the allowable variation of a conformance \nTarget. The data type should be adjusted case by case." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "A valid duration of a thing." - }, - "serviceLevelSpecParameter": { - "description": "A parameter for this objective", - "$ref": "ServiceLevelSpecParameter.schema.json#ServiceLevelSpecParameter" - }, - "serviceLevelSpecConsequence": { - "type": "array", - "description": "A list of consequences for this objective.", - "items": { - "$ref": "ServiceLevelSpecConsequence.schema.json#ServiceLevelSpecConsequence" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceLevelObjective.schema.json", + "title": "ServiceLevelObjective", + "definitions": { + "ServiceLevelObjective": { + "$id": "#ServiceLevelObjective", + "description": "Service level objectives are defined in terms of parameters and metrics, thresholds, and tolerances \nassociated with the parameters.", + "type": "object", + "properties": { + "conformanceComparator": { + "type": "string", + "description": "An operator that specifies whether a Service Level Objective is \nviolated above or below the conformanceTarget." + }, + "conformancePeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "An interval of time during which the Conformance Target must be measured." + }, + "conformanceTarget": { + "type": "string", + "description": "A value used to determine if Service Level Objective is met. \nThe data type should be adjusted case by case." + }, + "graceTimes": { + "type": "string", + "description": "The number of times an objective can remain un-updated without \na violation of a Service Level Agreement in reference to a measurement period and/or Service Level Agreement reporting period." + }, + "href": { + "type": "string", + "description": "The hyperlink to access a service level objective." + }, + "id": { + "type": "string", + "description": "The identifier of a service level objectives." + }, + "name": { + "type": "string", + "description": "The name of the service level objectives." + }, + "thresholdTarget": { + "type": "string", + "description": "A value that used to specify when a warning should be used \nthat indicates an objective is danger of not being met. Notice, the data type should be adjusted case by case." + }, + "tolerancePeriod": { + "description": "A value that specifies the allowable time variation of a conformance", + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + }, + "toleranceTarget": { + "type": "string", + "description": "A value that specifies the allowable variation of a conformance \nTarget. The data type should be adjusted case by case." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "A valid duration of a thing." + }, + "serviceLevelSpecParameter": { + "description": "A parameter for this objective", + "$ref": "ServiceLevelSpecParameter.schema.json#ServiceLevelSpecParameter" + }, + "serviceLevelSpecConsequence": { + "type": "array", + "description": "A list of consequences for this objective.", + "items": { + "$ref": "ServiceLevelSpecConsequence.schema.json#ServiceLevelSpecConsequence" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceLevelObjectiveRef.schema.json b/Service/ServiceLevelObjectiveRef.schema.json index 37b3f572..dc6d3abf 100644 --- a/Service/ServiceLevelObjectiveRef.schema.json +++ b/Service/ServiceLevelObjectiveRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceLevelObjectiveRef.schema.json", - "title": "ServiceLevelObjectiveRef", - "definitions": { - "ServiceLevelObjectiveRef": { - "$id": "#ServiceLevelObjectiveRef", - "description": "A set of Service Level Objectives that are contained in the Service Level Specification.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The hyperlink to access a service level object." - }, - "id": { - "type": "string", - "description": "The identifier of a service level object." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceLevelObjectiveRef.schema.json", + "title": "ServiceLevelObjectiveRef", + "definitions": { + "ServiceLevelObjectiveRef": { + "$id": "#ServiceLevelObjectiveRef", + "description": "A set of Service Level Objectives that are contained in the Service Level Specification.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The hyperlink to access a service level object." + }, + "id": { + "type": "string", + "description": "The identifier of a service level object." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceLevelSpecConsequence.schema.json b/Service/ServiceLevelSpecConsequence.schema.json index 63ea28a1..0d9f89d5 100644 --- a/Service/ServiceLevelSpecConsequence.schema.json +++ b/Service/ServiceLevelSpecConsequence.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceLevelSpecConsequence.schema.json", - "title": "ServiceLevelSpecConsequence", - "definitions": { - "ServiceLevelSpecConsequence": { - "$id": "#ServiceLevelSpecConsequence", - "description": "Some consequences for the provider of the Service are resulted when the service level objective\ndoes not meet.", - "type": "object", - "properties": { - "prescribedAction": { - "type": "string", - "description": "Recommended remedy for a violated Service Level Objective. \nThis could be a hyperlink to the recommended action." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "A valid duration of a thing." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceLevelSpecConsequence.schema.json", + "title": "ServiceLevelSpecConsequence", + "definitions": { + "ServiceLevelSpecConsequence": { + "$id": "#ServiceLevelSpecConsequence", + "description": "Some consequences for the provider of the Service are resulted when the service level objective\ndoes not meet.", + "type": "object", + "properties": { + "prescribedAction": { + "type": "string", + "description": "Recommended remedy for a violated Service Level Objective. \nThis could be a hyperlink to the recommended action." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "A valid duration of a thing." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceLevelSpecParameter.schema.json b/Service/ServiceLevelSpecParameter.schema.json index 61945cf5..4717400c 100644 --- a/Service/ServiceLevelSpecParameter.schema.json +++ b/Service/ServiceLevelSpecParameter.schema.json @@ -1,50 +1,50 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceLevelSpecParameter.schema.json", - "title": "ServiceLevelSpecParameter", - "definitions": { - "ServiceLevelSpecParameter": { - "$id": "#ServiceLevelSpecParameter", - "description": "Service Level Specification parameters can be one of two types. A Key Quality Indicator (KQI) \nprovides a measurement of a specific aspect of the performance of a Product (i.e., Product \nSpecification, Product Offering, or Product) or a Service (i.e., Service Specification or Service).", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the parameter" - }, - "serviceParmCategory": { - "type": "string", - "description": "A string that specifies whether the Service Level Specification Parameter is technology specific, service specific, or technology/service independent" - }, - "serviceParmPerspective": { - "type": "string", - "description": "A string that specifies whether the Service Level Specification Parameter represents a single user instance parameter or a parameter that represents an aggregation" - }, - "transformationAlgorithmOfKQI": { - "type": "string", - "description": "The description of a logical step-by-step procedure used to calculate the value of a KQI" - }, - "parameterType": { - "type": "string", - "description": "Types of Service Level Specification parameters are KQI or KPI" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "A valid duration of a thing" - }, - "relatedEntity": { - "type": "array", - "description": "A list of entities related to this parameter", - "items": { - "$ref": "../Common/RelatedEntityRef.schema.json#RelatedEntityRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceLevelSpecParameter.schema.json", + "title": "ServiceLevelSpecParameter", + "definitions": { + "ServiceLevelSpecParameter": { + "$id": "#ServiceLevelSpecParameter", + "description": "Service Level Specification parameters can be one of two types. A Key Quality Indicator (KQI) \nprovides a measurement of a specific aspect of the performance of a Product (i.e., Product \nSpecification, Product Offering, or Product) or a Service (i.e., Service Specification or Service).", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the parameter" + }, + "serviceParmCategory": { + "type": "string", + "description": "A string that specifies whether the Service Level Specification Parameter is technology specific, service specific, or technology/service independent" + }, + "serviceParmPerspective": { + "type": "string", + "description": "A string that specifies whether the Service Level Specification Parameter represents a single user instance parameter or a parameter that represents an aggregation" + }, + "transformationAlgorithmOfKQI": { + "type": "string", + "description": "The description of a logical step-by-step procedure used to calculate the value of a KQI" + }, + "parameterType": { + "type": "string", + "description": "Types of Service Level Specification parameters are KQI or KPI" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "A valid duration of a thing" + }, + "relatedEntity": { + "type": "array", + "description": "A list of entities related to this parameter", + "items": { + "$ref": "../Common/RelatedEntityRef.schema.json#RelatedEntityRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceLevelSpecification.schema.json b/Service/ServiceLevelSpecification.schema.json index 5babc49a..ca5e4929 100644 --- a/Service/ServiceLevelSpecification.schema.json +++ b/Service/ServiceLevelSpecification.schema.json @@ -1,46 +1,46 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceLevelSpecification.schema.json", - "title": "ServiceLevelSpecification", - "definitions": { - "ServiceLevelSpecification": { - "$id": "#ServiceLevelSpecification", - "description": "A Service Level Specification represents a pre-defined or negotiated set of Service Level \nObjectives. In addition, certain consequences are associated with not meeting the Service Level \nObjectives. Service Level Agreements are expressed in terms of Service Level Specifications.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A brief introduction of a service level specification." - }, - "href": { - "type": "string", - "description": "The hyperlink to access a service level specification." - }, - "id": { - "type": "string", - "description": "The identifier to a service level specification." - }, - "name": { - "type": "string", - "description": "The name of Service Level Specification" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "A valid duration of a thing." - }, - "relatedServiceLevelObjective": { - "type": "array", - "description": "A list of objectives related to this service level specification", - "items": { - "$ref": "ServiceLevelObjectiveRef.schema.json#ServiceLevelObjectiveRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceLevelSpecification.schema.json", + "title": "ServiceLevelSpecification", + "definitions": { + "ServiceLevelSpecification": { + "$id": "#ServiceLevelSpecification", + "description": "A Service Level Specification represents a pre-defined or negotiated set of Service Level \nObjectives. In addition, certain consequences are associated with not meeting the Service Level \nObjectives. Service Level Agreements are expressed in terms of Service Level Specifications.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A brief introduction of a service level specification." + }, + "href": { + "type": "string", + "description": "The hyperlink to access a service level specification." + }, + "id": { + "type": "string", + "description": "The identifier to a service level specification." + }, + "name": { + "type": "string", + "description": "The name of Service Level Specification" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "A valid duration of a thing." + }, + "relatedServiceLevelObjective": { + "type": "array", + "description": "A list of objectives related to this service level specification", + "items": { + "$ref": "ServiceLevelObjectiveRef.schema.json#ServiceLevelObjectiveRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceLevelSpecificationRef.schema.json b/Service/ServiceLevelSpecificationRef.schema.json index 45cd9339..9579e1f2 100755 --- a/Service/ServiceLevelSpecificationRef.schema.json +++ b/Service/ServiceLevelSpecificationRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceLevelSpecificationRef.schema.json", - "title": "ServiceLevelSpecificationRef", - "definitions": { - "ServiceLevelSpecificationRef": { - "$id": "#ServiceLevelSpecificationRef", - "description": "A Service Level Specification represents a pre-defined or negotiated set of Service Level \nObjectives. In addition, certain consequences are associated with not meeting the Service Level \nObjectives. Service Level Agreements are expressed in terms of Service Level Specifications.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The hyperlink to access a service level specification." - }, - "id": { - "type": "string", - "description": "The identifier to a service level specification." - }, - "name": { - "type": "string", - "description": "The name of Service Level Specification" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceLevelSpecificationRef.schema.json", + "title": "ServiceLevelSpecificationRef", + "definitions": { + "ServiceLevelSpecificationRef": { + "$id": "#ServiceLevelSpecificationRef", + "description": "A Service Level Specification represents a pre-defined or negotiated set of Service Level \nObjectives. In addition, certain consequences are associated with not meeting the Service Level \nObjectives. Service Level Agreements are expressed in terms of Service Level Specifications.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The hyperlink to access a service level specification." + }, + "id": { + "type": "string", + "description": "The identifier to a service level specification." + }, + "name": { + "type": "string", + "description": "The name of Service Level Specification" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceOfferingQualificationRef.schema.json b/Service/ServiceOfferingQualificationRef.schema.json index 62909212..30386405 100644 --- a/Service/ServiceOfferingQualificationRef.schema.json +++ b/Service/ServiceOfferingQualificationRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOfferingQualificationRef.schema.json", - "title": "ServiceOfferingQualificationRef", - "definitions": { - "ServiceOfferingQualificationRef": { - "$id": "#ServiceOfferingQualificationRef", - "description": "It could be a serviceQualification or a productOfferingQualification that has been executed previously and captured in the productOrder to provide eligibility information", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "href of the qualification" - }, - "id": { - "type": "string", - "description": "Identifier of a pre-existing qualification" - }, - "qualificationItemId": { - "type": "string", - "description": "Id of an item of a qualification" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation" - } - }, - "allOf": [ - { - "$ref": "../Common/QualificationRef.schema.json#QualificationRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOfferingQualificationRef.schema.json", + "title": "ServiceOfferingQualificationRef", + "definitions": { + "ServiceOfferingQualificationRef": { + "$id": "#ServiceOfferingQualificationRef", + "description": "It could be a serviceQualification or a productOfferingQualification that has been executed previously and captured in the productOrder to provide eligibility information", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "href of the qualification" + }, + "id": { + "type": "string", + "description": "Identifier of a pre-existing qualification" + }, + "qualificationItemId": { + "type": "string", + "description": "Id of an item of a qualification" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation" } + }, + "allOf": [ + { + "$ref": "../Common/QualificationRef.schema.json#QualificationRef" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceOrder.schema.json b/Service/ServiceOrder.schema.json index 0902611f..fa3b9757 100644 --- a/Service/ServiceOrder.schema.json +++ b/Service/ServiceOrder.schema.json @@ -1,108 +1,108 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrder.schema.json", - "title": "ServiceOrder", - "definitions": { - "ServiceOrder": { - "$id": "#ServiceOrder", - "type": "object", - "properties": { - "category": { - "type": "string", - "description": "Used to categorize the order, useful for the OM system, such as: Broadband, TVOption" - }, - "completionDate": { - "type": "string", - "format": "date-time", - "description": "Effective delivery date amended by the provider" - }, - "description": { - "type": "string", - "description": "A free-text description of the service order" - }, - "expectedCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Expected delivery date amended by the provider" - }, - "externalId": { - "type": "string", - "description": "ID given by the consumer to facilitate searches" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the order" - }, - "id": { - "type": "string", - "description": "ID created on repository side" - }, - "note": { - "type": "array", - "description": "Extra-information about the order; e.g. useful to add extra delivery information that could be useful for a human process", - "items": { - "$ref": "../Common/Note.schema.json#/definitions/Note" - } - }, - "notificationContact": { - "type": "string", - "description": "Contact attached to the order to send back information regarding this order" - }, - "orderDate": { - "type": "string", - "format": "date-time" - }, - "orderItem": { - "type": "array", - "minItems" : 1, - "description": "A list of service order items to be processed by this order", - "items": { - "$ref": "ServiceOrderItem.schema.json#/definitions/ServiceOrderItem" - } - }, - "orderRelationship": { - "type": "array", - "description": "A list of service orders related to this order (e.g. prerequisite, dependent on)", - "items": { - "$ref": "ServiceOrderRelationship.schema.json#/definitions/ServiceOrderRelationship" - } - }, - "priority": { - "type": "string", - "description": "Can be used by consumers to prioritize orders in a Service Order Management system" - }, - "relatedParty": { - "type": "array", - "description": "A list of parties which are involved in this order and the role they are playing", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#/definitions/RelatedParty" - } - }, - "requestedCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Requested delivery date from the requestors perspective" - }, - "requestedStartDate": { - "type": "string", - "format": "date-time", - "description": "Order start date wished by the requestor" - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order was started for processing" - }, - "state": { - "description": "State of the order: described in the state-machine diagram", - "$ref": "ServiceOrderStateType.schema.json#/definitions/ServiceOrderStateType" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrder.schema.json", + "title": "ServiceOrder", + "definitions": { + "ServiceOrder": { + "$id": "#ServiceOrder", + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Used to categorize the order, useful for the OM system, such as: Broadband, TVOption" + }, + "completionDate": { + "type": "string", + "format": "date-time", + "description": "Effective delivery date amended by the provider" + }, + "description": { + "type": "string", + "description": "A free-text description of the service order" + }, + "expectedCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Expected delivery date amended by the provider" + }, + "externalId": { + "type": "string", + "description": "ID given by the consumer to facilitate searches" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the order" + }, + "id": { + "type": "string", + "description": "ID created on repository side" + }, + "note": { + "type": "array", + "description": "Extra-information about the order; e.g. useful to add extra delivery information that could be useful for a human process", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "notificationContact": { + "type": "string", + "description": "Contact attached to the order to send back information regarding this order" + }, + "orderDate": { + "type": "string", + "format": "date-time" + }, + "orderItem": { + "type": "array", + "minItems": 1, + "description": "A list of service order items to be processed by this order", + "items": { + "$ref": "ServiceOrderItem.schema.json#ServiceOrderItem" + } + }, + "orderRelationship": { + "type": "array", + "description": "A list of service orders related to this order (e.g. prerequisite, dependent on)", + "items": { + "$ref": "ServiceOrderRelationship.schema.json#ServiceOrderRelationship" + } + }, + "priority": { + "type": "string", + "description": "Can be used by consumers to prioritize orders in a Service Order Management system" + }, + "relatedParty": { + "type": "array", + "description": "A list of parties which are involved in this order and the role they are playing", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "requestedCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Requested delivery date from the requestors perspective" + }, + "requestedStartDate": { + "type": "string", + "format": "date-time", + "description": "Order start date wished by the requestor" + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order was started for processing" + }, + "state": { + "description": "State of the order: described in the state-machine diagram", + "$ref": "ServiceOrderStateType.schema.json#ServiceOrderStateType" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceOrderActionType.schema.json b/Service/ServiceOrderActionType.schema.json index 3895a9fb..b787995b 100644 --- a/Service/ServiceOrderActionType.schema.json +++ b/Service/ServiceOrderActionType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrderActionType.schema.json", - "title": "ServiceOrderActionType", - "definitions": { - "ServiceOrderActionType": { - "$id": "#ServiceOrderActionType", - "description": "string", - "type": "string", - "enum": [ - "add", - "modify", - "delete", - "noChange" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrderActionType.schema.json", + "title": "ServiceOrderActionType", + "definitions": { + "ServiceOrderActionType": { + "$id": "#ServiceOrderActionType", + "description": "string", + "type": "string", + "enum": [ + "add", + "modify", + "delete", + "noChange" + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceOrderItem.schema.json b/Service/ServiceOrderItem.schema.json index f17ada13..6ec723f5 100644 --- a/Service/ServiceOrderItem.schema.json +++ b/Service/ServiceOrderItem.schema.json @@ -1,46 +1,49 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrderItem.schema.json", - "title": "ServiceOrderItem", - "definitions": { - "ServiceOrderItem": { - "$id": "#ServiceOrderItem", - "type": "object", - "required": ["id", "action"], - "properties": { - "id": { - "type": "string", - "description": "Identifier of the individual line item" - }, - "action": { - "description": "The action to be carried out on the Service. Can be: add, modify, delete, noChange", - "$ref": "ServiceOrderActionType.schema.json#/definitions/ServiceOrderActionType" - }, - "state": { - "description": "State of the order item: described in the state machine diagram. This is the requested state.", - "$ref": "ServiceOrderStateType.schema.json#/definitions/ServiceOrderStateType" - }, - "service": { - "description": "The Service to be acted on by the order item", - "$ref": "BaseService.schema.json#/definitions/BaseService" - }, - "appointment": { - "description": "An appointment that was set up with a related party for this order item", - "$ref": "../Customer/AppointmentRef.schema.json#/definitions/AppointmentRef" - }, - "serviceOrderItemRelationship": { - "type": "array", - "description": "A list of order items related to this order item", - "items": { - "$ref": "OrderItemRelationship.schema.json#/definitions/OrderItemRelationship" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrderItem.schema.json", + "title": "ServiceOrderItem", + "definitions": { + "ServiceOrderItem": { + "$id": "#ServiceOrderItem", + "type": "object", + "required": [ + "id", + "action" + ], + "properties": { + "id": { + "type": "string", + "description": "Identifier of the individual line item" + }, + "action": { + "description": "The action to be carried out on the Service. Can be: add, modify, delete, noChange", + "$ref": "ServiceOrderActionType.schema.json#ServiceOrderActionType" + }, + "state": { + "description": "State of the order item: described in the state machine diagram. This is the requested state.", + "$ref": "ServiceOrderStateType.schema.json#ServiceOrderStateType" + }, + "service": { + "description": "The Service to be acted on by the order item", + "$ref": "BaseService.schema.json#BaseService" + }, + "appointment": { + "description": "An appointment that was set up with a related party for this order item", + "$ref": "../Customer/AppointmentRef.schema.json#AppointmentRef" + }, + "serviceOrderItemRelationship": { + "type": "array", + "description": "A list of order items related to this order item", + "items": { + "$ref": "../Customer/OrderItemRelationship.schema.json#OrderItemRelationship" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceOrderItemRelationship.schema.json b/Service/ServiceOrderItemRelationship.schema.json index e2f1b8a7..a660637c 100644 --- a/Service/ServiceOrderItemRelationship.schema.json +++ b/Service/ServiceOrderItemRelationship.schema.json @@ -1,28 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrderItemRelationship.schema.json", - "title": "ServiceOrderItemRelationship", - "definitions": { - "ServiceOrderItemRelationship": { - "$id": "#ServiceOrderItemRelationship", - "type": "object", - "description": "Linked service order item to the one containing this attribute", - "required": ["id", "relationshipType"], - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of a service order item" - }, - "relationshipType": { - "type": "string", - "description": "The type of related order item, can be: dependency if the order item needs to be not started until another order item is complete" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrderItemRelationship.schema.json", + "title": "ServiceOrderItemRelationship", + "definitions": { + "ServiceOrderItemRelationship": { + "$id": "#ServiceOrderItemRelationship", + "type": "object", + "description": "Linked service order item to the one containing this attribute", + "required": [ + "id", + "relationshipType" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of a service order item" + }, + "relationshipType": { + "type": "string", + "description": "The type of related order item, can be: dependency if the order item needs to be not started until another order item is complete" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceOrderRef.schema.json b/Service/ServiceOrderRef.schema.json index d0bb6e76..aa3ecf48 100644 --- a/Service/ServiceOrderRef.schema.json +++ b/Service/ServiceOrderRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrderRef.schema.json", - "title": "ServiceOrderRef", - "definitions": { - "ServiceOrderRef": { - "$id": "#ServiceOrderRef", - "description": "Service Order reference. Useful to understand the which was the Service order through which the service was instantiated in the service inventory", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the Service Order" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Service Order" - }, - "serviceOrderItemId": { - "type": "string", - "description": "Unique identifier of the Service Order Item within a service order, not populated if this is a reference to a service order" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrderRef.schema.json", + "title": "ServiceOrderRef", + "definitions": { + "ServiceOrderRef": { + "$id": "#ServiceOrderRef", + "description": "Service Order reference. Useful to understand the which was the Service order through which the service was instantiated in the service inventory", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the Service Order" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Service Order" + }, + "serviceOrderItemId": { + "type": "string", + "description": "Unique identifier of the Service Order Item within a service order, not populated if this is a reference to a service order" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceOrderRelationship.schema.json b/Service/ServiceOrderRelationship.schema.json index c0990a07..f9f8b62f 100644 --- a/Service/ServiceOrderRelationship.schema.json +++ b/Service/ServiceOrderRelationship.schema.json @@ -1,36 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrderRelationship.schema.json", - "title": "ServiceOrderRelationship", - "definitions": { - "ServiceOrderRelationship": { - "$id": "#ServiceOrderRelationship", - "type": "object", - "description": "Linked service order to the one containing this attribute", - "required": ["id"], - "properties": { - "@referredType": { - "type": "string", - "description": "The entity type of the related order" - }, - "href": { - "type": "string", - "description": "A hyperlink to the related order" - }, - "id": { - "type": "string", - "description": "The id of the related order" - }, - "relationshipType": { - "type": "string", - "description": "The type of related order, such as: [dependency] if the order needs to be [not started] until another order item is complete (a service order in this case) or [cross-ref] to keep track of the source order (a productOrder)" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrderRelationship.schema.json", + "title": "ServiceOrderRelationship", + "definitions": { + "ServiceOrderRelationship": { + "$id": "#ServiceOrderRelationship", + "type": "object", + "description": "Linked service order to the one containing this attribute", + "required": [ + "id" + ], + "properties": { + "@referredType": { + "type": "string", + "description": "The entity type of the related order" + }, + "href": { + "type": "string", + "description": "A hyperlink to the related order" + }, + "id": { + "type": "string", + "description": "The id of the related order" + }, + "relationshipType": { + "type": "string", + "description": "The type of related order, such as: [dependency] if the order needs to be [not started] until another order item is complete (a service order in this case) or [cross-ref] to keep track of the source order (a productOrder)" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceOrderStateType.schema.json b/Service/ServiceOrderStateType.schema.json index da50fb79..e93a0e86 100644 --- a/Service/ServiceOrderStateType.schema.json +++ b/Service/ServiceOrderStateType.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrderStateType.schema.json", - "title": "ServiceOrderStateType", - "definitions": { - "ServiceOrderStateType": { - "$id": "#ServiceOrderStateType", - "type": "string", - "description": "Possible values for the state of the order", - "enum": [ - "acknowledged", - "rejected", - "pending", - "held", - "inProgress", - "cancelled", - "completed", - "failed", - "partial" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrderStateType.schema.json", + "title": "ServiceOrderStateType", + "definitions": { + "ServiceOrderStateType": { + "$id": "#ServiceOrderStateType", + "type": "string", + "description": "Possible values for the state of the order", + "enum": [ + "acknowledged", + "rejected", + "pending", + "held", + "inProgress", + "cancelled", + "completed", + "failed", + "partial" + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceProblem.schema.json b/Service/ServiceProblem.schema.json index 2eca96be..59d85f69 100644 --- a/Service/ServiceProblem.schema.json +++ b/Service/ServiceProblem.schema.json @@ -1,219 +1,219 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceProblem.schema.json", - "title": "ServiceProblem", - "definitions": { - "ServiceProblem": { - "$id": "#ServiceProblem", - "type": "object", - "description": "The problem information for Middle B which is abstracted in the service layer from the issued event information by First B", - "properties": { - "affectedLocation": { - "type": "array", - "description": "A list of the locations affected by the problem. At least one of affectedResource, affectedService or affectedLocation should be present.", - "items": { - "$ref": "../Common/Place.schema.json#/definitions/Place" - } - }, - "affectedNumberOfServices": { - "type": "integer", - "description": "Number of affected services" - }, - "affectedResource": { - "type": "array", - "description": "A list of the resources affected by the problem. At least one of affectedResource, affectedService or affectedLocation should be present.", - "items": { - "$ref": "../Resource/ResourceRef.schema.json#/definitions/ResourceRef" - } - }, - "affectedService": { - "type": "array", - "description": "List of affected services. At least one of affectedResource, affectedService or affectedLocation should be present.", - "items": { - "$ref": "ServiceRef.schema.json#/definitions/ServiceRef" - } - }, - "category": { - "type": "string", - "description": "Classifier for the problem. Settable. For example, this is used for distinguish the category of problem originator in [role].[category] format. Example: serviceProvider.declarer, supplier.originated, system.originated" - }, - "comment": { - "type": "array", - "description": "A list of comments or notes made on the problem", - "items": { - "$ref": "../Common/Note.schema.json#/definitions/Note" - } - }, - "correlationId": { - "type": "string", - "description": "Additional identifier coming from an external system" - }, - "description": { - "type": "string", - "description": "Free form text describing the Service Problem" - }, - "extensionInfo": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#/definitions/Characteristic" - }, - "description": "A generic list of any type of elements. Used for vendor Extensions or loose element encapsulation from other namespaces" - }, - "firstAlert": { - "description": "Indicates what first alerted the system to the problem. It is not the root cause of the Service Problem. Examples: Threshold crossing alert", - "$ref": "../Common/RelatedEntityRef.schema.json#/definitions/RelatedEntityRef" - }, - "href": { - "type": "string", - "description": "Reference to the Service Problem" - }, - "id": { - "type": "string", - "description": "Identifier of the service problem" - }, - "impactImportanceFactor": { - "type": "string", - "description": "Impact Importance is characterized by an Impact Importance Factor: overall importance of the impact of all the affected services, e.g. 0 (zero impact) to 100 (worst impact). The Impact Importance is a calculated field which is set by the OSS determining the impact." - }, - "impactPatterns": { - "description": "Define the patterns of impact (optional)- e.g. other service characteristics- Used when defining impact through another pattern than the predefined attributes.", - "$ref": "ImpactPattern.schema.json#/definitions/ImpactPattern" - }, - "originatingSystem": { - "type": "string", - "description": "Indicates where the problem was generated" - }, - "parentProblem": { - "type": "array", - "description": "The parent problem to which this problem is attached.", - "items": { - "$ref": "ServiceProblemRef.schema.json#/definitions/ServiceProblemRef" - } - }, - "priority": { - "type": "integer", - "description": "An indication varying from 1 (highest) to 10 (lowest) of how important it is for the service provider to correct the Service Problem." - }, - "problemEscalation": { - "type": "string", - "description": "Indicates if this service problem has been escalated or not. Possible values are 0 to 10. A value of zero means no escalation. The meanings of values 1-10 are to be determined by the user of the interface, but they show increasing levels of escalation." - }, - "reason": { - "type": "string", - "description": "Free text or optionally structured text. It can be Unknown." - }, - "relatedEvent": { - "type": "array", - "description": "List of events associated to this problem", - "items": { - "$ref": "../Common/EventRef.schema.json#/definitions/EventRef" - } - }, - "relatedObject": { - "type": "array", - "description": "List of objects associated to this problem", - "items": { - "$ref": "../Common/RelatedEntityRef.schema.json#/definitions/RelatedEntityRef" - } - }, - "originatorParty": { - "description": "Individual or organization that created the problem", - "$ref": "../EngagedParty/RelatedParty.schema.json#/definitions/RelatedParty" - }, - "responsibleParty": { - "description": "Individual or organization responsible for handling this problem", - "$ref": "../EngagedParty/RelatedParty.schema.json#/definitions/RelatedParty" - }, - "relatedParty": { - "type": "array", - "description": "List of parties or party roles playing a role within the service problem", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#/definitions/RelatedParty" - } - }, - "rootCauseResource": { - "type": "array", - "description": "Resource(s) that are associated to the underlying service problems that are the Root Cause of this one if any (used only if applicable).", - "items": { - "$ref": "../Resource/ResourceRef.schema.json#/definitions/ResourceRef" - } - }, - "rootCauseService": { - "type": "array", - "description": "Service(s) that are associated to the underlying service problems that are the Root Cause of this one if any (used only if applicable)", - "items": { - "$ref": "ServiceRef.schema.json#/definitions/ServiceRef" - } - }, - "resolutionDate": { - "type": "string", - "format": "date-time", - "description": "Time the problem was resolved" - }, - "status": { - "type": "string", - "description": "The current status of the service problem. Possible values are Submitted, Rejected, Acknowledged, In Progress [Held, Pending], Resolved, Closed, and Cancelled." - }, - "statusChangeDate": { - "type": "string", - "format": "date-time", - "description": "Time the problem was last status changed" - }, - "statusChangeReason": { - "type": "string", - "description": "The reason of state change" - }, - "timeChanged": { - "type": "string", - "format": "date-time", - "description": "Time the problem was last changed" - }, - "timeRaised": { - "type": "string", - "format": "date-time", - "description": "Time the problem was raised" - }, - "trackingRecord": { - "type": "array", - "description": "List of tracking records that allow the tracking of modifications on the problem.The tracking records should not be embedded in the problem to allow retrieving the problem without the tracking records", - "items": { - "$ref": "TrackingRecord.schema.json#/definitions/TrackingRecord" - } - }, - "underlyingAlarm": { - "type": "array", - "description": "A list of alarms underlying this problem.", - "items": { - "$ref": "../Resource/ResourceAlarmRef.schema.json#/definitions/ResourceAlarmRef" - } - }, - "associatedSLAViolation": { - "type": "array", - "description": "A List of SLA violations associated with this problem.", - "items": { - "$ref": "../EngagedParty/SLAViolationRef.schema.json#/definitions/SLAViolationRef" - } - }, - "associatedTroubleTicket": { - "type": "array", - "description": "A list of trouble tickets associated with this problem.", - "items": { - "$ref": "../Common/TroubleTicketRef.schema.json#/definitions/TroubleTicketRef" - } - }, - "underlyingProblem": { - "type": "array", - "description": "A list of underlying problems. Relevant only if this problem is derived from other problems.", - "items": { - "$ref": "ServiceProblemRef.schema.json#/definitions/ServiceProblemRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceProblem.schema.json", + "title": "ServiceProblem", + "definitions": { + "ServiceProblem": { + "$id": "#ServiceProblem", + "type": "object", + "description": "The problem information for Middle B which is abstracted in the service layer from the issued event information by First B", + "properties": { + "affectedLocation": { + "type": "array", + "description": "A list of the locations affected by the problem. At least one of affectedResource, affectedService or affectedLocation should be present.", + "items": { + "$ref": "../Common/Place.schema.json#Place" + } + }, + "affectedNumberOfServices": { + "type": "integer", + "description": "Number of affected services" + }, + "affectedResource": { + "type": "array", + "description": "A list of the resources affected by the problem. At least one of affectedResource, affectedService or affectedLocation should be present.", + "items": { + "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" + } + }, + "affectedService": { + "type": "array", + "description": "List of affected services. At least one of affectedResource, affectedService or affectedLocation should be present.", + "items": { + "$ref": "ServiceRef.schema.json#ServiceRef" + } + }, + "category": { + "type": "string", + "description": "Classifier for the problem. Settable. For example, this is used for distinguish the category of problem originator in [role].[category] format. Example: serviceProvider.declarer, supplier.originated, system.originated" + }, + "comment": { + "type": "array", + "description": "A list of comments or notes made on the problem", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "correlationId": { + "type": "string", + "description": "Additional identifier coming from an external system" + }, + "description": { + "type": "string", + "description": "Free form text describing the Service Problem" + }, + "extensionInfo": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + }, + "description": "A generic list of any type of elements. Used for vendor Extensions or loose element encapsulation from other namespaces" + }, + "firstAlert": { + "description": "Indicates what first alerted the system to the problem. It is not the root cause of the Service Problem. Examples: Threshold crossing alert", + "$ref": "../Common/RelatedEntityRef.schema.json#RelatedEntityRef" + }, + "href": { + "type": "string", + "description": "Reference to the Service Problem" + }, + "id": { + "type": "string", + "description": "Identifier of the service problem" + }, + "impactImportanceFactor": { + "type": "string", + "description": "Impact Importance is characterized by an Impact Importance Factor: overall importance of the impact of all the affected services, e.g. 0 (zero impact) to 100 (worst impact). The Impact Importance is a calculated field which is set by the OSS determining the impact." + }, + "impactPatterns": { + "description": "Define the patterns of impact (optional)- e.g. other service characteristics- Used when defining impact through another pattern than the predefined attributes.", + "$ref": "ImpactPattern.schema.json#ImpactPattern" + }, + "originatingSystem": { + "type": "string", + "description": "Indicates where the problem was generated" + }, + "parentProblem": { + "type": "array", + "description": "The parent problem to which this problem is attached.", + "items": { + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "priority": { + "type": "integer", + "description": "An indication varying from 1 (highest) to 10 (lowest) of how important it is for the service provider to correct the Service Problem." + }, + "problemEscalation": { + "type": "string", + "description": "Indicates if this service problem has been escalated or not. Possible values are 0 to 10. A value of zero means no escalation. The meanings of values 1-10 are to be determined by the user of the interface, but they show increasing levels of escalation." + }, + "reason": { + "type": "string", + "description": "Free text or optionally structured text. It can be Unknown." + }, + "relatedEvent": { + "type": "array", + "description": "List of events associated to this problem", + "items": { + "$ref": "../Common/EventRef.schema.json#EventRef" + } + }, + "relatedObject": { + "type": "array", + "description": "List of objects associated to this problem", + "items": { + "$ref": "../Common/RelatedEntityRef.schema.json#RelatedEntityRef" + } + }, + "originatorParty": { + "description": "Individual or organization that created the problem", + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "responsibleParty": { + "description": "Individual or organization responsible for handling this problem", + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "relatedParty": { + "type": "array", + "description": "List of parties or party roles playing a role within the service problem", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "rootCauseResource": { + "type": "array", + "description": "Resource(s) that are associated to the underlying service problems that are the Root Cause of this one if any (used only if applicable).", + "items": { + "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" + } + }, + "rootCauseService": { + "type": "array", + "description": "Service(s) that are associated to the underlying service problems that are the Root Cause of this one if any (used only if applicable)", + "items": { + "$ref": "ServiceRef.schema.json#ServiceRef" + } + }, + "resolutionDate": { + "type": "string", + "format": "date-time", + "description": "Time the problem was resolved" + }, + "status": { + "type": "string", + "description": "The current status of the service problem. Possible values are Submitted, Rejected, Acknowledged, In Progress [Held, Pending], Resolved, Closed, and Cancelled." + }, + "statusChangeDate": { + "type": "string", + "format": "date-time", + "description": "Time the problem was last status changed" + }, + "statusChangeReason": { + "type": "string", + "description": "The reason of state change" + }, + "timeChanged": { + "type": "string", + "format": "date-time", + "description": "Time the problem was last changed" + }, + "timeRaised": { + "type": "string", + "format": "date-time", + "description": "Time the problem was raised" + }, + "trackingRecord": { + "type": "array", + "description": "List of tracking records that allow the tracking of modifications on the problem.The tracking records should not be embedded in the problem to allow retrieving the problem without the tracking records", + "items": { + "$ref": "TrackingRecord.schema.json#TrackingRecord" + } + }, + "underlyingAlarm": { + "type": "array", + "description": "A list of alarms underlying this problem.", + "items": { + "$ref": "../Resource/ResourceAlarmRef.schema.json#ResourceAlarmRef" + } + }, + "associatedSLAViolation": { + "type": "array", + "description": "A List of SLA violations associated with this problem.", + "items": { + "$ref": "../EngagedParty/SLAViolationRef.schema.json#SLAViolationRef" + } + }, + "associatedTroubleTicket": { + "type": "array", + "description": "A list of trouble tickets associated with this problem.", + "items": { + "$ref": "../Common/TroubleTicketRef.schema.json#TroubleTicketRef" + } + }, + "underlyingProblem": { + "type": "array", + "description": "A list of underlying problems. Relevant only if this problem is derived from other problems.", + "items": { + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceProblemEventRecord.schema.json b/Service/ServiceProblemEventRecord.schema.json index c9bf6801..1d3ae1a3 100644 --- a/Service/ServiceProblemEventRecord.schema.json +++ b/Service/ServiceProblemEventRecord.schema.json @@ -1,44 +1,44 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceProblemEventRecord.schema.json", - "title": "ServiceProblemEventRecord", - "definitions": { - "ServiceProblemEventRecord": { - "$id": "#ServiceProblemEventRecord", - "type": "object", - "description": "A record of an event (related to a service problem) received from another system", - "properties": { - "eventTime": { - "description": "Time at which the event occurred", - "type": "string", - "format": "date-time" - }, - "eventType": { - "description": "Type of the recorded event", - "type": "string" - }, - "href": { - "description": "reference to this resource", - "type": "string" - }, - "id": { - "description": "Identifier of the service problem event record.", - "type": "string" - }, - "recordTime": { - "description": "Time at which the record was created", - "type": "string", - "format": "date-time" - }, - "serviceProblem": { - "description": "The service problem to which this record applies", - "$ref": "ServiceProblemRef.schema.json#/definitions/ServiceProblemRef" - }, - "notification": { - "description": "A notification from the possible notifications for Service Problem (such as creation, status change, information required, change)", - "$ref": "../Common/Any.schema.json#/definitions/Any" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceProblemEventRecord.schema.json", + "title": "ServiceProblemEventRecord", + "definitions": { + "ServiceProblemEventRecord": { + "$id": "#ServiceProblemEventRecord", + "type": "object", + "description": "A record of an event (related to a service problem) received from another system", + "properties": { + "eventTime": { + "description": "Time at which the event occurred", + "type": "string", + "format": "date-time" + }, + "eventType": { + "description": "Type of the recorded event", + "type": "string" + }, + "href": { + "description": "reference to this resource", + "type": "string" + }, + "id": { + "description": "Identifier of the service problem event record.", + "type": "string" + }, + "recordTime": { + "description": "Time at which the record was created", + "type": "string", + "format": "date-time" + }, + "serviceProblem": { + "description": "The service problem to which this record applies", + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + }, + "notification": { + "description": "A notification from the possible notifications for Service Problem (such as creation, status change, information required, change)", + "$ref": "../Common/Any.schema.json#Any" } + } } + } } \ No newline at end of file diff --git a/Service/ServiceProblemRef.schema.json b/Service/ServiceProblemRef.schema.json index ae4d80fd..dd9faca9 100644 --- a/Service/ServiceProblemRef.schema.json +++ b/Service/ServiceProblemRef.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceProblemRef.schema.json", - "title": "ServiceProblemRef", - "definitions": { - "ServiceProblemRef": { - "$id": "#ServiceProblemRef", - "type": "object", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "correlationId": { - "type": "string", - "description": "Additional identifier coming from an external system" - }, - "href": { - "type": "string", - "description": "Reference of the Problem" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Problem" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceProblemRef.schema.json", + "title": "ServiceProblemRef", + "definitions": { + "ServiceProblemRef": { + "$id": "#ServiceProblemRef", + "type": "object", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "correlationId": { + "type": "string", + "description": "Additional identifier coming from an external system" + }, + "href": { + "type": "string", + "description": "Reference of the Problem" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Problem" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceQualification.schema.json b/Service/ServiceQualification.schema.json index ab8f6949..d94aa690 100644 --- a/Service/ServiceQualification.schema.json +++ b/Service/ServiceQualification.schema.json @@ -1,95 +1,95 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceQualification.schema.json", - "title": "ServiceQualification", - "definitions": { - "ServiceQualification": { - "$id": "#ServiceQualification", - "type": "object", - "description": "ServiceQualification is used to perform a technical eligibility. It allows to retrieve a list of services that are technically available in the context of the interaction (place, party, service characteristics, ...).", - "properties": { - "description": { - "type": "string", - "description": "Description of the serviceQualification" - }, - "effectiveQualificationDate": { - "type": "string", - "description": "Effective date to serviceQualification completion", - "format": "date-time" - }, - "estimatedResponseDate": { - "type": "string", - "description": "Date when the requester expect to provide an answer for the qualification request.", - "format": "date-time" - }, - "expectedQualificationDate": { - "type": "string", - "description": "A date (DateTime). Deadline date when the requester expected a qualification answer.", - "format": "date-time" - }, - "expirationDate": { - "type": "string", - "description": "Date when the qualification response expires", - "format": "date-time" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the serviceQualification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the serviceQualification resource" - }, - "provideAlternative": { - "type": "boolean", - "description": "When the value is TRUE means that alternative solutions should be provided" - }, - "provideOnlyAvailable": { - "type": "boolean", - "description": "When the value is TRUE means that only available service must be listed in the response" - }, - "provideUnavailabilityReason": { - "type": "boolean", - "description": "When the value is TRUE means that unavailability reason are expected for non available service." - }, - "serviceQualificationDate": { - "type": "string", - "description": "Date when the serviceQualification was submitted", - "format": "date-time" - }, - "state": { - "type": "string", - "description": "State of the serviceQualification (acknowledged, inProgress, terminatedWithError, done)" - }, - "serviceQualificationItem": { - "type": "array", - "description": "A list of service qualification items.", - "minItems" : 1, - "items": { - "$ref": "ServiceQualificationItem.schema.json#ServiceQualificationItem" - } - }, - "relatedParty": { - "type": "array", - "description": "A list of related party references, defines party or party role linked to this request.", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "externalId": { - "description": "Identifier provided by the requester", - "type": "string" - }, - "qualificationResult": { - "description": "Qualification result for this serviceQualification. It could be: qualified (all qualification item are qualified), alternate (At least one item alternate and no item with unqualified), unqualified (At least one item unqualified)", - "type": "string" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceQualification.schema.json", + "title": "ServiceQualification", + "definitions": { + "ServiceQualification": { + "$id": "#ServiceQualification", + "type": "object", + "description": "ServiceQualification is used to perform a technical eligibility. It allows to retrieve a list of services that are technically available in the context of the interaction (place, party, service characteristics, ...).", + "properties": { + "description": { + "type": "string", + "description": "Description of the serviceQualification" + }, + "effectiveQualificationDate": { + "type": "string", + "description": "Effective date to serviceQualification completion", + "format": "date-time" + }, + "estimatedResponseDate": { + "type": "string", + "description": "Date when the requester expect to provide an answer for the qualification request.", + "format": "date-time" + }, + "expectedQualificationDate": { + "type": "string", + "description": "A date (DateTime). Deadline date when the requester expected a qualification answer.", + "format": "date-time" + }, + "expirationDate": { + "type": "string", + "description": "Date when the qualification response expires", + "format": "date-time" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the serviceQualification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the serviceQualification resource" + }, + "provideAlternative": { + "type": "boolean", + "description": "When the value is TRUE means that alternative solutions should be provided" + }, + "provideOnlyAvailable": { + "type": "boolean", + "description": "When the value is TRUE means that only available service must be listed in the response" + }, + "provideUnavailabilityReason": { + "type": "boolean", + "description": "When the value is TRUE means that unavailability reason are expected for non available service." + }, + "serviceQualificationDate": { + "type": "string", + "description": "Date when the serviceQualification was submitted", + "format": "date-time" + }, + "state": { + "type": "string", + "description": "State of the serviceQualification (acknowledged, inProgress, terminatedWithError, done)" + }, + "serviceQualificationItem": { + "type": "array", + "description": "A list of service qualification items.", + "minItems": 1, + "items": { + "$ref": "ServiceQualificationItem.schema.json#ServiceQualificationItem" + } + }, + "relatedParty": { + "type": "array", + "description": "A list of related party references, defines party or party role linked to this request.", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "externalId": { + "description": "Identifier provided by the requester", + "type": "string" + }, + "qualificationResult": { + "description": "Qualification result for this serviceQualification. It could be: qualified (all qualification item are qualified), alternate (At least one item alternate and no item with unqualified), unqualified (At least one item unqualified)", + "type": "string" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceQualificationItem.schema.json b/Service/ServiceQualificationItem.schema.json index 0a5cf546..43d48d33 100644 --- a/Service/ServiceQualificationItem.schema.json +++ b/Service/ServiceQualificationItem.schema.json @@ -1,89 +1,89 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceQualificationItem.schema.json", - "title": "ServiceQualificationItem", - "definitions": { - "ServiceQualificationItem": { - "$id": "#ServiceQualificationItem", - "description": "A ServiceQualificationItem relates to a specific service being checked in a qualification operation.", - "type": "object", - "properties": { - "expectedActivationDate": { - "type": "string", - "description" : "The date when the service is expected to be activated", - "format": "date-time" - }, - "id": { - "type": "string", - "description" : "Id of the Service Qualification Item" - }, - "qualificationResult": { - "type": "string", - "description" : "Qualification result for serviceQualification item. It could be: - qualified (request service are available), - unqualified (requested not available and not alternate available), - alternate (requested not available but proposal available)" - }, - "state": { - "type": "string", - "description" : "State of the serviceQualification item (acknowledged, inProgress, terminatedWithError, done)" - }, - "service": { - "description" : "Configure the service characteristics (only configurable characteristics and necessary only if a non default value is selected) and/or identify the service that needs to be modified/deleted.", - "$ref": "ServiceRestriction.schema.json#/definitions/ServiceRestriction" - }, - "qualificationRelationship": { - "type": "array", - "description" : "Structure used to describe relationship between serviceQualification item from the same serviceQualification.", - "items": { - "$ref": "ServiceQualificationRelationship.schema.json#ServiceQualificationRelationship" - } - }, - "expectedServiceAvailabilityDate": { - "description": "Date when the requester looks for service availability", - "type": "string", - "format": "date-time" - }, - "expirationDate": { - "description": "Date when the qualification item response expires", - "type": "string", - "format": "date-time" - }, - "eligibilityUnavailabilityReason": { - "type": "array", - "description" : "A list of eligibility unavailability reasons (EligibilityUnavailabilityReason [*]). Reason for eligibility result if the serviceQualification result is no (meaning the service is not available).", - "items": { - "$ref": "ServiceEligibilityUnavailabilityReason.schema.json#ServiceEligibilityUnavailabilityReason" - } - }, - "category": { - "description" : "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.", - "$ref": "ServiceCategoryRef.schema.json#ServiceCategoryRef" - }, - "qualificationItemRelationship": { - "type": "array", - "description" : "A list of qualification item relationships used to describe relationship between serviceQualification item from the same serviceQualification.", - "items": { - "$ref": "ServiceQualificationItemRelationship.schema.json#ServiceQualificationItemRelationship" - } - }, - "terminationError": { - "type": "array", - "description" : "If qualificationItem has not been done properly this lists the error(s) that caused termination of the qualification.", - "items": { - "$ref": "TerminationError.schema.json#TerminationError" - } - }, - "alternateServiceProposal": { - "type": "array", - "description" : "Alternate service proposal is used when the requested service is not available with characteristic and date asked for. An alternate proposal could be a distinct service Spec close to requested one or same as requested but with a different availability date.", - "items": { - "$ref": "AlternateServiceProposal.schema.json#AlternateServiceProposal" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceQualificationItem.schema.json", + "title": "ServiceQualificationItem", + "definitions": { + "ServiceQualificationItem": { + "$id": "#ServiceQualificationItem", + "description": "A ServiceQualificationItem relates to a specific service being checked in a qualification operation.", + "type": "object", + "properties": { + "expectedActivationDate": { + "type": "string", + "description": "The date when the service is expected to be activated", + "format": "date-time" + }, + "id": { + "type": "string", + "description": "Id of the Service Qualification Item" + }, + "qualificationResult": { + "type": "string", + "description": "Qualification result for serviceQualification item. It could be: - qualified (request service are available), - unqualified (requested not available and not alternate available), - alternate (requested not available but proposal available)" + }, + "state": { + "type": "string", + "description": "State of the serviceQualification item (acknowledged, inProgress, terminatedWithError, done)" + }, + "service": { + "description": "Configure the service characteristics (only configurable characteristics and necessary only if a non default value is selected) and/or identify the service that needs to be modified/deleted.", + "$ref": "ServiceRestriction.schema.json#/definitions/ServiceRestriction" + }, + "qualificationRelationship": { + "type": "array", + "description": "Structure used to describe relationship between serviceQualification item from the same serviceQualification.", + "items": { + "$ref": "ServiceQualificationRelationship.schema.json#ServiceQualificationRelationship" + } + }, + "expectedServiceAvailabilityDate": { + "description": "Date when the requester looks for service availability", + "type": "string", + "format": "date-time" + }, + "expirationDate": { + "description": "Date when the qualification item response expires", + "type": "string", + "format": "date-time" + }, + "eligibilityUnavailabilityReason": { + "type": "array", + "description": "A list of eligibility unavailability reasons (EligibilityUnavailabilityReason [*]). Reason for eligibility result if the serviceQualification result is no (meaning the service is not available).", + "items": { + "$ref": "ServiceEligibilityUnavailabilityReason.schema.json#ServiceEligibilityUnavailabilityReason" + } + }, + "category": { + "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.", + "$ref": "ServiceCategoryRef.schema.json#ServiceCategoryRef" + }, + "qualificationItemRelationship": { + "type": "array", + "description": "A list of qualification item relationships used to describe relationship between serviceQualification item from the same serviceQualification.", + "items": { + "$ref": "ServiceQualificationItemRelationship.schema.json#ServiceQualificationItemRelationship" + } + }, + "terminationError": { + "type": "array", + "description": "If qualificationItem has not been done properly this lists the error(s) that caused termination of the qualification.", + "items": { + "$ref": "TerminationError.schema.json#TerminationError" + } + }, + "alternateServiceProposal": { + "type": "array", + "description": "Alternate service proposal is used when the requested service is not available with characteristic and date asked for. An alternate proposal could be a distinct service Spec close to requested one or same as requested but with a different availability date.", + "items": { + "$ref": "AlternateServiceProposal.schema.json#AlternateServiceProposal" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceQualificationItemRelationship.schema.json b/Service/ServiceQualificationItemRelationship.schema.json index 74ea30fd..77ac2cf7 100644 --- a/Service/ServiceQualificationItemRelationship.schema.json +++ b/Service/ServiceQualificationItemRelationship.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceQualificationItemRelationship.schema.json", - "title": "ServiceQualificationItemRelationship", - "definitions": { - "ServiceQualificationItemRelationship": { - "$id": "#ServiceQualificationItemRelationship", - "description": "Structure used to describe relationship between serviceQualification items from the same serviceQualification.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Id of the serviceQualificationItem (from the same serviceQualificationItem)." - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship (ex: reliesOn, connectedTo, etc...)" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceQualificationItemRelationship.schema.json", + "title": "ServiceQualificationItemRelationship", + "definitions": { + "ServiceQualificationItemRelationship": { + "$id": "#ServiceQualificationItemRelationship", + "description": "Structure used to describe relationship between serviceQualification items from the same serviceQualification.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Id of the serviceQualificationItem (from the same serviceQualificationItem)." + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship (ex: reliesOn, connectedTo, etc...)" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceQualificationRelationship.schema.json b/Service/ServiceQualificationRelationship.schema.json index 7604bab3..3f820f46 100644 --- a/Service/ServiceQualificationRelationship.schema.json +++ b/Service/ServiceQualificationRelationship.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceQualificationRelationship.schema.json", - "title": "ServiceQualificationRelationship", - "definitions": { - "ServiceQualificationRelationship": { - "$id": "#ServiceQualificationRelationship", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The id of the target qualification pointed to by this relationship" - }, - "relationshipType": { - "type": "string", - "description": "The type of relationship" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceQualificationRelationship.schema.json", + "title": "ServiceQualificationRelationship", + "definitions": { + "ServiceQualificationRelationship": { + "$id": "#ServiceQualificationRelationship", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The id of the target qualification pointed to by this relationship" + }, + "relationshipType": { + "type": "string", + "description": "The type of relationship" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceRef.schema.json b/Service/ServiceRef.schema.json index 5aa1e58b..9120523c 100644 --- a/Service/ServiceRef.schema.json +++ b/Service/ServiceRef.schema.json @@ -1,19 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceRef.schema.json", - "title": "ServiceRef", - "definitions": { - "ServiceRef": { - "$id": "#ServiceRef", - "description": "Service reference, for when Service is used by other entities", - "type": "object", - "properties": { - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceRef.schema.json", + "title": "ServiceRef", + "definitions": { + "ServiceRef": { + "$id": "#ServiceRef", + "description": "Service reference, for when Service is used by other entities", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceRelationship.schema.json b/Service/ServiceRelationship.schema.json index a91e1ff2..5be86018 100644 --- a/Service/ServiceRelationship.schema.json +++ b/Service/ServiceRelationship.schema.json @@ -1,23 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceRelationship.schema.json", - "title": "ServiceRelationship", - "definitions": { - "ServiceRelationship": { - "$id": "#ServiceRelationship", - "description": "Describes links with services of the same category (useful for bundled services)", - "type": "object", - "required": ["relationshipType", "service"], - "properties": { - "relationshipType": { - "type": "string", - "description": "The type of relationship (e.g. depends on, enables)" - }, - "service": { - "description": "The service being referred to", - "$ref": "ServiceRef.schema.json#ServiceRef" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceRelationship.schema.json", + "title": "ServiceRelationship", + "definitions": { + "ServiceRelationship": { + "$id": "#ServiceRelationship", + "description": "Describes links with services of the same category (useful for bundled services)", + "type": "object", + "required": [ + "relationshipType", + "service" + ], + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of relationship (e.g. depends on, enables)" + }, + "service": { + "description": "The service being referred to", + "$ref": "ServiceRef.schema.json#ServiceRef" } + } } -} + } +} \ No newline at end of file diff --git a/Service/ServiceSpecCharRelationship.schema.json b/Service/ServiceSpecCharRelationship.schema.json index b3f7ced0..81694b4d 100644 --- a/Service/ServiceSpecCharRelationship.schema.json +++ b/Service/ServiceSpecCharRelationship.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceSpecCharRelationship.schema.json", - "title": "ServiceSpecCharRelationship", - "definitions": { - "ServiceSpecCharRelationship": { - "$id": "#ServiceSpecCharRelationship", - "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among serviceSpecCharacteristics.", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" - }, - "role": { - "type": "string", - "description": "The association role for this service specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the target specification" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to the target specification" - }, - "name": { - "type": "string", - "description": "Name of the target characteristic" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the serviceSpecCharRelationship is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceSpecCharRelationship.schema.json", + "title": "ServiceSpecCharRelationship", + "definitions": { + "ServiceSpecCharRelationship": { + "$id": "#ServiceSpecCharRelationship", + "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among serviceSpecCharacteristics.", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" + }, + "role": { + "type": "string", + "description": "The association role for this service specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the target specification" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to the target specification" + }, + "name": { + "type": "string", + "description": "Name of the target characteristic" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the serviceSpecCharRelationship is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceSpecCharacteristic.schema.json b/Service/ServiceSpecCharacteristic.schema.json index 751064d2..04f255ea 100644 --- a/Service/ServiceSpecCharacteristic.schema.json +++ b/Service/ServiceSpecCharacteristic.schema.json @@ -1,77 +1,77 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceSpecCharacteristic.schema.json", - "title": "ServiceSpecCharacteristic", - "definitions": { - "ServiceSpecCharacteristic": { - "$id": "#ServiceSpecCharacteristic", - "description": "This class represents the key features of this service specification. For example, bandwidth is a characteristic of many different types of services; if bandwidth is a relevant characteristic (e.g., from the point-of-view of a Customer obtaining this Service via a Product) then bandwidth would be a ServiceSpecCharacteristic for that particular Service.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications." - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the serviceSpecCharacteristic is" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" - }, - "configurable": { - "type": "boolean", - "description": "If true, the Boolean indicates that the serviceSpecCharacteristic is configurable" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the serviceSpecCharacteristic is valid" - }, - "@valueSchemaLocation": { - "type": "string", - "description": "This (optional) field provides a link to the schema describing the value type." - }, - "minCardinality": { - "type": "integer", - "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality." - }, - "maxCardinality": { - "type": "integer", - "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality." - }, - "isUnique": { - "type": "boolean", - "description": "An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"" - }, - "regex": { - "type": "string", - "description": "A rule or principle represented in regular expression used to derive the value of a characteristic value." - }, - "extensible": { - "type": "boolean", - "description": "An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for an Entity." - }, - "serviceSpecCharacteristicValue": { - "type": "array", - "description" : "A list of service spec characteristic values (ServiceSpecCharacteristicValue [*]). A ServiceSpecCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ServiceSpecCharacteristic object. The values of the attributes in the ServiceSpecCharacteristicValue object describe the values of the attributes that a corresponding ServiceSpecCharacteristic object can take on.", - "items": { - "$ref": "ServiceSpecCharacteristicValue.schema.json#ServiceSpecCharacteristicValue" - } - }, - "serviceSpecCharRelationship": { - "type": "array", - "description" : "A list of service spec char relationships (ServiceSpecCharRelationship [*]). An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.", - "items": { - "$ref": "ServiceSpecCharRelationship.schema.json#ServiceSpecCharRelationship" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceSpecCharacteristic.schema.json", + "title": "ServiceSpecCharacteristic", + "definitions": { + "ServiceSpecCharacteristic": { + "$id": "#ServiceSpecCharacteristic", + "description": "This class represents the key features of this service specification. For example, bandwidth is a characteristic of many different types of services; if bandwidth is a relevant characteristic (e.g., from the point-of-view of a Customer obtaining this Service via a Product) then bandwidth would be a ServiceSpecCharacteristic for that particular Service.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications." + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the serviceSpecCharacteristic is" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" + }, + "configurable": { + "type": "boolean", + "description": "If true, the Boolean indicates that the serviceSpecCharacteristic is configurable" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the serviceSpecCharacteristic is valid" + }, + "@valueSchemaLocation": { + "type": "string", + "description": "This (optional) field provides a link to the schema describing the value type." + }, + "minCardinality": { + "type": "integer", + "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality." + }, + "maxCardinality": { + "type": "integer", + "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality." + }, + "isUnique": { + "type": "boolean", + "description": "An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"" + }, + "regex": { + "type": "string", + "description": "A rule or principle represented in regular expression used to derive the value of a characteristic value." + }, + "extensible": { + "type": "boolean", + "description": "An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for an Entity." + }, + "serviceSpecCharacteristicValue": { + "type": "array", + "description": "A list of service spec characteristic values (ServiceSpecCharacteristicValue [*]). A ServiceSpecCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ServiceSpecCharacteristic object. The values of the attributes in the ServiceSpecCharacteristicValue object describe the values of the attributes that a corresponding ServiceSpecCharacteristic object can take on.", + "items": { + "$ref": "ServiceSpecCharacteristicValue.schema.json#ServiceSpecCharacteristicValue" + } + }, + "serviceSpecCharRelationship": { + "type": "array", + "description": "A list of service spec char relationships (ServiceSpecCharRelationship [*]). An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.", + "items": { + "$ref": "ServiceSpecCharRelationship.schema.json#ServiceSpecCharRelationship" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceSpecCharacteristicValue.schema.json b/Service/ServiceSpecCharacteristicValue.schema.json index b41033c1..f2ec1fd7 100644 --- a/Service/ServiceSpecCharacteristicValue.schema.json +++ b/Service/ServiceSpecCharacteristicValue.schema.json @@ -1,55 +1,55 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceSpecCharacteristicValue.schema.json", - "title": "ServiceSpecCharacteristicValue", - "definitions": { - "ServiceSpecCharacteristicValue": { - "$id": "#ServiceSpecCharacteristicValue", - "description": "A ServiceSpecCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ServiceSpecCharacteristic object. The values of the attributes in the ServiceSpecCharacteristicValue object describe the values of the attributes that a corresponding ServiceSpecCharacteristic object can take on.", - "type": "object", - "properties": { - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" - }, - "isDefault": { - "type": "boolean", - "description": "Indicates if the value is the default value for a characteristic" - }, - "value": { - "$ref": "../Common/Any.schema.json#/definitions/Any", - "description": "A discrete value that the characteristic can take on, or the actual value of the characteristic" - }, - "unitOfMeasure": { - "type": "string", - "description": "A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period of time for which a value is applicable" - }, - "valueFrom": { - "type": "integer", - "description": "The low range value that a characteristic can take on" - }, - "valueTo": { - "type": "integer", - "description": "The upper range value that a characteristic can take on" - }, - "rangeInterval": { - "type": "string", - "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." - }, - "regex": { - "type": "string", - "description": "A regular expression constraint for given value" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceSpecCharacteristicValue.schema.json", + "title": "ServiceSpecCharacteristicValue", + "definitions": { + "ServiceSpecCharacteristicValue": { + "$id": "#ServiceSpecCharacteristicValue", + "description": "A ServiceSpecCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ServiceSpecCharacteristic object. The values of the attributes in the ServiceSpecCharacteristicValue object describe the values of the attributes that a corresponding ServiceSpecCharacteristic object can take on.", + "type": "object", + "properties": { + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" + }, + "isDefault": { + "type": "boolean", + "description": "Indicates if the value is the default value for a characteristic" + }, + "value": { + "$ref": "../Common/Any.schema.json#Any", + "description": "A discrete value that the characteristic can take on, or the actual value of the characteristic" + }, + "unitOfMeasure": { + "type": "string", + "description": "A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period of time for which a value is applicable" + }, + "valueFrom": { + "type": "integer", + "description": "The low range value that a characteristic can take on" + }, + "valueTo": { + "type": "integer", + "description": "The upper range value that a characteristic can take on" + }, + "rangeInterval": { + "type": "string", + "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." + }, + "regex": { + "type": "string", + "description": "A regular expression constraint for given value" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceSpecRelationship.schema.json b/Service/ServiceSpecRelationship.schema.json index e5f08c7c..bc8473c9 100644 --- a/Service/ServiceSpecRelationship.schema.json +++ b/Service/ServiceSpecRelationship.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceSpecRelationship.schema.json", - "title": "ServiceSpecRelationship", - "definitions": { - "ServiceSpecRelationship": { - "$id": "#ServiceSpecRelationship", - "description": "A migration, substitution, dependency or exclusivity relationship between/among service specifications.", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of relationship such as migration, substitution, dependency, exclusivity" - }, - "role": { - "type": "string", - "description": "The association role for this service specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the target serviceSpecification" - }, - "href": { - "type": "string", - "description": "Reference of the target serviceSpecification" - }, - "name": { - "type": "string", - "description": "The name given to the target service specification instance" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the serviceSpecRelationship is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceSpecRelationship.schema.json", + "title": "ServiceSpecRelationship", + "definitions": { + "ServiceSpecRelationship": { + "$id": "#ServiceSpecRelationship", + "description": "A migration, substitution, dependency or exclusivity relationship between/among service specifications.", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of relationship such as migration, substitution, dependency, exclusivity" + }, + "role": { + "type": "string", + "description": "The association role for this service specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the target serviceSpecification" + }, + "href": { + "type": "string", + "description": "Reference of the target serviceSpecification" + }, + "name": { + "type": "string", + "description": "The name given to the target service specification instance" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the serviceSpecRelationship is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceSpecification.schema.json b/Service/ServiceSpecification.schema.json index 8047a8bf..b9dd5529 100644 --- a/Service/ServiceSpecification.schema.json +++ b/Service/ServiceSpecification.schema.json @@ -1,102 +1,102 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceSpecification.schema.json", - "title": "ServiceSpecification", - "definitions": { - "ServiceSpecification": { - "$id": "#ServiceSpecification", - "description": "ServiceSpecification is a class that offers characteristics to describe a type of service.\nFunctionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the service specification" - }, - "href": { - "type": "string", - "description": "Reference of the service specification" - }, - "name": { - "type": "string", - "description": "Name of the service specification" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the service specification is" - }, - "version": { - "type": "string", - "description": "Service specification version" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the service specification is valid" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update of the service specification" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status of the service specification" - }, - "isBundle": { - "type": "boolean", - "description": "isBundle determines whether a ServiceSpecification represents a single ServiceSpecification (false), or a bundle of ServiceSpecification (true)." - }, - "resourceSpecification": { - "type": "array", - "description" : "A list of resource specification references (ResourceSpecificationRef [*]). The ResourceSpecification is required for a service specification with type ResourceFacingServiceSpecification (RFSS).", - "items": { - "$ref": "../Resource/ResourceSpecificationRef.schema.json#ResourceSpecificationRef" - } - }, - "attachment": { - "type": "array", - "description" : "A list of attachments (Attachment [*]). Complements the description of the specification through video, pictures...", - "items": { - "$ref": "../Common/AttachmentRef.schema.json#AttachmentRef" - } - }, - "serviceSpecCharacteristic": { - "type": "array", - "description" : "A list of service spec characteristics (ServiceSpecCharacteristic [*]). This class represents the key features of this service specification.", - "items": { - "$ref": "ServiceSpecCharacteristic.schema.json#ServiceSpecCharacteristic" - } - }, - "relatedParty": { - "type": "array", - "description" : "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity.", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "serviceSpecRelationship": { - "type": "array", - "description": "A list of service specifications related to this specification, e.g. migration, substitution, dependency or exclusivity relationship", - "items": { - "$ref": "ServiceSpecRelationship.schema.json#ServiceSpecRelationship" - } - }, - "serviceLevelSpecification": { - "type": "array", - "description": "A list of service level specifications related to this service specification, and which will need to be satisifiable for corresponding service instances; e.g. Gold, Platinum", - "items": { - "$ref": "ServiceLevelSpecificationRef.schema.json#/definitions/ServiceLevelSpecificationRef" - } - }, - "targetServiceSchema": { - "description": "A target service schema reference (TargetServiceSchemaRef). The reference object to the schema and type of target service which is described by service specification.", - "$ref": "TargetServiceSchema.schema.json#/definitions/TargetServiceSchema" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceSpecification.schema.json", + "title": "ServiceSpecification", + "definitions": { + "ServiceSpecification": { + "$id": "#ServiceSpecification", + "description": "ServiceSpecification is a class that offers characteristics to describe a type of service.\nFunctionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the service specification" + }, + "href": { + "type": "string", + "description": "Reference of the service specification" + }, + "name": { + "type": "string", + "description": "Name of the service specification" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the service specification is" + }, + "version": { + "type": "string", + "description": "Service specification version" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the service specification is valid" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update of the service specification" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status of the service specification" + }, + "isBundle": { + "type": "boolean", + "description": "isBundle determines whether a ServiceSpecification represents a single ServiceSpecification (false), or a bundle of ServiceSpecification (true)." + }, + "resourceSpecification": { + "type": "array", + "description": "A list of resource specification references (ResourceSpecificationRef [*]). The ResourceSpecification is required for a service specification with type ResourceFacingServiceSpecification (RFSS).", + "items": { + "$ref": "../Resource/ResourceSpecificationRef.schema.json#ResourceSpecificationRef" + } + }, + "attachment": { + "type": "array", + "description": "A list of attachments (Attachment [*]). Complements the description of the specification through video, pictures...", + "items": { + "$ref": "../Common/AttachmentRef.schema.json#AttachmentRef" + } + }, + "serviceSpecCharacteristic": { + "type": "array", + "description": "A list of service spec characteristics (ServiceSpecCharacteristic [*]). This class represents the key features of this service specification.", + "items": { + "$ref": "ServiceSpecCharacteristic.schema.json#ServiceSpecCharacteristic" + } + }, + "relatedParty": { + "type": "array", + "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity.", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "serviceSpecRelationship": { + "type": "array", + "description": "A list of service specifications related to this specification, e.g. migration, substitution, dependency or exclusivity relationship", + "items": { + "$ref": "ServiceSpecRelationship.schema.json#ServiceSpecRelationship" + } + }, + "serviceLevelSpecification": { + "type": "array", + "description": "A list of service level specifications related to this service specification, and which will need to be satisifiable for corresponding service instances; e.g. Gold, Platinum", + "items": { + "$ref": "ServiceLevelSpecificationRef.schema.json#ServiceLevelSpecificationRef" + } + }, + "targetServiceSchema": { + "description": "A target service schema reference (TargetServiceSchemaRef). The reference object to the schema and type of target service which is described by service specification.", + "$ref": "TargetServiceSchema.schema.json#TargetServiceSchema" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceSpecificationRef.schema.json b/Service/ServiceSpecificationRef.schema.json index f571dd79..0cba4b88 100644 --- a/Service/ServiceSpecificationRef.schema.json +++ b/Service/ServiceSpecificationRef.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceSpecificationRef.schema.json", - "title": "ServiceSpecificationRef", - "definitions": { - "ServiceSpecificationRef": { - "$id": "#ServiceSpecificationRef", - "description": "Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the service specification" - }, - "href": { - "type": "string", - "description": "Reference of the serviceSpecification" - }, - "name": { - "type": "string", - "description": "Name of the requiredServiceSpecification" - }, - "version": { - "type": "string", - "description": "Service specification version" - }, - "targetServiceSchema": { - "description": "A target service schema reference (TargetServiceSchemaRef). The reference object to the schema and type of target service which is described by service specification.", - "$ref": "TargetServiceSchema.schema.json#/definitions/TargetServiceSchema" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceSpecificationRef.schema.json", + "title": "ServiceSpecificationRef", + "definitions": { + "ServiceSpecificationRef": { + "$id": "#ServiceSpecificationRef", + "description": "Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the service specification" + }, + "href": { + "type": "string", + "description": "Reference of the serviceSpecification" + }, + "name": { + "type": "string", + "description": "Name of the requiredServiceSpecification" + }, + "version": { + "type": "string", + "description": "Service specification version" + }, + "targetServiceSchema": { + "description": "A target service schema reference (TargetServiceSchemaRef). The reference object to the schema and type of target service which is described by service specification.", + "$ref": "TargetServiceSchema.schema.json#TargetServiceSchema" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceStateType.schema.json b/Service/ServiceStateType.schema.json index 6305db20..f67c7b6d 100644 --- a/Service/ServiceStateType.schema.json +++ b/Service/ServiceStateType.schema.json @@ -1,20 +1,20 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceStateType.schema.json", - "title": "ServiceStateType", - "definitions": { - "ServiceStateType": { - "$id": "#ServiceStateType", - "type": "string", - "description": "Valid values for the lifecycle state of the service", - "enum": [ - "feasibilityChecked", - "designed", - "reserved", - "inactive", - "active", - "terminated" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceStateType.schema.json", + "title": "ServiceStateType", + "definitions": { + "ServiceStateType": { + "$id": "#ServiceStateType", + "type": "string", + "description": "Valid values for the lifecycle state of the service", + "enum": [ + "feasibilityChecked", + "designed", + "reserved", + "inactive", + "active", + "terminated" + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceTest.schema.json b/Service/ServiceTest.schema.json index 6cd2a92e..e4a3b548 100644 --- a/Service/ServiceTest.schema.json +++ b/Service/ServiceTest.schema.json @@ -1,75 +1,75 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceTest.schema.json", - "title": "ServiceTest", - "definitions": { - "ServiceTest": { - "$id": "#ServiceTest", - "description": "A service test is an entity that exists for a controlled test invocation on a service. The service \ntest is executed according to a schedule and contains service test configuration parameters that are to be \napplied at execution time, and service test measures that result.", - "type": "object", - "properties": { - "characteristic": { - "type": "array", - "description": "List of characteristics with values that define the test run", - "items": { - "$ref": "../Common/Characteristic.schema.json#/definitions/Characteristic" - } - }, - "description": { - "type": "string", - "description": "Description of the service test" - }, - "endDateTime": { - "type": "string", - "format": "date-time", - "description": "The end date and time of the service test" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the service test" - }, - "id": { - "type": "string", - "description": "The identifier of the service test" - }, - "mode": { - "type": "string", - "description": "An indication of whether the service test is running in \n\"PROACTIVE\" or \"ONDEMAND\" mode" - }, - "name": { - "type": "string", - "description": "The name of the service test" - }, - "relatedService": { - "description": "The actual service being tested", - "$ref": "ServiceRef.schema.json#/definitions/ServiceRef" - }, - "startDateTime": { - "type": "string", - "format": "date-time", - "description": "The start date and time of the service test." - }, - "state": { - "type": "string", - "description": "The actual state the service test is in" - }, - "testMeasure": { - "type": "array", - "description": "The results of the test in terms of the measured metrics", - "items": { - "$ref": "TestMeasure.schema.json#/definitions/TestMeasure" - } - }, - "testSpecification": { - "description": "The specification for this test", - "$ref": "ServiceTestSpecificationRef.schema.json#/definitions/ServiceTestSpecificationRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceTest.schema.json", + "title": "ServiceTest", + "definitions": { + "ServiceTest": { + "$id": "#ServiceTest", + "description": "A service test is an entity that exists for a controlled test invocation on a service. The service \ntest is executed according to a schedule and contains service test configuration parameters that are to be \napplied at execution time, and service test measures that result.", + "type": "object", + "properties": { + "characteristic": { + "type": "array", + "description": "List of characteristics with values that define the test run", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "description": { + "type": "string", + "description": "Description of the service test" + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "The end date and time of the service test" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the service test" + }, + "id": { + "type": "string", + "description": "The identifier of the service test" + }, + "mode": { + "type": "string", + "description": "An indication of whether the service test is running in \n\"PROACTIVE\" or \"ONDEMAND\" mode" + }, + "name": { + "type": "string", + "description": "The name of the service test" + }, + "relatedService": { + "description": "The actual service being tested", + "$ref": "ServiceRef.schema.json#ServiceRef" + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "The start date and time of the service test." + }, + "state": { + "type": "string", + "description": "The actual state the service test is in" + }, + "testMeasure": { + "type": "array", + "description": "The results of the test in terms of the measured metrics", + "items": { + "$ref": "TestMeasure.schema.json#TestMeasure" + } + }, + "testSpecification": { + "description": "The specification for this test", + "$ref": "ServiceTestSpecificationRef.schema.json#ServiceTestSpecificationRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceTestCharacteristic.schema.json b/Service/ServiceTestCharacteristic.schema.json index 465ecada..3387366f 100644 --- a/Service/ServiceTestCharacteristic.schema.json +++ b/Service/ServiceTestCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceTestCharacteristic.schema.json", - "title": "ServiceTestCharacteristic", - "definitions": { - "ServiceTestCharacteristic": { - "$id": "#ServiceTestCharacteristic", - "description": "The configuration of the service test is set by the service test characteristic.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the characteristic." - }, - "value": { - "type": "string", - "description": "The value of characteristic." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceTestCharacteristic.schema.json", + "title": "ServiceTestCharacteristic", + "definitions": { + "ServiceTestCharacteristic": { + "$id": "#ServiceTestCharacteristic", + "description": "The configuration of the service test is set by the service test characteristic.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the characteristic." + }, + "value": { + "type": "string", + "description": "The value of characteristic." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceTestSpecification.schema.json b/Service/ServiceTestSpecification.schema.json index c0e5e34c..6365502d 100644 --- a/Service/ServiceTestSpecification.schema.json +++ b/Service/ServiceTestSpecification.schema.json @@ -1,54 +1,54 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceTestSpecification.schema.json", - "title": "ServiceTestSpecification", - "definitions": { - "ServiceTestSpecification": { - "$id": "#ServiceTestSpecification", - "description": "The service test specification describes the service test in terms of parameters to be configured and \nmeasures to be taken.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of a service test specification." - }, - "href": { - "type": "string", - "description": "Hyperlink to access a service test specification." - }, - "id": { - "type": "string", - "description": "Identifier of a service test specification." - }, - "version": { - "type": "string", - "description": "Version of a service test specification " - }, - "name": { - "type": "string", - "description": "Name of a service test specification." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period of time for which this specification is valid" - }, - "testMeasureDefinition": { - "type": "array", - "description": "A list of definitions for the measurements for the test defined by this specification", - "items": { - "$ref": "TestMeasureDefinition.schema.json#TestMeasureDefinition" - } - }, - "relatedServiceSpecification": { - "$ref": "ServiceSpecificationRef.schema.json#ServiceSpecificationRef", - "description": "The related service specification." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceTestSpecification.schema.json", + "title": "ServiceTestSpecification", + "definitions": { + "ServiceTestSpecification": { + "$id": "#ServiceTestSpecification", + "description": "The service test specification describes the service test in terms of parameters to be configured and \nmeasures to be taken.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of a service test specification." + }, + "href": { + "type": "string", + "description": "Hyperlink to access a service test specification." + }, + "id": { + "type": "string", + "description": "Identifier of a service test specification." + }, + "version": { + "type": "string", + "description": "Version of a service test specification " + }, + "name": { + "type": "string", + "description": "Name of a service test specification." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period of time for which this specification is valid" + }, + "testMeasureDefinition": { + "type": "array", + "description": "A list of definitions for the measurements for the test defined by this specification", + "items": { + "$ref": "TestMeasureDefinition.schema.json#TestMeasureDefinition" + } + }, + "relatedServiceSpecification": { + "$ref": "ServiceSpecificationRef.schema.json#ServiceSpecificationRef", + "description": "The related service specification." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/ServiceTestSpecificationRef.schema.json b/Service/ServiceTestSpecificationRef.schema.json index 01fb4c31..2ad03dae 100644 --- a/Service/ServiceTestSpecificationRef.schema.json +++ b/Service/ServiceTestSpecificationRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceTestSpecificationRef.schema.json", - "title": "ServiceTestSpecificationRef", - "definitions": { - "ServiceTestSpecificationRef": { - "$id": "#ServiceTestSpecificationRef", - "type": "object", - "description": "The service test specification used by the service test.", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "href": { - "type": "string", - "description": "Hyperlink to access a service test specification." - }, - "id": { - "type": "string", - "description": "Identifier of a service test specification." - }, - "version": { - "type": "string", - "description": "Version of a service test specification " - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceTestSpecificationRef.schema.json", + "title": "ServiceTestSpecificationRef", + "definitions": { + "ServiceTestSpecificationRef": { + "$id": "#ServiceTestSpecificationRef", + "type": "object", + "description": "The service test specification used by the service test.", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "href": { + "type": "string", + "description": "Hyperlink to access a service test specification." + }, + "id": { + "type": "string", + "description": "Identifier of a service test specification." + }, + "version": { + "type": "string", + "description": "Version of a service test specification " } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/SupportingService.schema.json b/Service/SupportingService.schema.json index 863ab953..6642e4b9 100644 --- a/Service/SupportingService.schema.json +++ b/Service/SupportingService.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SupportingService.schema.json", - "title": "SupportingService", - "definitions": { - "SupportingService": { - "$id": "#SupportingService", - "description": "A collection of services that support this service (links between CFS -> RFS)", - "type": "object", - "properties": { - "category": { - "type": "string", - "description": "Category of the supporting service" - }, - "href": { - "type": "string", - "description": "Reference of the supporting service" - }, - "id": { - "type": "string", - "description": "Unique identifier of the supporting service" - }, - "name": { - "type": "string", - "description": "Name of the supporting service" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SupportingService.schema.json", + "title": "SupportingService", + "definitions": { + "SupportingService": { + "$id": "#SupportingService", + "description": "A collection of services that support this service (links between CFS -> RFS)", + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Category of the supporting service" + }, + "href": { + "type": "string", + "description": "Reference of the supporting service" + }, + "id": { + "type": "string", + "description": "Unique identifier of the supporting service" + }, + "name": { + "type": "string", + "description": "Name of the supporting service" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/TargetServiceSchema.schema.json b/Service/TargetServiceSchema.schema.json index d8d9f2a1..b89c4851 100644 --- a/Service/TargetServiceSchema.schema.json +++ b/Service/TargetServiceSchema.schema.json @@ -1,23 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TargetServiceSchema.schema.json", - "title": "TargetServiceSchema", - "definitions": { - "TargetServiceSchema": { - "$id": "#TargetServiceSchema", - "type": "object", - "description": "The reference object to the schema and type of target service which is described by service specification", - "properties": { - "@type": { - "type": "string", - "description": "Class type of the target service" - }, - "@schemaLocation": { - "type": "string", - "description": "This field provides a link to the schema describing the target service" - } - }, - "required": ["@type", "@schemaLocation"] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TargetServiceSchema.schema.json", + "title": "TargetServiceSchema", + "definitions": { + "TargetServiceSchema": { + "$id": "#TargetServiceSchema", + "type": "object", + "description": "The reference object to the schema and type of target service which is described by service specification", + "properties": { + "@type": { + "type": "string", + "description": "Class type of the target service" + }, + "@schemaLocation": { + "type": "string", + "description": "This field provides a link to the schema describing the target service" } + }, + "required": [ + "@type", + "@schemaLocation" + ] } -} + } +} \ No newline at end of file diff --git a/Service/TerminationError.schema.json b/Service/TerminationError.schema.json index b720700e..3badf03b 100644 --- a/Service/TerminationError.schema.json +++ b/Service/TerminationError.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TerminationError.schema.json", - "title": "TerminationError", - "definitions": { - "TerminationError": { - "$id": "#TerminationError", - "description": "This indicates an error that caused a qualificationItem to be terminated.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the termination error" - }, - "value": { - "type": "string", - "description": "Text to describe the termination error - for example: Unable to proceed to qualification because incomplete information provided" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TerminationError.schema.json", + "title": "TerminationError", + "definitions": { + "TerminationError": { + "$id": "#TerminationError", + "description": "This indicates an error that caused a qualificationItem to be terminated.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the termination error" + }, + "value": { + "type": "string", + "description": "Text to describe the termination error - for example: Unable to proceed to qualification because incomplete information provided" } + } } -} + } +} \ No newline at end of file diff --git a/Service/TestMeasure.schema.json b/Service/TestMeasure.schema.json index e1079bff..2fa3f4b4 100644 --- a/Service/TestMeasure.schema.json +++ b/Service/TestMeasure.schema.json @@ -1,60 +1,60 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TestMeasure.schema.json", - "title": "TestMeasure", - "definitions": { - "TestMeasure": { - "$id": "#TestMeasure", - "description": "A TestMeasure specifies a measure of a specific aspect of a product, service, or resource test, such as lost packets or connectivity status", - "type": "object", - "properties": { - "accuracy": { - "type": "number", - "format": "float", - "description": "The number of digits of accuracy captured for associated Metrics" - }, - "captureDateTime": { - "type": "string", - "format": "date-time", - "description": "The date and time that the metric was captured" - }, - "captureMethod": { - "type": "string", - "description": "The method used to capture the Metrics (This may be replaced by a set of entities similar to the Performance Monitoring Ref)" - }, - "metricDescription": { - "type": "string", - "description": "Brief description of the metric" - }, - "metricHref": { - "type": "string", - "description": "Hyperlink to access a metric for detail information" - }, - "metricName": { - "type": "string", - "description": "The name of the metric" - }, - "ruleViolation": { - "type": "array", - "description": "A list of rules that were violated in this test measure", - "items": { - "$ref": "MeasureThresholdRuleViolation.schema.json#/definitions/MeasureThresholdRuleViolation" - } - }, - "unitOfMeasure": { - "type": "string", - "description": "The unit of measure for the metric values, such as meters, cubic yards, kilograms [ISO 1000]." - }, - "value": { - "description": "The value of Metric in the test. This also could be a document to record all values captured during the service test", - "$ref": "../Common/Characteristic.schema.json#/definitions/Characteristic" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TestMeasure.schema.json", + "title": "TestMeasure", + "definitions": { + "TestMeasure": { + "$id": "#TestMeasure", + "description": "A TestMeasure specifies a measure of a specific aspect of a product, service, or resource test, such as lost packets or connectivity status", + "type": "object", + "properties": { + "accuracy": { + "type": "number", + "format": "float", + "description": "The number of digits of accuracy captured for associated Metrics" + }, + "captureDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time that the metric was captured" + }, + "captureMethod": { + "type": "string", + "description": "The method used to capture the Metrics (This may be replaced by a set of entities similar to the Performance Monitoring Ref)" + }, + "metricDescription": { + "type": "string", + "description": "Brief description of the metric" + }, + "metricHref": { + "type": "string", + "description": "Hyperlink to access a metric for detail information" + }, + "metricName": { + "type": "string", + "description": "The name of the metric" + }, + "ruleViolation": { + "type": "array", + "description": "A list of rules that were violated in this test measure", + "items": { + "$ref": "MeasureThresholdRuleViolation.schema.json#MeasureThresholdRuleViolation" + } + }, + "unitOfMeasure": { + "type": "string", + "description": "The unit of measure for the metric values, such as meters, cubic yards, kilograms [ISO 1000]." + }, + "value": { + "description": "The value of Metric in the test. This also could be a document to record all values captured during the service test", + "$ref": "../Common/Characteristic.schema.json#Characteristic" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/TestMeasureDefinition.schema.json b/Service/TestMeasureDefinition.schema.json index 275ba651..9efa7396 100644 --- a/Service/TestMeasureDefinition.schema.json +++ b/Service/TestMeasureDefinition.schema.json @@ -1,66 +1,66 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TestMeasureDefinition.schema.json", - "title": "TestMeasureDefinition", - "definitions": { - "TestMeasureDefinition": { - "$id": "#TestMeasureDefinition", - "description": "A TestMeasureDefinition specifies a measure of a specific aspect of a product, service, or resource test, such as lost packets or connectivity status", - "type": "object", - "properties": { - "captureFrequency": { - "type": "string", - "description": "The frequency of capture for the metric. Note: This may be replaced by a set of entities similar to the Performance Monitoring" - }, - "captureMethod": { - "type": "string", - "description": "The method used to capture the Metric. Note: This may be replaced by a set of entities similar to the Performance Monitoring" - }, - "capturePeriod": { - "$ref": "../Common/Duration.schema.json#Duration", - "description": "A period of the capture" - }, - "metricDescription": { - "type": "string", - "description": "Brief description of the metric" - }, - "metricHref": { - "type": "string", - "description": "Hyperlink to access a metric for detail information" - }, - "metricName": { - "type": "string", - "description": "The name of a metric that in the test measure" - }, - "name": { - "type": "string", - "description": "The name of the TestMeasureDefinition" - }, - "unitOfMeasure": { - "type": "string", - "description": "Name of a service test specification" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The time period for which this definition is valid" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the Metric value can take on, such as numeric, text, and so forth" - }, - "thresholdRule": { - "type": "array", - "description": "The rule(s) associated with the measure threshold", - "items": { - "$ref": "MetricDefMeasureThresholdRule.schema.json#MetricDefMeasureThresholdRule" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TestMeasureDefinition.schema.json", + "title": "TestMeasureDefinition", + "definitions": { + "TestMeasureDefinition": { + "$id": "#TestMeasureDefinition", + "description": "A TestMeasureDefinition specifies a measure of a specific aspect of a product, service, or resource test, such as lost packets or connectivity status", + "type": "object", + "properties": { + "captureFrequency": { + "type": "string", + "description": "The frequency of capture for the metric. Note: This may be replaced by a set of entities similar to the Performance Monitoring" + }, + "captureMethod": { + "type": "string", + "description": "The method used to capture the Metric. Note: This may be replaced by a set of entities similar to the Performance Monitoring" + }, + "capturePeriod": { + "$ref": "../Common/Duration.schema.json#Duration", + "description": "A period of the capture" + }, + "metricDescription": { + "type": "string", + "description": "Brief description of the metric" + }, + "metricHref": { + "type": "string", + "description": "Hyperlink to access a metric for detail information" + }, + "metricName": { + "type": "string", + "description": "The name of a metric that in the test measure" + }, + "name": { + "type": "string", + "description": "The name of the TestMeasureDefinition" + }, + "unitOfMeasure": { + "type": "string", + "description": "Name of a service test specification" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The time period for which this definition is valid" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the Metric value can take on, such as numeric, text, and so forth" + }, + "thresholdRule": { + "type": "array", + "description": "The rule(s) associated with the measure threshold", + "items": { + "$ref": "MetricDefMeasureThresholdRule.schema.json#MetricDefMeasureThresholdRule" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file diff --git a/Service/TrackingRecord.schema.json b/Service/TrackingRecord.schema.json index 93f7fe0f..d791636c 100644 --- a/Service/TrackingRecord.schema.json +++ b/Service/TrackingRecord.schema.json @@ -1,47 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TrackingRecord.schema.json", - "title": "TrackingRecord", - "definitions": { - "TrackingRecord": { - "$id": "#TrackingRecord", - "type": "object", - "description": "Tracking records allow the tracking of modifications on the problem. The tracking records should not be embedded in the problem to allow retrieving the problem without the tracking records", - "properties": { - "description": { - "type": "string", - "description": "Describes the action being done, such as: ack, clear" - }, - "extensionInfo": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#/definitions/Characteristic" - }, - "description": "A generic list of any type of elements. Used for vendor Extensions or loose element encapsulation from other namespaces" - }, - "id": { - "type": "string", - "description": "Identifier of the TrackingRecord" - }, - "systemId": { - "type": "string", - "description": "Describes the system Id from which the action was done" - }, - "time": { - "type": "string", - "format": "date-time", - "description": "Describes the time at which the action was done" - }, - "user": { - "type": "string", - "description": "Describes the user doing the action" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TrackingRecord.schema.json", + "title": "TrackingRecord", + "definitions": { + "TrackingRecord": { + "$id": "#TrackingRecord", + "type": "object", + "description": "Tracking records allow the tracking of modifications on the problem. The tracking records should not be embedded in the problem to allow retrieving the problem without the tracking records", + "properties": { + "description": { + "type": "string", + "description": "Describes the action being done, such as: ack, clear" + }, + "extensionInfo": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + }, + "description": "A generic list of any type of elements. Used for vendor Extensions or loose element encapsulation from other namespaces" + }, + "id": { + "type": "string", + "description": "Identifier of the TrackingRecord" + }, + "systemId": { + "type": "string", + "description": "Describes the system Id from which the action was done" + }, + "time": { + "type": "string", + "format": "date-time", + "description": "Describes the time at which the action was done" + }, + "user": { + "type": "string", + "description": "Describes the user doing the action" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} + } +} \ No newline at end of file From 7756bbaadc832166a09e1620f8c276071b43e1aa Mon Sep 17 00:00:00 2001 From: Schema validation Bot Date: Mon, 15 Jul 2019 13:39:08 +0000 Subject: [PATCH 05/11] Validation result with ERRORS [skip ci] --- .../validation-20190715T133908Z.txt | 1065 +++++++++++++++++ 1 file changed, 1065 insertions(+) create mode 100644 .circleci/validation_results/validation-20190715T133908Z.txt diff --git a/.circleci/validation_results/validation-20190715T133908Z.txt b/.circleci/validation_results/validation-20190715T133908Z.txt new file mode 100644 index 00000000..fa9baaa6 --- /dev/null +++ b/.circleci/validation_results/validation-20190715T133908Z.txt @@ -0,0 +1,1065 @@ +SCHEMA VALIDATION +================= +# schemas : 489 files processed +# errors : 15 +# validate ok : 474 +# issues : 213 files / 574 issues + +total time: 5.48 seconds + + +ERROR - schemas with error(s): +... Common/Entity.schema.json +... ... discriminator (@type) defined but not included in 'required' property + +... Common/RelatedGeographicAddressRefOrValue.schema.json +... ... discriminator (isRef) defined but not included in 'required' property + +... Common/RelatedGeographicLocationRefOrValue.schema.json +... ... discriminator (isRef) defined but not included in 'required' property + +... Common/RelatedPlaceRefOrValue.schema.json +... ... discriminator (isRef) defined but no isRef property defined +... ... discriminator (isRef) defined but not included in 'required' property + +... Customer/BalanceTopupStatus.schema.json +... ... BalanceTopupStatus requires property "type" +... ... BalanceTopupStatus requires property "$id" + +... Customer/ProductOfferingQualificationItemRef.schema.json +... ... ProductOfferingQualificationItemRef requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/EntityRef.schema.json' + +... EngagedParty/PartyRole.schema.json +... ... required additionalProperty "0" exists in instance when not allowed +... ... required additionalProperty "1" exists in instance when not allowed + +... EngagedParty/RelatedPartyRefOrValue.schema.json +... ... isRef property defined, but not included in required +... ... discriminator (isRef) defined but not included in 'required' property + +... MarketingSales/SalesLead.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'MarketingSales/SalesLeadStateType.schema.json' + +... Product/BaseProductRefOrValue.schema.json +... ... isRef property defined, but not included in required + +... Product/CancelProductOrder.schema.json +... ... de-reference check: Token "#CancelOrderRef" does not exist. + +... Product/LoyaltyExecutionPoint.schema.json +... ... LoyaltyAccount additionalProperty "title" exists in instance when not allowed +... ... schema mismatch with title (LoyaltyExecutionPoint) and definitions (LoyaltyAccount) + +... Service/AlternateServiceProposal.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/ServiceRestriction.schema.json' + +... Service/ServiceQualification.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/ServiceRestriction.schema.json' + +... Service/ServiceQualificationItem.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/ServiceRestriction.schema.json' + + +ISSUES - schemas with issue(s): +... Common/AlternateGeographicAddress.schema.json +... ... geographicLocation :: no description value +... ... geographicSubAddress :: no description value + +... Common/AssociationRoleSpec.schema.json +... ... aggregation :: no description value +... ... defaultQuantity :: no description value +... ... entityType :: no description value +... ... isNavigable :: no description value +... ... isSource :: no description value +... ... maxQuantity :: no description value +... ... minQuantity :: no description value +... ... role :: no description value + +... Common/AssociationSpecification.schema.json +... ... constraint :: no description value +... ... associationRoleSpec :: no description value + +... Common/BusinessInteraction.schema.json +... ... interactionData :: no description value +... ... interactionDataComplete :: no description value +... ... interactionDataStatus :: no description value + +... Common/CalendarEventRef.schema.json +... ... CalendarEventRef :: no properties defined + +... Common/CalendarPeriod.schema.json +... ... timeZone :: recommend to add format +... ... hourPeriod :: no description value + +... Common/ChangeRequest.schema.json +... ... workLog :: no description value +... ... incident :: no description value +... ... changeRequestSpecification :: no description value +... ... impactEntity :: no description value +... ... changeRequestCharacteristic :: no description value +... ... targetEntity :: no description value +... ... resolution :: no description value +... ... sla :: no description value +... ... relateChangeRequest :: no description value +... ... category :: no description value +... ... note :: no description value + +... Common/ChangeRequestSpecification.schema.json +... ... validFor :: no description value + +... Common/Channel.schema.json +... ... Channel :: should be renamed as ChannelRef if this is a reference entity + +... Common/CommonComponents.schema.json +... ... Failing to check for issues: TypeError: Cannot read property 'properties' of undefined + +... Common/CommunicationMessage.schema.json +... ... logFlag :: no description value +... ... tryTimes :: recommend to add format + +... Common/Document.schema.json +... ... binaryAttachment :: no description value +... ... category :: no description value +... ... documentRelationship :: no description value +... ... relatedObject :: no description value + +... Common/DocumentCharacteristic.schema.json +... ... value :: no description value + +... Common/DocumentRelationship.schema.json +... ... documentRef :: no description value + +... Common/EntitySpecRelationship.schema.json +... ... associationSpec :: no description value + +... Common/EntitySpecification.schema.json +... ... attachment :: no description value +... ... entitySchema :: no description value +... ... specCharacteristic :: no description value +... ... relatedParty :: no description value + +... Common/ExternalReference.schema.json +... ... ExternalReference :: should be renamed as ExternalReferenceRef if this is a reference entity + +... Common/GeographicAddress.schema.json +... ... geographicLocation :: no description value +... ... geographicSubAddress :: no description value + +... Common/GeographicAddressValidation.schema.json +... ... validAddress :: no description value +... ... alternateGeographicAddress :: no description value + +... Common/GeographicLocation.schema.json +... ... accuracy :: no description value +... ... spatialRef :: no description value +... ... geometry :: no description value + +... Common/GeographicLocationRef.schema.json +... ... GeographicLocationRef :: no properties defined + +... Common/GeographicSite.schema.json +... ... relatedParty :: no description value +... ... calendar :: no description value +... ... geographicLocation :: no description value +... ... address :: no description value +... ... siteRelationship :: no description value + +... Common/Incident.schema.json +... ... Incident :: should be renamed as IncidentRef if this is a reference entity + +... Common/LocationCharacteristic.schema.json +... ... value :: no description value + +... Common/NetworkFunction.schema.json +... ... NetworkFunction :: should be renamed as NetworkFunctionRef if this is a reference entity + +... Common/Object.schema.json +... ... uri :: no description value + +... Common/Place.schema.json +... ... Place :: should be renamed as PlaceRef if this is a reference entity + +... Common/PlaceRef.schema.json +... ... PlaceRef :: no properties defined + +... Common/Receiver.schema.json +... ... party :: no description value + +... Common/Resolution.schema.json +... ... task :: no description value + +... Common/RetrieveGeographicLocation.schema.json +... ... requestedAccuracy :: no description value +... ... status :: no description value +... ... time :: no description value +... ... geographicLocation :: no description value +... ... thing :: no description value + +... Common/RetrieveLocationRelation.schema.json +... ... distance :: no description value +... ... status :: no description value +... ... time :: no description value +... ... intersection :: no description value +... ... location :: no description value + +... Common/Sender.schema.json +... ... party :: no description value + +... Common/SpecCharacteristic.schema.json +... ... specCharacteristicValue :: no description value +... ... specCharRelationship :: no description value + +... Common/Street.schema.json +... ... characteristic :: no description value +... ... address :: no description value + +... Common/StreetSegment.schema.json +... ... address :: no description value + +... Common/TicketRelationship.schema.json +... ... product :: no description value + +... Common/TroubleTicketRef.schema.json +... ... TroubleTicketRef :: no properties defined + +... Common/TroubleTicketRelationship.schema.json +... ... troubleTicket :: no description value + +... Common/Value.schema.json +... ... Value :: no properties defined + +... Common/WorkLog.schema.json +... ... lastUpdateDateTime :: recommend to add format +... ... lastUpdateDateTime :: recommend to add format +... ... record :: no description value + +... Customer/AppliedBillingRate.schema.json +... ... appliedTax :: no description value +... ... bill :: no description value +... ... characteristic :: no description value + +... Customer/AppliedCustomerBillingRate.schema.json +... ... appliedTax :: no description value +... ... bill :: no description value +... ... characteristic :: no description value + +... Customer/AppliedPartyBillingRate.schema.json +... ... appliedTax :: no description value +... ... bill :: no description value +... ... characteristic :: no description value + +... Customer/Appointment.schema.json +... ... attachment :: no description value +... ... contactMedium :: no description value +... ... note :: no description value +... ... relatedEntity :: no description value +... ... relatedParty :: no description value +... ... status :: no description value +... ... validFor :: no description value + +... Customer/Authorization.schema.json +... ... approver :: no description value + +... Customer/BalanceActivity.schema.json +... ... date :: recommend to add format +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceAdjustmentBody.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceAdjustmentRequest.schema.json +... ... requestedDate :: recommend to add format + +... Customer/BalanceDeduct.schema.json +... ... relatedParty :: no description value +... ... product :: no description value +... ... balanceReserve :: no description value +... ... requestor :: no description value +... ... partyAccount :: no description value + +... Customer/BalanceDeductRollback.schema.json +... ... relatedParty :: no description value +... ... product :: no description value +... ... partyAccount :: no description value +... ... balanceDeduct :: no description value +... ... requestor :: no description value + +... Customer/BalanceReserve.schema.json +... ... requestor :: no description value +... ... product :: no description value +... ... relatedParty :: no description value +... ... partyAccount :: no description value + +... Customer/BalanceTopupBody.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceTopupRequest.schema.json +... ... confirmationDate :: recommend to add format +... ... requestedDate :: recommend to add format + +... Customer/BalanceTopupStatusTypeModify.schema.json +... ... BalanceTopupStatusTypeModify :: should be renamed as BalanceTopupStatusTypeModifyRef if this is a reference entity + +... Customer/BalanceTransferBody.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceTransferRequest.schema.json +... ... confirmationDate :: recommend to add format +... ... requestedDate :: recommend to add format + +... Customer/BalanceTransferStatusTypeModify.schema.json +... ... BalanceTransferStatusTypeModify :: should be renamed as BalanceTransferStatusTypeModifyRef if this is a reference entity +... ... status :: no description value + +... Customer/BalanceUnreserve.schema.json +... ... balanceReserve :: no description value +... ... relatedParty :: no description value +... ... requestor :: no description value +... ... product :: no description value + +... Customer/BankCardMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/Bill.schema.json +... ... billingAccount :: no description value +... ... taxItem :: no description value +... ... paymentMethod :: no description value +... ... relatedParty :: no description value +... ... financialAccount :: no description value + +... Customer/BillFormat.schema.json +... ... BillFormat :: should be renamed as BillFormatRef if this is a reference entity + +... Customer/BillFormatRefOrValue.schema.json +... ... isRef :: no description value + +... Customer/BillPresentationMedia.schema.json +... ... BillPresentationMedia :: should be renamed as BillPresentationMediaRef if this is a reference entity + +... Customer/BillPresentationMediaRefOrValue.schema.json +... ... isRef :: no description value + +... Customer/BillStructure.schema.json +... ... presentationMedia :: no description value +... ... format :: no description value +... ... cycleSpecification :: no description value + +... Customer/BillingAccount.schema.json +... ... BillingAccount :: no properties defined + +... Customer/BillingCycleSpecification.schema.json +... ... billingDateShift :: recommend to add format +... ... chargeDateOffset :: recommend to add format +... ... creditDateOffset :: recommend to add format +... ... mailingDateOffset :: recommend to add format +... ... paymentDueDateOffset :: recommend to add format + +... Customer/BillingCycleSpecificationRef.schema.json +... ... dateShift :: recommend to add format + +... Customer/BillingCycleSpecificationRefOrValue.schema.json +... ... isRef :: no description value + +... Customer/CartItem.schema.json +... ... itemTerm :: no description value +... ... cartItem :: no description value +... ... note :: no description value +... ... ItemTotalPrice :: no description value +... ... product :: no description value +... ... itemPrice :: no description value +... ... productOffering :: no description value +... ... cartItemRelationship :: no description value + +... Customer/CartItemRelationship.schema.json +... ... cartItem :: no description value + +... Customer/CartPrice.schema.json +... ... price :: no description value +... ... priceAlteration :: no description value + +... Customer/CartTerm.schema.json +... ... description :: no description value +... ... duration :: no description value + +... Customer/CashDetails.schema.json +... ... CashDetails :: no properties defined + +... Customer/CashMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/CheckMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/Customer.schema.json +... ... engagedParty :: no description value +... ... roleType :: no description value +... ... account :: no description value +... ... paymentMethod :: no description value +... ... contactMedium :: no description value +... ... creditProfile :: no description value +... ... agreement :: no description value +... ... relatedParty :: no description value + +... Customer/CustomerBill.schema.json +... ... billingAccount :: no description value +... ... taxItem :: no description value +... ... paymentMethod :: no description value +... ... relatedParty :: no description value +... ... financialAccount :: no description value + +... Customer/DigitalWalletMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/Disability.schema.json +... ... validFor :: no description value + +... Customer/OrderItem.schema.json +... ... appointment :: no description value +... ... billingAccount :: no description value +... ... itemPrice :: no description value +... ... orderItem :: no description value +... ... orderItemRelationship :: no description value +... ... itemTotalPrice :: no description value +... ... payment :: no description value +... ... productOffering :: no description value +... ... product :: no description value +... ... qualification :: no description value +... ... itemTerm :: no description value + +... Customer/OrderItemPrice.schema.json +... ... productOfferingPrice :: no description value +... ... billingAccount :: no description value +... ... price :: no description value +... ... priceAlteration :: no description value + +... Customer/OrderItemRelationship.schema.json +... ... OrderItemRelationship :: should be renamed as OrderItemRelationshipRef if this is a reference entity + +... Customer/OrderRelationship.schema.json +... ... OrderRelationship :: should be renamed as OrderRelationshipRef if this is a reference entity + +... Customer/PaymentItem.schema.json +... ... payment :: no description value + +... Customer/PaymentMethod.schema.json +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/PaymentMethodRefOrValue.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/PaymentPlan.schema.json +... ... paymentMethod :: no description value + +... Customer/ProductOrder.schema.json +... ... billingAccount :: no description value +... ... channel :: no description value +... ... note :: no description value +... ... orderTotalPrice :: no description value +... ... payment :: no description value +... ... productOfferingQualification :: no description value +... ... quote :: no description value +... ... productOrderItem :: no description value +... ... relatedParty :: no description value + +... Customer/ProductOrderItem.schema.json +... ... appointment :: no description value +... ... billingAccount :: no description value +... ... itemPrice :: no description value +... ... itemTerm :: no description value +... ... itemTotalPrice :: no description value +... ... payment :: no description value +... ... product :: no description value +... ... productOffering :: no description value +... ... productOfferingQualificationItem :: no description value +... ... quoteItem :: no description value +... ... productOrderItem :: no description value +... ... productOrderItemRelationship :: no description value +... ... qualification :: no description value + +... Customer/ProductOrderRef.schema.json +... ... ProductOrderRef :: no properties defined + +... Customer/QuoteItem.schema.json +... ... product :: no description value +... ... productOffering :: no description value + +... Customer/QuoteItemRelationship.schema.json +... ... QuoteItemRelationship :: should be renamed as QuoteItemRelationshipRef if this is a reference entity + +... Customer/QuotePrice.schema.json +... ... priceAlteration :: no description value +... ... price :: no description value + +... Customer/QuoteRef.schema.json +... ... QuoteRef :: no properties defined + +... Customer/SearchTimeSlot.schema.json +... ... requestedTimeSlot :: no description value +... ... requestedTimeSlot :: recommend to add format +... ... availableTimeSlot :: no description value +... ... availableTimeSlot :: recommend to add format +... ... relatedEntity :: no description value + +... Customer/SettlementNoteAdvice.schema.json +... ... settlementMethod :: no description value +... ... settlementNoteImage :: no description value +... ... receiver :: no description value +... ... taxItem :: no description value +... ... issuer :: no description value +... ... settlementNoteItem :: no description value + +... Customer/SettlementNoteImage.schema.json +... ... imageFileURL :: recommend to add format + +... Customer/SettlementNoteItem.schema.json +... ... period :: no description value +... ... taxItem :: no description value + +... Customer/ShoppingCart.schema.json +... ... contactMedium :: no description value +... ... cartItem :: no description value +... ... relatedParty :: no description value + +... Customer/TokenizedCardMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/VoucherMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/Account.schema.json +... ... relatedParty :: no description value +... ... taxExemption :: no description value +... ... contact :: no description value +... ... accountBalance :: no description value +... ... accountRelationship :: no description value + +... EngagedParty/AccountDirectDetails.schema.json +... ... AccountDirectDetails :: should be renamed as AccountDirectDetailsRef if this is a reference entity +... ... account :: no description value + +... EngagedParty/AccountDirectMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/AccountRelationship.schema.json +... ... account :: no description value + +... EngagedParty/AccountTaxExemption.schema.json +... ... issuingJurisdiction :: recommend to add format + +... EngagedParty/Agreement.schema.json +... ... completionDate :: recommend to add format +... ... agreementSpecification :: no description value +... ... agreementItem :: no description value +... ... engagedPartyRole :: no description value +... ... agreementAuthorization :: no description value +... ... characteristic :: no description value +... ... associatedAgreement :: no description value + +... EngagedParty/AgreementItem.schema.json +... ... productOffering :: no description value +... ... termOrCondition :: no description value + +... EngagedParty/AgreementSpecCharacteristic.schema.json +... ... specCharacteristicValue :: no description value + +... EngagedParty/AgreementSpecification.schema.json +... ... serviceCategory :: no description value +... ... specificationCharacteristic :: no description value +... ... relatedParty :: no description value +... ... attachment :: no description value +... ... specificationRelationship :: no description value + +... EngagedParty/BankAccountDebitMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/BankAccountTransferMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/Contact.schema.json +... ... contactMedium :: no description value +... ... relatedParty :: no description value + +... EngagedParty/FinancialAccount.schema.json +... ... FinancialAccount :: no properties defined + +... EngagedParty/FinancialAccountRef.schema.json +... ... accountBalance :: no description value + +... EngagedParty/Individual.schema.json +... ... otherName :: no description value +... ... individualIdentification :: no description value +... ... disability :: no description value +... ... languageAbility :: no description value +... ... skill :: no description value + +... EngagedParty/IndividualIdentification.schema.json +... ... attachment :: no description value + +... EngagedParty/LanguageAbility.schema.json +... ... isFavouriteLanguage :: recommend to add format +... ... validFor :: no description value + +... EngagedParty/Organization.schema.json +... ... existsDuring :: no description value +... ... existsDuring :: recommend to add format +... ... otherName :: no description value +... ... organizationIdentification :: no description value +... ... organizationChildRelationship :: no description value +... ... organizationParentRelationship :: no description value + +... EngagedParty/OrganizationChildRelationship.schema.json +... ... organization :: no description value + +... EngagedParty/OrganizationIdentification.schema.json +... ... attachment :: no description value + +... EngagedParty/OrganizationParentRelationship.schema.json +... ... organization :: no description value + +... EngagedParty/OrganizationRef.schema.json +... ... OrganizationRef :: no properties defined + +... EngagedParty/OtherNameIndividual.schema.json +... ... validFor :: no description value + +... EngagedParty/OtherNameOrganization.schema.json +... ... validFor :: no description value + +... EngagedParty/PartnershipType.schema.json +... ... roleType :: no description value + +... EngagedParty/Party.schema.json +... ... externalReference :: no description value +... ... partyCharacteristic :: no description value +... ... taxExemptionCertificate :: no description value +... ... creditRating :: no description value +... ... relatedParty :: no description value +... ... contactMedium :: no description value + +... EngagedParty/PartyAccount.schema.json +... ... billStructure :: no description value +... ... paymentPlan :: no description value +... ... financialAccount :: no description value +... ... defaultPaymentMethod :: no description value + +... EngagedParty/PartyBill.schema.json +... ... billingAccount :: no description value +... ... taxItem :: no description value +... ... paymentMethod :: no description value +... ... relatedParty :: no description value +... ... financialAccount :: no description value + +... EngagedParty/PartyCreditProfile.schema.json +... ... validFor :: no description value + +... EngagedParty/PartyRef.schema.json +... ... PartyRef :: no properties defined + +... EngagedParty/RoleType.schema.json +... ... agreementSpecification :: no description value + +... EngagedParty/Rule.schema.json +... ... consequence :: no description value +... ... metric :: no description value +... ... operator :: no description value +... ... referenceValue :: no description value +... ... tolerance :: no description value +... ... unit :: no description value + +... EngagedParty/RuleRef.schema.json +... ... description :: no description value + +... EngagedParty/SLA.schema.json +... ... approvalDate :: no description value +... ... approved :: no description value +... ... rule :: no description value +... ... relatedParty :: no description value +... ... template :: no description value + +... EngagedParty/SLAViolation.schema.json +... ... date :: no description value +... ... relatedParty :: no description value +... ... violation :: no description value +... ... sla :: no description value + +... EngagedParty/SettlementAccount.schema.json +... ... SettlementAccount :: no properties defined + +... EngagedParty/Skill.schema.json +... ... validFor :: no description value + +... EngagedParty/TaxExemptionCertificate.schema.json +... ... taxDefinition :: no description value +... ... validFor :: no description value +... ... attachment :: no description value + +... EngagedParty/TemplateRef.schema.json +... ... description :: no description value + +... EngagedParty/Violation.schema.json +... ... actualValue :: no description value +... ... comment :: no description value +... ... consequence :: no description value +... ... operator :: no description value +... ... referenceValue :: no description value +... ... tolerance :: no description value +... ... unit :: no description value +... ... violationAverage :: no description value +... ... attachment :: no description value +... ... rule :: no description value + +... MarketingSales/MarketingCampaignRef.schema.json +... ... MarketingCampaignRef :: no properties defined + +... MarketingSales/SalesOpportunityRef.schema.json +... ... SalesOpportunityRef :: no properties defined + +... Product/BundledProductOfferingPriceRelationship.schema.json +... ... BundledProductOfferingPriceRelationship :: should be renamed as BundledProductOfferingPriceRelationshipRef if this is a reference entity + +... Product/BundledProductSpecification.schema.json +... ... BundledProductSpecification :: should be renamed as BundledProductSpecificationRef if this is a reference entity + +... Product/LoyaltyAccount.schema.json +... ... LoyaltyAccount :: should be renamed as LoyaltyAccountRef if this is a reference entity +... ... loyaltyProgramProduct :: no description value + +... Product/LoyaltyAction.schema.json +... ... type :: rename to avoid conflict with @type + +... Product/LoyaltyEvent.schema.json +... ... eventId :: no description value +... ... eventTime :: recommend to add format + +... Product/LoyaltyEventType.schema.json +... ... LoyaltyEventType :: should be renamed as LoyaltyEventTypeRef if this is a reference entity + +... Product/LoyaltyProgramProduct.schema.json +... ... loyaltyProgramProductSpec :: no description value +... ... loyaltyAccount :: no description value +... ... validFor :: no description value + +... Product/LoyaltyProgramProductSpec.schema.json +... ... productNumber :: no description value +... ... ValidFor :: no description value + +... Product/LoyaltyRuleAction.schema.json +... ... LoyaltyRuleAction :: should be renamed as LoyaltyRuleActionRef if this is a reference entity + +... Product/LoyaltyRuleCondition.schema.json +... ... LoyaltyRuleCondition :: should be renamed as LoyaltyRuleConditionRef if this is a reference entity + +... Product/LoyaltyRuleEventType.schema.json +... ... LoyaltyRuleEventType :: should be renamed as LoyaltyRuleEventTypeRef if this is a reference entity + +... Product/PriceAlteration.schema.json +... ... productOfferingPrice :: no description value +... ... price :: no description value + +... Product/Product.schema.json +... ... agreement :: no description value +... ... billingAccount :: no description value +... ... productCharacteristic :: no description value +... ... productOffering :: no description value +... ... productOrderItem :: no description value +... ... product :: no description value +... ... productPrice :: no description value +... ... productRelationship :: no description value +... ... productSpecification :: no description value +... ... productTerm :: no description value +... ... realizingResource :: no description value +... ... realizingService :: no description value +... ... relatedParty :: no description value +... ... place :: no description value + +... Product/ProductInventoryRelationship.schema.json +... ... product :: no description value + +... Product/ProductOffering.schema.json +... ... serviceCandidate :: recommend to add format +... ... resourceCandidate :: recommend to add format + +... Product/ProductOfferingPriceRef.schema.json +... ... ProductOfferingPriceRef :: no properties defined + +... Product/ProductOfferingPriceRelationship.schema.json +... ... ProductOfferingPriceRelationship :: should be renamed as ProductOfferingPriceRelationshipRef if this is a reference entity + +... Product/ProductOfferingQualificationItem.schema.json +... ... eligibilityUnavailabilityReason :: no description value +... ... category :: no description value +... ... qualificationItemRelationship :: no description value +... ... note :: no description value +... ... product :: no description value +... ... terminationError :: no description value +... ... productOffering :: no description value +... ... alternateProductOfferingProposal :: no description value + +... Product/ProductOfferingQualificationRef.schema.json +... ... ProductOfferingQualificationRef :: no properties defined + +... Product/ProductOfferingRef.schema.json +... ... ProductOfferingRef :: no properties defined + +... Product/ProductPrice.schema.json +... ... productOfferingPrice :: no description value +... ... billingAccount :: no description value +... ... productPriceAlteration :: no description value +... ... price :: no description value + +... Product/ProductRef.schema.json +... ... ProductRef :: no properties defined + +... Product/ProductRefOrValue.schema.json +... ... ProductRefOrValue :: no properties defined + +... Product/ProductRelationship.schema.json +... ... product :: no description value + +... Product/ProductRequest.schema.json +... ... referredProduct :: no description value +... ... realizingService :: no description value +... ... billingAccount :: no description value +... ... productOffering :: no description value +... ... agreement :: no description value +... ... characteristic :: no description value +... ... productRelationship :: no description value +... ... realizingResource :: no description value +... ... relatedParty :: no description value +... ... productPrice :: no description value +... ... productSpecification :: no description value +... ... place :: no description value + +... Product/ProductRestriction.schema.json +... ... productCharacteristic :: no description value +... ... productRelationship :: no description value +... ... relatedParty :: no description value +... ... productSpecification :: no description value +... ... relatedPlace :: no description value + +... Product/ProductSpecCharacteristic.schema.json +... ... productSpecCharRelationship :: no description value +... ... productSpecCharacteristicValue :: no description value + +... Product/Promotion.schema.json +... ... pattern :: no description value + +... Product/PromotionCriteriaGroup.schema.json +... ... criteria :: no description value + +... Product/PromotionPattern.schema.json +... ... action :: no description value +... ... criteriaGroup :: no description value + +... Product/QualificationItemRelationship.schema.json +... ... QualificationItemRelationship :: should be renamed as QualificationItemRelationshipRef if this is a reference entity + +... Product/Recommendation.schema.json +... ... description :: no description value +... ... order :: no description value +... ... channel :: no description value +... ... party :: no description value +... ... item :: no description value + +... Product/Usage.schema.json +... ... usageSpecification :: no description value +... ... usageCharacteristic :: no description value +... ... relatedParty :: no description value +... ... ratedProductUsage :: no description value + +... Product/UsageConsumptionReport.schema.json +... ... relatedParty :: no description value + +... Product/UsageSpecCharacteristic.schema.json +... ... usageSpecCharacteristicValue :: no description value + +... Product/UsageSpecification.schema.json +... ... usageSpecCharacteristic :: no description value + +... Product/UsageVolumeProduct.schema.json +... ... bucketBalance :: no description value +... ... bucketCounter :: no description value +... ... product :: no description value + +... Resource/LogicalResource.schema.json +... ... resourceRelationship :: no description value +... ... characteristic :: no description value +... ... place :: no description value +... ... partyRole :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/PhysicalResource.schema.json +... ... resourceRelationship :: no description value +... ... characteristic :: no description value +... ... place :: no description value +... ... partyRole :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/RealizingResourceRef.schema.json +... ... RealizingResourceRef :: no properties defined + +... Resource/Resource.schema.json +... ... resourceRelationship :: no description value +... ... characteristic :: no description value +... ... place :: no description value +... ... partyRole :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/ResourceAlarmRef.schema.json +... ... changeRequest :: no description value + +... Resource/ResourceOrder.schema.json +... ... orderRelationship :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/ResourceOrderItem.schema.json +... ... resourceSpecification :: no description value +... ... orderItemRelationship :: no description value + +... Resource/ResourceOrderItemRelationship.schema.json +... ... orderItem :: no description value + +... Resource/ResourceOrderRelationship.schema.json +... ... resourceOrder :: no description value +... ... serviceOrder :: no description value + +... Resource/SupportingResource.schema.json +... ... SupportingResource :: should be renamed as SupportingResourceRef if this is a reference entity + +... Service/FirstAlert.schema.json +... ... FirstAlert :: should be renamed as FirstAlertRef if this is a reference entity + +... Service/Service.schema.json +... ... serviceDate :: recommend to add format + +... Service/ServiceCategory.schema.json +... ... serviceCandidate :: recommend to add format + +... Service/ServiceLevelObjective.schema.json +... ... graceTimes :: recommend to add format + +... Service/ServiceOrder.schema.json +... ... orderDate :: no description value + +... Service/ServiceOrderItemRelationship.schema.json +... ... ServiceOrderItemRelationship :: should be renamed as ServiceOrderItemRelationshipRef if this is a reference entity + +... Service/ServiceQualificationItemRelationship.schema.json +... ... ServiceQualificationItemRelationship :: should be renamed as ServiceQualificationItemRelationshipRef if this is a reference entity + +... Service/ServiceQualificationRelationship.schema.json +... ... ServiceQualificationRelationship :: should be renamed as ServiceQualificationRelationshipRef if this is a reference entity + +... Service/ServiceRef.schema.json +... ... ServiceRef :: no properties defined + +... Service/SupportingService.schema.json +... ... SupportingService :: should be renamed as SupportingServiceRef if this is a reference entity + +... Common/RelatedGeographicAddressRefOrValue.schema.json +... ... isRef :: no description value +... ... role :: no description value + +... Common/RelatedGeographicLocationRefOrValue.schema.json +... ... isRef :: no description value +... ... role :: no description value + +... Common/RelatedPlaceRefOrValue.schema.json +... ... role :: no description value + +... Customer/BalanceTopupStatus.schema.json +... ... BalanceTopupStatus :: should be renamed as BalanceTopupStatusRef if this is a reference entity +... ... statusChangeDate :: recommend to add format + +... EngagedParty/PartyRole.schema.json +... ... engagedParty :: no description value +... ... roleType :: no description value +... ... account :: no description value +... ... paymentMethod :: no description value +... ... contactMedium :: no description value +... ... creditProfile :: no description value +... ... agreement :: no description value +... ... relatedParty :: no description value + +... EngagedParty/RelatedPartyRefOrValue.schema.json +... ... isRef :: no description value +... ... role :: no description value + +... MarketingSales/SalesLead.schema.json +... ... status :: no description value +... ... type :: rename to avoid conflict with @type +... ... priority :: no description value +... ... channel :: no description value +... ... productOffering :: no description value +... ... relatedParty :: no description value +... ... prospectContact :: no description value +... ... productSpecification :: no description value +... ... category :: no description value +... ... salesOpportunity :: no description value +... ... product :: no description value +... ... note :: no description value + +... Product/BaseProductRefOrValue.schema.json +... ... productCharacteristic :: no description value +... ... realizingResource :: no description value +... ... realizingService :: no description value +... ... productRelationship :: no description value +... ... relatedParty :: no description value +... ... productSpecification :: no description value +... ... relatedPlace :: no description value + +... Product/CancelProductOrder.schema.json +... ... CancelProductOrder :: should be renamed as CancelProductOrderRef if this is a reference entity +... ... productOrder :: no description value + +... Product/LoyaltyExecutionPoint.schema.json +... ... Failing to check for issues: TypeError: Cannot read property 'properties' of undefined + +... Service/AlternateServiceProposal.schema.json +... ... alternateService :: no description value + +error: TypeError: fd must be a file descriptor From 78627893c7dc956f2032d6286af1e45e891e09cd Mon Sep 17 00:00:00 2001 From: Test results Date: Mon, 15 Jul 2019 15:41:26 +0200 Subject: [PATCH 06/11] Automated fix (with same indention) --- Common/Address.schema.json | 134 +++--- Common/AddressRef.schema.json | 24 +- Common/AlternateGeographicAddress.schema.json | 174 +++---- Common/Any.schema.json | 16 +- Common/Area.schema.json | 68 +-- Common/Association.schema.json | 126 ++--- Common/AssociationRole.schema.json | 70 +-- Common/AssociationRoleSpec.schema.json | 78 ++-- Common/AssociationSpecRef.schema.json | 54 +-- Common/AssociationSpecification.schema.json | 114 ++--- Common/Attachment.schema.json | 152 +++---- Common/AttachmentRef.schema.json | 74 +-- Common/AttachmentRefOrValue.schema.json | 32 +- Common/BaseEvent.schema.json | 122 ++--- Common/BasePlusEvent.schema.json | 114 ++--- Common/BusinessInteraction.schema.json | 66 +-- Common/CalendarEventRef.schema.json | 28 +- Common/CalendarPeriod.schema.json | 64 +-- Common/ChangeRequest.schema.json | 362 +++++++-------- .../ChangeRequestCharacteristic.schema.json | 46 +- Common/ChangeRequestRef.schema.json | 54 +-- Common/ChangeRequestSpecification.schema.json | 68 +-- Common/Channel.schema.json | 54 +-- Common/ChannelRef.schema.json | 38 +- Common/Characteristic.schema.json | 62 +-- Common/CommonComponents.schema.json | 80 ++-- Common/CommunicationMessage.schema.json | 186 ++++---- ...unicationRequestCharacteristic.schema.json | 46 +- Common/ConstraintRef.schema.json | 70 +-- Common/ContactMedium.schema.json | 62 +-- Common/Document.schema.json | 186 ++++---- Common/DocumentAttachment.schema.json | 104 ++--- Common/DocumentCharacteristic.schema.json | 44 +- Common/DocumentRef.schema.json | 52 +-- Common/DocumentRelationship.schema.json | 44 +- Common/DocumentSpecification.schema.json | 72 +-- Common/Duration.schema.json | 36 +- Common/Entity.schema.json | 82 ++-- Common/EntityAttachment.schema.json | 88 ++-- Common/EntityCatalog.schema.json | 96 ++-- Common/EntityCatalogItem.schema.json | 96 ++-- Common/EntityCatalogItemRef.schema.json | 70 +-- Common/EntityCategory.schema.json | 112 ++--- Common/EntityRef.schema.json | 62 +-- Common/EntitySchemaRef.schema.json | 38 +- Common/EntitySpecRelationship.schema.json | 84 ++-- Common/EntitySpecification.schema.json | 138 +++--- Common/EntitySpecificationRef.schema.json | 70 +-- Common/Error.schema.json | 120 ++--- Common/EventRef.schema.json | 72 +-- Common/ExportJob.schema.json | 116 ++--- Common/ExternalReference.schema.json | 46 +- Common/FileDocument.schema.json | 72 +-- Common/FloatCharacteristic.schema.json | 46 +- Common/GeographicAddress.schema.json | 144 +++--- Common/GeographicAddressRef.schema.json | 54 +-- .../GeographicAddressValidation.schema.json | 98 ++-- Common/GeographicLocation.schema.json | 62 +-- Common/GeographicLocationRef.schema.json | 26 +- Common/GeographicPoint.schema.json | 54 +-- Common/GeographicSite.schema.json | 132 +++--- Common/GeographicSiteRef.schema.json | 48 +- Common/GeographicSubAddress.schema.json | 118 ++--- Common/HeaderItem.schema.json | 44 +- Common/HourPeriod.schema.json | 44 +- Common/Hub.schema.json | 84 ++-- Common/ImpactEntityRef.schema.json | 62 +-- Common/ImportJob.schema.json | 108 ++--- Common/Incident.schema.json | 46 +- Common/IntegerCharacteristic.schema.json | 44 +- Common/JobStateType.schema.json | 30 +- Common/LocationCharacteristic.schema.json | 42 +- Common/MediumCharacteristic.schema.json | 118 ++--- Common/Money.schema.json | 48 +- Common/Monitor.schema.json | 78 ++-- Common/NetworkFunction.schema.json | 30 +- Common/Note.schema.json | 64 +-- Common/Notification.schema.json | 72 +-- Common/Object.schema.json | 44 +- Common/ObjectCharacteristic.schema.json | 44 +- Common/Place.schema.json | 54 +-- Common/PlaceRef.schema.json | 28 +- Common/ProcessFlow.schema.json | 140 +++--- Common/ProcessFlowRef.schema.json | 38 +- Common/ProcessFlowStateType.schema.json | 30 +- Common/QualificationRef.schema.json | 38 +- Common/Quantity.schema.json | 40 +- Common/QuantityType.schema.json | 46 +- Common/RatedProductUsage.schema.json | 136 +++--- Common/Receiver.schema.json | 84 ++-- Common/ReceiverRef.schema.json | 54 +-- Common/Record.schema.json | 56 +-- Common/RelatedChangeRequestRef.schema.json | 70 +-- Common/RelatedChannel.schema.json | 46 +- Common/RelatedEntity.schema.json | 48 +- Common/RelatedEntityRef.schema.json | 62 +-- ...tedGeographicAddressRefOrValue.schema.json | 52 +-- ...edGeographicLocationRefOrValue.schema.json | 52 +-- Common/RelatedObject.schema.json | 46 +- Common/RelatedPlace.schema.json | 62 +-- Common/RelatedPlaceRefOrValue.schema.json | 50 +- Common/Request.schema.json | 68 +-- Common/Resolution.schema.json | 66 +-- Common/Response.schema.json | 60 +-- Common/RetrieveGeographicLocation.schema.json | 74 +-- Common/RetrieveLocationRelation.schema.json | 78 ++-- Common/Sender.schema.json | 68 +-- Common/SiteRelationship.schema.json | 68 +-- Common/SpecCharRelationship.schema.json | 70 +-- Common/SpecCharacteristic.schema.json | 94 ++-- Common/SpecCharacteristicValue.schema.json | 102 ++--- Common/StatusChange.schema.json | 56 +-- Common/Street.schema.json | 78 ++-- Common/StreetSegment.schema.json | 76 ++-- Common/StringCharacteristic.schema.json | 44 +- Common/SubAddress.schema.json | 116 ++--- Common/TargetEntityRef.schema.json | 62 +-- Common/Task.schema.json | 54 +-- Common/TaskFlow.schema.json | 162 +++---- Common/TaskFlowRef.schema.json | 52 +-- Common/TaskFlowRelationship.schema.json | 44 +- Common/TaskFlowStateType.schema.json | 32 +- Common/TaskStateType.schema.json | 30 +- Common/TaxDefinition.schema.json | 62 +-- Common/Ticket.schema.json | 184 ++++---- Common/TicketRelationship.schema.json | 44 +- Common/TimePeriod.schema.json | 66 +-- Common/TimePeriodType.schema.json | 46 +- Common/TroubleTicket.schema.json | 262 +++++------ Common/TroubleTicketRef.schema.json | 28 +- Common/TroubleTicketRelationship.schema.json | 44 +- Common/TroubleTicketStatusType.schema.json | 38 +- Common/Value.schema.json | 26 +- Common/WorkLog.schema.json | 68 +-- Customer/AccumulatedBalance.schema.json | 112 ++--- Customer/AppliedBillingRate.schema.json | 126 ++--- ...pliedBillingRateCharacteristic.schema.json | 46 +- Customer/AppliedBillingTaxRate.schema.json | 56 +-- .../AppliedCustomerBillingRate.schema.json | 126 ++--- Customer/AppliedPartyBillingRate.schema.json | 126 ++--- Customer/Appointment.schema.json | 184 ++++---- Customer/AppointmentRef.schema.json | 62 +-- Customer/AppointmentStateType.schema.json | 32 +- Customer/AppointmentStateValues.schema.json | 32 +- Customer/Authorization.schema.json | 86 ++-- Customer/BalanceActionRequestRef.schema.json | 44 +- Customer/BalanceActivity.schema.json | 122 ++--- Customer/BalanceAdjustment.schema.json | 18 +- Customer/BalanceAdjustmentBody.schema.json | 60 +-- Customer/BalanceAdjustmentRequest.schema.json | 120 ++--- Customer/BalanceDeduct.schema.json | 120 ++--- Customer/BalanceDeductRef.schema.json | 54 +-- Customer/BalanceDeductRollback.schema.json | 102 ++--- Customer/BalanceReserve.schema.json | 150 +++--- Customer/BalanceReserveRef.schema.json | 54 +-- Customer/BalanceTopup.schema.json | 18 +- Customer/BalanceTopupBody.schema.json | 60 +-- Customer/BalanceTopupRequest.schema.json | 190 ++++---- Customer/BalanceTopupStatus.schema.json | 40 +- .../BalanceTopupStatusTypeModify.schema.json | 32 +- Customer/BalanceTransfer.schema.json | 18 +- Customer/BalanceTransferBody.schema.json | 70 +-- Customer/BalanceTransferRequest.schema.json | 192 ++++---- ...alanceTransferStatusTypeModify.schema.json | 30 +- Customer/BalanceUnreserve.schema.json | 96 ++-- Customer/BankCardDetails.schema.json | 96 ++-- Customer/BankCardMethod.schema.json | 114 ++--- Customer/Bill.schema.json | 228 +++++----- Customer/BillFormat.schema.json | 68 +-- Customer/BillFormatRef.schema.json | 62 +-- Customer/BillFormatRefOrValue.schema.json | 54 +-- Customer/BillPresentationMedia.schema.json | 68 +-- Customer/BillPresentationMediaRef.schema.json | 62 +-- ...illPresentationMediaRefOrValue.schema.json | 54 +-- Customer/BillRef.schema.json | 62 +-- Customer/BillStructure.schema.json | 54 +-- Customer/BillingAccount.schema.json | 36 +- Customer/BillingAccountRef.schema.json | 62 +-- .../BillingCycleSpecification.schema.json | 132 +++--- .../BillingCycleSpecificationRef.schema.json | 78 ++-- ...ngCycleSpecificationRefOrValue.schema.json | 54 +-- Customer/Bucket.schema.json | 26 +- Customer/BucketBalance.schema.json | 158 +++---- Customer/BucketBalanceRef.schema.json | 44 +- Customer/CartItem.schema.json | 146 +++--- Customer/CartItemActionType.schema.json | 30 +- Customer/CartItemRef.schema.json | 46 +- Customer/CartItemRelationship.schema.json | 58 +-- Customer/CartItemStatusType.schema.json | 26 +- Customer/CartPrice.schema.json | 96 ++-- Customer/CartTerm.schema.json | 46 +- Customer/CashDetails.schema.json | 28 +- Customer/CashMethod.schema.json | 114 ++--- Customer/CheckDetails.schema.json | 72 +-- Customer/CheckMethod.schema.json | 114 ++--- Customer/CreditProfile.schema.json | 64 +-- Customer/Customer.schema.json | 174 +++---- Customer/CustomerBill.schema.json | 226 ++++----- Customer/DigitalWalletDetails.schema.json | 56 +-- Customer/DigitalWalletMethod.schema.json | 114 ++--- Customer/Disability.schema.json | 52 +-- Customer/OrderItem.schema.json | 170 +++---- Customer/OrderItemActionType.schema.json | 30 +- Customer/OrderItemPrice.schema.json | 108 ++--- Customer/OrderItemRelationship.schema.json | 42 +- Customer/OrderPrice.schema.json | 108 ++--- Customer/OrderRelationship.schema.json | 48 +- Customer/OrderTerm.schema.json | 54 +-- Customer/PaymentItem.schema.json | 44 +- Customer/PaymentMethod.schema.json | 110 ++--- Customer/PaymentMethodRef.schema.json | 62 +-- Customer/PaymentMethodRefOrValue.schema.json | 68 +-- Customer/PaymentPlan.schema.json | 92 ++-- Customer/PaymentRef.schema.json | 38 +- Customer/Price.schema.json | 66 +-- Customer/ProductOrder.schema.json | 286 ++++++------ Customer/ProductOrderItem.schema.json | 182 ++++---- .../ProductOrderItemStateType.schema.json | 42 +- Customer/ProductOrderRef.schema.json | 28 +- Customer/ProductOrderStateType.schema.json | 44 +- Customer/Quote.schema.json | 286 ++++++------ Customer/QuoteItem.schema.json | 194 ++++---- Customer/QuoteItemRef.schema.json | 70 +-- Customer/QuoteItemRelationship.schema.json | 46 +- Customer/QuotePrice.schema.json | 96 ++-- Customer/QuoteRef.schema.json | 28 +- Customer/SearchTimeSlot.schema.json | 124 ++--- Customer/SettlementMethod.schema.json | 46 +- Customer/SettlementNoteAdvice.schema.json | 176 +++---- Customer/SettlementNoteImage.schema.json | 62 +-- Customer/SettlementNoteItem.schema.json | 110 ++--- Customer/ShoppingCart.schema.json | 104 ++--- Customer/ShoppingCartRef.schema.json | 54 +-- Customer/TaxItem.schema.json | 56 +-- Customer/TimeSlot.schema.json | 60 +-- Customer/TokenizedCardDetails.schema.json | 78 ++-- Customer/TokenizedCardMethod.schema.json | 114 ++--- Customer/VoucherDetails.schema.json | 66 +-- Customer/VoucherMethod.schema.json | 114 ++--- EngagedParty/Account.schema.json | 162 +++---- EngagedParty/AccountBalance.schema.json | 64 +-- EngagedParty/AccountBalanceRef.schema.json | 62 +-- EngagedParty/AccountDirectDetails.schema.json | 34 +- EngagedParty/AccountDirectMethod.schema.json | 116 ++--- EngagedParty/AccountRef.schema.json | 70 +-- EngagedParty/AccountRelationship.schema.json | 58 +-- EngagedParty/AccountTaxExemption.schema.json | 70 +-- EngagedParty/Agreement.schema.json | 208 ++++----- EngagedParty/AgreementAttachment.schema.json | 64 +-- .../AgreementAuthorization.schema.json | 56 +-- EngagedParty/AgreementItem.schema.json | 54 +-- EngagedParty/AgreementItemRef.schema.json | 38 +- EngagedParty/AgreementRef.schema.json | 38 +- .../AgreementSpecCharacteristic.schema.json | 82 ++-- ...reementSpecCharacteristicValue.schema.json | 86 ++-- .../AgreementSpecification.schema.json | 166 +++---- .../AgreementSpecificationRef.schema.json | 46 +- ...ementSpecificationRelationship.schema.json | 46 +- .../AgreementTermOrCondition.schema.json | 54 +-- EngagedParty/BankAccount.schema.json | 62 +-- .../BankAccountDebitDetails.schema.json | 70 +-- .../BankAccountDebitMethod.schema.json | 114 ++--- .../BankAccountTransferDetails.schema.json | 70 +-- .../BankAccountTransferMethod.schema.json | 114 ++--- EngagedParty/Contact.schema.json | 86 ++-- EngagedParty/FinancialAccount.schema.json | 34 +- EngagedParty/FinancialAccountRef.schema.json | 68 +-- EngagedParty/Individual.schema.json | 266 +++++------ .../IndividualIdentification.schema.json | 78 ++-- EngagedParty/IndividualStateType.schema.json | 28 +- EngagedParty/IssuerRef.schema.json | 54 +-- EngagedParty/LanguageAbility.schema.json | 92 ++-- EngagedParty/Organization.schema.json | 146 +++--- .../OrganizationChildRelationship.schema.json | 44 +- .../OrganizationIdentification.schema.json | 78 ++-- ...OrganizationParentRelationship.schema.json | 44 +- EngagedParty/OrganizationRef.schema.json | 26 +- .../OrganizationStateType.schema.json | 28 +- EngagedParty/OtherName.schema.json | 102 ++--- EngagedParty/OtherNameIndividual.schema.json | 124 ++--- .../OtherNameOrganization.schema.json | 60 +-- EngagedParty/PartnershipType.schema.json | 80 ++-- EngagedParty/PartnershipTypeRef.schema.json | 62 +-- EngagedParty/Party.schema.json | 118 ++--- EngagedParty/PartyAccount.schema.json | 76 ++-- EngagedParty/PartyAccountRef.schema.json | 78 ++-- EngagedParty/PartyBill.schema.json | 226 ++++----- EngagedParty/PartyCreditProfile.schema.json | 70 +-- EngagedParty/PartyOrPartyRoleRef.schema.json | 70 +-- EngagedParty/PartyRef.schema.json | 32 +- EngagedParty/PartyRole.schema.json | 186 ++++---- EngagedParty/PartyRoleRef.schema.json | 78 ++-- EngagedParty/RelatedParty.schema.json | 54 +-- EngagedParty/RelatedPartyRef.schema.json | 70 +-- .../RelatedPartyRefOrValue.schema.json | 52 +-- EngagedParty/RoleType.schema.json | 80 ++-- EngagedParty/RoleTypeRef.schema.json | 70 +-- EngagedParty/Rule.schema.json | 70 +-- EngagedParty/RuleRef.schema.json | 60 +-- EngagedParty/SLA.schema.json | 130 +++--- EngagedParty/SLARef.schema.json | 62 +-- EngagedParty/SLAViolation.schema.json | 72 +-- EngagedParty/SLAViolationRef.schema.json | 48 +- EngagedParty/SettlementAccount.schema.json | 36 +- EngagedParty/Skill.schema.json | 68 +-- .../TaxExemptionCertificate.schema.json | 62 +-- EngagedParty/TemplateRef.schema.json | 60 +-- EngagedParty/Violation.schema.json | 88 ++-- MarketingSales/MarketSegmentRef.schema.json | 62 +-- .../MarketingCampaignRef.schema.json | 28 +- MarketingSales/SalesLead.schema.json | 232 +++++----- .../SalesOpportunityRef.schema.json | 28 +- ...ternateProductOfferingProposal.schema.json | 64 +-- Product/BaseProductRefOrValue.schema.json | 150 +++--- Product/BundledProductOffering.schema.json | 70 +-- .../BundledProductOfferingOption.schema.json | 54 +-- ...oductOfferingPriceRelationship.schema.json | 54 +-- Product/BundledProductOfferingRef.schema.json | 62 +-- .../BundledProductSpecification.schema.json | 62 +-- Product/CancelOrder.schema.json | 82 ++-- Product/CancelProductOrder.schema.json | 42 +- Product/Catalog.schema.json | 132 +++--- Product/Category.schema.json | 140 +++--- Product/CategoryRef.schema.json | 38 +- Product/ConsumptionSummary.schema.json | 86 ++-- ...ligibilityUnavailabilityReason.schema.json | 46 +- Product/LoyaltyAccount.schema.json | 42 +- Product/LoyaltyAccountRef.schema.json | 36 +- Product/LoyaltyAction.schema.json | 138 +++--- Product/LoyaltyActionRef.schema.json | 36 +- Product/LoyaltyBalance.schema.json | 66 +-- Product/LoyaltyCondition.schema.json | 60 +-- Product/LoyaltyConditionRef.schema.json | 36 +- Product/LoyaltyEvent.schema.json | 60 +-- Product/LoyaltyEventType.schema.json | 44 +- Product/LoyaltyEventTypeRef.schema.json | 36 +- Product/LoyaltyExecutionPoint.schema.json | 150 +++--- Product/LoyaltyProgramMember.schema.json | 70 +-- Product/LoyaltyProgramMemberRef.schema.json | 46 +- Product/LoyaltyProgramProduct.schema.json | 106 ++--- Product/LoyaltyProgramProductRef.schema.json | 46 +- Product/LoyaltyProgramProductSpec.schema.json | 90 ++-- .../LoyaltyProgramProductSpecRef.schema.json | 36 +- Product/LoyaltyRule.schema.json | 142 +++--- Product/LoyaltyRuleAction.schema.json | 36 +- Product/LoyaltyRuleCondition.schema.json | 36 +- Product/LoyaltyRuleEventType.schema.json | 36 +- Product/NetworkProduct.schema.json | 90 ++-- Product/NetworkProductRef.schema.json | 70 +-- Product/OrderStateType.schema.json | 44 +- Product/PriceAlteration.schema.json | 106 ++--- Product/PricingLogicAlgorithm.schema.json | 78 ++-- Product/Product.schema.json | 274 +++++------ Product/ProductActionType.schema.json | 30 +- Product/ProductCharacteristic.schema.json | 46 +- .../ProductInventoryRelationship.schema.json | 52 +-- Product/ProductOffering.schema.json | 292 ++++++------ Product/ProductOfferingPrice.schema.json | 290 ++++++------ Product/ProductOfferingPriceRef.schema.json | 28 +- ...oductOfferingPriceRelationship.schema.json | 62 +-- .../ProductOfferingQualification.schema.json | 210 ++++----- ...oductOfferingQualificationItem.schema.json | 148 +++--- ...ctOfferingQualificationItemRef.schema.json | 78 ++-- ...roductOfferingQualificationRef.schema.json | 28 +- ...OfferingQualificationStateType.schema.json | 30 +- Product/ProductOfferingRef.schema.json | 28 +- Product/ProductOfferingTerm.schema.json | 62 +-- Product/ProductPrice.schema.json | 108 ++--- Product/ProductRef.schema.json | 26 +- Product/ProductRefOrValue.schema.json | 34 +- Product/ProductRelationship.schema.json | 52 +-- Product/ProductRequest.schema.json | 248 +++++----- Product/ProductRestriction.schema.json | 108 ++--- .../ProductSpecCharRelationship.schema.json | 46 +- Product/ProductSpecCharacteristic.schema.json | 94 ++-- ...ProductSpecCharacteristicValue.schema.json | 86 ++-- Product/ProductSpecification.schema.json | 226 ++++----- ...uctSpecificationCharacteristic.schema.json | 138 +++--- ...tionCharacteristicRelationship.schema.json | 78 ++-- ...ecificationCharacteristicValue.schema.json | 102 ++--- ...ficationCharacteristicValueUse.schema.json | 90 ++-- Product/ProductSpecificationRef.schema.json | 46 +- ...oductSpecificationRelationship.schema.json | 62 +-- .../ProductSpecificationSchemaRef.schema.json | 38 +- Product/ProductStatusType.schema.json | 38 +- Product/ProductTerm.schema.json | 62 +-- Product/Promotion.schema.json | 108 ++--- Product/PromotionAction.schema.json | 64 +-- Product/PromotionCriteria.schema.json | 62 +-- Product/PromotionCriteriaGroup.schema.json | 66 +-- Product/PromotionPattern.schema.json | 102 ++--- .../QualificationItemRelationship.schema.json | 46 +- Product/QuoteItemStateType.schema.json | 30 +- Product/QuoteStateType.schema.json | 34 +- Product/QuoteTerm.schema.json | 54 +-- Product/Recommendation.schema.json | 130 +++--- Product/RecommendationItem.schema.json | 46 +- Product/RelatedProductOrderItem.schema.json | 86 ++-- Product/TargetProductSchema.schema.json | 46 +- Product/Usage.schema.json | 122 ++--- Product/UsageCharacteristic.schema.json | 46 +- Product/UsageConsumptionReport.schema.json | 92 ++-- Product/UsageConsumptionReportRef.schema.json | 72 +-- .../UsageConsumptionReportRequest.schema.json | 116 ++--- ...sageConsumptionReportRequestIn.schema.json | 74 +-- Product/UsageSpecCharacteristic.schema.json | 66 +-- .../UsageSpecCharacteristicValue.schema.json | 70 +-- Product/UsageSpecification.schema.json | 82 ++-- Product/UsageSpecificationRef.schema.json | 62 +-- Product/UsageVolumeBalance.schema.json | 54 +-- Product/UsageVolumeProduct.schema.json | 98 ++-- Product/UsageVolumeProductRef.schema.json | 54 +-- Resource/LogicalResource.schema.json | 180 ++++---- Resource/PhysicalResource.schema.json | 206 ++++----- Resource/RealizingResourceRef.schema.json | 28 +- Resource/Resource.schema.json | 172 +++---- Resource/ResourceAlarmRef.schema.json | 60 +-- Resource/ResourceCandidateRef.schema.json | 70 +-- Resource/ResourceCharacteristic.schema.json | 44 +- Resource/ResourceOrder.schema.json | 178 ++++---- Resource/ResourceOrderItem.schema.json | 80 ++-- Resource/ResourceOrderItemRef.schema.json | 44 +- .../ResourceOrderItemRelationship.schema.json | 42 +- Resource/ResourceOrderRef.schema.json | 52 +-- .../ResourceOrderRelationship.schema.json | 48 +- Resource/ResourceRef.schema.json | 44 +- Resource/ResourceRelationship.schema.json | 46 +- Resource/ResourceSpecificationRef.schema.json | 70 +-- Resource/SupportingResource.schema.json | 52 +-- Service/AlternateServiceProposal.schema.json | 54 +-- Service/AppliedConsequence.schema.json | 62 +-- Service/BaseService.schema.json | 170 +++---- Service/FirstAlert.schema.json | 54 +-- Service/ImpactPattern.schema.json | 52 +-- .../MeasureThresholdRuleViolation.schema.json | 116 ++--- .../MetricDefMeasureConsequence.schema.json | 70 +-- .../MetricDefMeasureThresholdRule.schema.json | 116 ++--- Service/ProblemAcknowledgement.schema.json | 82 ++-- Service/ProblemGroup.schema.json | 68 +-- Service/ProblemUnacknowledgement.schema.json | 82 ++-- Service/ProblemUngroup.schema.json | 68 +-- Service/Service.schema.json | 126 ++--- Service/ServiceCandidate.schema.json | 118 ++--- Service/ServiceCandidateRef.schema.json | 70 +-- Service/ServiceCatalog.schema.json | 124 ++--- Service/ServiceCategory.schema.json | 140 +++--- Service/ServiceCategoryRef.schema.json | 62 +-- Service/ServiceCharacteristic.schema.json | 54 +-- ...ligibilityUnavailabilityReason.schema.json | 46 +- Service/ServiceLevelObjective.schema.json | 140 +++--- Service/ServiceLevelObjectiveRef.schema.json | 54 +-- .../ServiceLevelSpecConsequence.schema.json | 46 +- Service/ServiceLevelSpecParameter.schema.json | 92 ++-- Service/ServiceLevelSpecification.schema.json | 84 ++-- .../ServiceLevelSpecificationRef.schema.json | 62 +-- ...erviceOfferingQualificationRef.schema.json | 62 +-- Service/ServiceOrder.schema.json | 208 ++++----- Service/ServiceOrderActionType.schema.json | 30 +- Service/ServiceOrderItem.schema.json | 90 ++-- .../ServiceOrderItemRelationship.schema.json | 54 +-- Service/ServiceOrderRef.schema.json | 62 +-- Service/ServiceOrderRelationship.schema.json | 68 +-- Service/ServiceOrderStateType.schema.json | 40 +- Service/ServiceProblem.schema.json | 430 +++++++++--------- Service/ServiceProblemEventRecord.schema.json | 80 ++-- Service/ServiceProblemRef.schema.json | 60 +-- Service/ServiceQualification.schema.json | 182 ++++---- Service/ServiceQualificationItem.schema.json | 170 +++---- ...eQualificationItemRelationship.schema.json | 46 +- ...rviceQualificationRelationship.schema.json | 44 +- Service/ServiceRef.schema.json | 28 +- Service/ServiceRelationship.schema.json | 44 +- .../ServiceSpecCharRelationship.schema.json | 78 ++-- Service/ServiceSpecCharacteristic.schema.json | 146 +++--- ...ServiceSpecCharacteristicValue.schema.json | 102 ++--- Service/ServiceSpecRelationship.schema.json | 78 ++-- Service/ServiceSpecification.schema.json | 196 ++++---- Service/ServiceSpecificationRef.schema.json | 78 ++-- Service/ServiceStateType.schema.json | 34 +- Service/ServiceTest.schema.json | 142 +++--- Service/ServiceTestCharacteristic.schema.json | 46 +- Service/ServiceTestSpecification.schema.json | 100 ++-- .../ServiceTestSpecificationRef.schema.json | 62 +-- Service/SupportingService.schema.json | 62 +-- Service/TargetServiceSchema.schema.json | 44 +- Service/TerminationError.schema.json | 36 +- Service/TestMeasure.schema.json | 112 ++--- Service/TestMeasureDefinition.schema.json | 124 ++--- Service/TrackingRecord.schema.json | 86 ++-- 489 files changed, 19898 insertions(+), 19898 deletions(-) diff --git a/Common/Address.schema.json b/Common/Address.schema.json index 44debacb..d05c7075 100644 --- a/Common/Address.schema.json +++ b/Common/Address.schema.json @@ -1,71 +1,71 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Address.schema.json", - "title": "Address", - "definitions": { - "Address": { - "$id": "#Address", - "description": "Structured textual way of describing how to find a Property in an urban area (country properties are often\ndefined differently).\nNote : Address corresponds to SID UrbanPropertyAddress", - "type": "object", - "properties": { - "city": { - "type": "string", - "description": "City that the address is in" - }, - "country": { - "type": "string", - "description": "Country that the address is in" - }, - "locality": { - "type": "string", - "description": "\"An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature.\" [ANZLIC-STREET], or a suburb \"a bounded locality within a city, town or shire principally of urban character \" [ANZLICSTREET]" - }, - "postcode": { - "type": "string", - "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" - }, - "stateOrProvince": { - "type": "string", - "description": "the State or Province that the address is in" - }, - "streetName": { - "type": "string", - "description": "Name of the street or other street type" - }, - "streetNr": { - "type": "string", - "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" - }, - "streetNrLast": { - "type": "string", - "description": "Last number in a range of street numbers allocated to a property" - }, - "streetNrLastSuffix": { - "type": "string", - "description": "Last street number suffix for a ranged address" - }, - "streetNrSuffix": { - "type": "string", - "description": "the first street number suffix" - }, - "streetSuffix": { - "type": "string", - "description": "A modifier denoting a relative direction" - }, - "streetType": { - "type": "string", - "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf " - }, - "subAddress": { - "$ref": "SubAddress.schema.json#SubAddress", - "description": "Within a property in an urban area, may refer to a building, building cluster, or a floor of a multistory building" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Address.schema.json", + "title": "Address", + "definitions": { + "Address": { + "$id": "#Address", + "description": "Structured textual way of describing how to find a Property in an urban area (country properties are often\ndefined differently).\nNote : Address corresponds to SID UrbanPropertyAddress", + "type": "object", + "properties": { + "city": { + "type": "string", + "description": "City that the address is in" + }, + "country": { + "type": "string", + "description": "Country that the address is in" + }, + "locality": { + "type": "string", + "description": "\"An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature.\" [ANZLIC-STREET], or a suburb \"a bounded locality within a city, town or shire principally of urban character \" [ANZLICSTREET]" + }, + "postcode": { + "type": "string", + "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" + }, + "stateOrProvince": { + "type": "string", + "description": "the State or Province that the address is in" + }, + "streetName": { + "type": "string", + "description": "Name of the street or other street type" + }, + "streetNr": { + "type": "string", + "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" + }, + "streetNrLast": { + "type": "string", + "description": "Last number in a range of street numbers allocated to a property" + }, + "streetNrLastSuffix": { + "type": "string", + "description": "Last street number suffix for a ranged address" + }, + "streetNrSuffix": { + "type": "string", + "description": "the first street number suffix" + }, + "streetSuffix": { + "type": "string", + "description": "A modifier denoting a relative direction" + }, + "streetType": { + "type": "string", + "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf " + }, + "subAddress": { + "$ref": "SubAddress.schema.json#SubAddress", + "description": "Within a property in an urban area, may refer to a building, building cluster, or a floor of a multistory building" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/AddressRef.schema.json b/Common/AddressRef.schema.json index b5d22d4c..9790806d 100644 --- a/Common/AddressRef.schema.json +++ b/Common/AddressRef.schema.json @@ -1,16 +1,16 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AddressRef.schema.json", - "title": "AddressRef", - "definitions": { - "AddressRef": { - "$id": "#AddressRef", - "type": "object", - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AddressRef.schema.json", + "title": "AddressRef", + "definitions": { + "AddressRef": { + "$id": "#AddressRef", + "type": "object", + "allOf": [ + { + "$ref": "EntityRef.schema.json#EntityRef" + } + ] } - ] } - } } \ No newline at end of file diff --git a/Common/AlternateGeographicAddress.schema.json b/Common/AlternateGeographicAddress.schema.json index 6b89f451..2b6bbced 100644 --- a/Common/AlternateGeographicAddress.schema.json +++ b/Common/AlternateGeographicAddress.schema.json @@ -1,91 +1,91 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AlternateGeographicAddress.schema.json", - "title": "AlternateGeographicAddress", - "definitions": { - "AlternateGeographicAddress": { - "$id": "#AlternateGeographicAddress", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "An URI used to access to the address resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of the address" - }, - "name": { - "type": "string", - "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" - }, - "role": { - "type": "string", - "description": "Role of the place, such as: [home delivery], [shop retrieval])" - }, - "city": { - "type": "string", - "description": "City that the address is in" - }, - "country": { - "type": "string", - "description": "Country that the address is in" - }, - "locality": { - "type": "string", - "description": "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature. [ANZLIC-STREET], or a suburb, a bounded locality within a city, town or shire principally of urban character [ANZLICSTREET]" - }, - "postcode": { - "type": "string", - "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" - }, - "stateOrProvince": { - "type": "string", - "description": "the State or Province that the address is in" - }, - "streetName": { - "type": "string", - "description": "Name of the street or other street type" - }, - "streetNr": { - "type": "string", - "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" - }, - "streetNrLast": { - "type": "string", - "description": "Last number in a range of street numbers allocated to a property" - }, - "streetNrLastSuffix": { - "type": "string", - "description": "Last street number suffix for a ranged address" - }, - "streetNrSuffix": { - "type": "string", - "description": "the first street number suffix" - }, - "streetSuffix": { - "type": "string", - "description": "A modifier denoting a relative direction" - }, - "streetType": { - "type": "string", - "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf " - }, - "geographicLocation": { - "$ref": "GeographicLocation.schema.json#GeographicLocation" - }, - "geographicSubAddress": { - "type": "array", - "items": { - "$ref": "GeographicSubAddress.schema.json#GeographicSubAddress" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AlternateGeographicAddress.schema.json", + "title": "AlternateGeographicAddress", + "definitions": { + "AlternateGeographicAddress": { + "$id": "#AlternateGeographicAddress", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "An URI used to access to the address resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of the address" + }, + "name": { + "type": "string", + "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" + }, + "role": { + "type": "string", + "description": "Role of the place, such as: [home delivery], [shop retrieval])" + }, + "city": { + "type": "string", + "description": "City that the address is in" + }, + "country": { + "type": "string", + "description": "Country that the address is in" + }, + "locality": { + "type": "string", + "description": "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature. [ANZLIC-STREET], or a suburb, a bounded locality within a city, town or shire principally of urban character [ANZLICSTREET]" + }, + "postcode": { + "type": "string", + "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" + }, + "stateOrProvince": { + "type": "string", + "description": "the State or Province that the address is in" + }, + "streetName": { + "type": "string", + "description": "Name of the street or other street type" + }, + "streetNr": { + "type": "string", + "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" + }, + "streetNrLast": { + "type": "string", + "description": "Last number in a range of street numbers allocated to a property" + }, + "streetNrLastSuffix": { + "type": "string", + "description": "Last street number suffix for a ranged address" + }, + "streetNrSuffix": { + "type": "string", + "description": "the first street number suffix" + }, + "streetSuffix": { + "type": "string", + "description": "A modifier denoting a relative direction" + }, + "streetType": { + "type": "string", + "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf " + }, + "geographicLocation": { + "$ref": "GeographicLocation.schema.json#GeographicLocation" + }, + "geographicSubAddress": { + "type": "array", + "items": { + "$ref": "GeographicSubAddress.schema.json#GeographicSubAddress" + } + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/Any.schema.json b/Common/Any.schema.json index fd85d65c..18f415c8 100644 --- a/Common/Any.schema.json +++ b/Common/Any.schema.json @@ -1,11 +1,11 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Any.schema.json", - "title": "Any", - "definitions": { - "Any": { - "$id": "#Any", - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Any.schema.json", + "title": "Any", + "definitions": { + "Any": { + "$id": "#Any", + "type": "object" + } } - } } \ No newline at end of file diff --git a/Common/Area.schema.json b/Common/Area.schema.json index 94c05b2b..8edacc8c 100644 --- a/Common/Area.schema.json +++ b/Common/Area.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Area.schema.json", - "title": "Area", - "definitions": { - "Area": { - "$id": "#Area", - "description": "Area corresponds to a geographic area as a city, a locality, a district, etc.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of an Area" - }, - "name": { - "type": "string", - "description": "The defined name of the municipality" - }, - "areaType": { - "type": "string", - "description": "SUBURB, LOCALITY, CITY, TOWN, BOROUGH, ..." - }, - "characteristic": { - "type": "array", - "description": "Any additional characterization of the Area, defined for the Area type", - "items": { - "$ref": "LocationCharacteristic.schema.json#LocationCharacteristic" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Area.schema.json", + "title": "Area", + "definitions": { + "Area": { + "$id": "#Area", + "description": "Area corresponds to a geographic area as a city, a locality, a district, etc.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of an Area" + }, + "name": { + "type": "string", + "description": "The defined name of the municipality" + }, + "areaType": { + "type": "string", + "description": "SUBURB, LOCALITY, CITY, TOWN, BOROUGH, ..." + }, + "characteristic": { + "type": "array", + "description": "Any additional characterization of the Area, defined for the Area type", + "items": { + "$ref": "LocationCharacteristic.schema.json#LocationCharacteristic" + } + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/Association.schema.json b/Common/Association.schema.json index 7ef72a15..16bdfb51 100644 --- a/Common/Association.schema.json +++ b/Common/Association.schema.json @@ -1,67 +1,67 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Association.schema.json", - "title": "Association", - "definitions": { - "Association": { - "$id": "#Association", - "description": "Association is the class that describe a relationship between two or more entity specifications based on a given association specification. The role and type of each endpoint in the relationship is given by an association role. The type of endpoints in the relationship should match the ones as defined in the corresponding association role specification. A relationship between entity specifications may be governed by conditions and rules which are addressed by constraint references in this resource. Constraints for a relationship may include new rules and conditions in addition to those defined for the corresponding association specification", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the association" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to this association" - }, - "id": { - "type": "string", - "description": "unique identifier of the association" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "The last modified date of this association object" - }, - "lifecycleStatus": { - "type": "string", - "description": "Indicates the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name given to this association" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which this association is valid" - }, - "version": { - "type": "string", - "description": "Version of this REST resource" - }, - "associationSpec": { - "$ref": "AssociationSpecRef.schema.json#AssociationSpecRef", - "description": "The specification of this association" - }, - "associationRole": { - "$ref": "AssociationRole.schema.json#AssociationRole", - "description": "The role of this association" - }, - "constraint": { - "description": "Any constraints in this association", - "type": "array", - "items": { - "$ref": "ConstraintRef.schema.json#ConstraintRef" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Association.schema.json", + "title": "Association", + "definitions": { + "Association": { + "$id": "#Association", + "description": "Association is the class that describe a relationship between two or more entity specifications based on a given association specification. The role and type of each endpoint in the relationship is given by an association role. The type of endpoints in the relationship should match the ones as defined in the corresponding association role specification. A relationship between entity specifications may be governed by conditions and rules which are addressed by constraint references in this resource. Constraints for a relationship may include new rules and conditions in addition to those defined for the corresponding association specification", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the association" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to this association" + }, + "id": { + "type": "string", + "description": "unique identifier of the association" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "The last modified date of this association object" + }, + "lifecycleStatus": { + "type": "string", + "description": "Indicates the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name given to this association" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which this association is valid" + }, + "version": { + "type": "string", + "description": "Version of this REST resource" + }, + "associationSpec": { + "$ref": "AssociationSpecRef.schema.json#AssociationSpecRef", + "description": "The specification of this association" + }, + "associationRole": { + "$ref": "AssociationRole.schema.json#AssociationRole", + "description": "The role of this association" + }, + "constraint": { + "description": "Any constraints in this association", + "type": "array", + "items": { + "$ref": "ConstraintRef.schema.json#ConstraintRef" + } + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/AssociationRole.schema.json b/Common/AssociationRole.schema.json index 6ebcddc4..cd534cab 100644 --- a/Common/AssociationRole.schema.json +++ b/Common/AssociationRole.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AssociationRole.schema.json", - "title": "AssociationRole", - "definitions": { - "AssociationRole": { - "$id": "#AssociationRole", - "description": "This embedded object represents the role and type of each entity involved in a relationship.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink reference to the endpoint plays this association role" - }, - "id": { - "type": "string", - "description": "The identifier of the endpoint plays this role" - }, - "isSource": { - "type": "boolean", - "description": "A flag indicating if the participant involved in a uni-directional relationship is the source or not. this flag is true If the association is bi-directional (both end points are navigable)" - }, - "name": { - "type": "string", - "description": "Name of the endpoint which plays this association role" - }, - "role": { - "type": "string", - "description": "The association role of this relationship participant as defined in the associationRoleSpec" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AssociationRole.schema.json", + "title": "AssociationRole", + "definitions": { + "AssociationRole": { + "$id": "#AssociationRole", + "description": "This embedded object represents the role and type of each entity involved in a relationship.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink reference to the endpoint plays this association role" + }, + "id": { + "type": "string", + "description": "The identifier of the endpoint plays this role" + }, + "isSource": { + "type": "boolean", + "description": "A flag indicating if the participant involved in a uni-directional relationship is the source or not. this flag is true If the association is bi-directional (both end points are navigable)" + }, + "name": { + "type": "string", + "description": "Name of the endpoint which plays this association role" + }, + "role": { + "type": "string", + "description": "The association role of this relationship participant as defined in the associationRoleSpec" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/AssociationRoleSpec.schema.json b/Common/AssociationRoleSpec.schema.json index b55790bd..40616e41 100644 --- a/Common/AssociationRoleSpec.schema.json +++ b/Common/AssociationRoleSpec.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AssociationRoleSpec.schema.json", - "title": "AssociationRoleSpec", - "definitions": { - "AssociationRoleSpec": { - "$id": "#AssociationRoleSpec", - "description": "This embedded object represents the role and type of each entity involved in a relationship.", - "type": "object", - "properties": { - "aggregation": { - "type": "string" - }, - "defaultQuantity": { - "type": "integer" - }, - "entityType": { - "type": "string" - }, - "isNavigable": { - "type": "boolean" - }, - "isSource": { - "type": "boolean" - }, - "maxQuantity": { - "type": "integer" - }, - "minQuantity": { - "type": "integer" - }, - "role": { - "type": "string" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AssociationRoleSpec.schema.json", + "title": "AssociationRoleSpec", + "definitions": { + "AssociationRoleSpec": { + "$id": "#AssociationRoleSpec", + "description": "This embedded object represents the role and type of each entity involved in a relationship.", + "type": "object", + "properties": { + "aggregation": { + "type": "string" + }, + "defaultQuantity": { + "type": "integer" + }, + "entityType": { + "type": "string" + }, + "isNavigable": { + "type": "boolean" + }, + "isSource": { + "type": "boolean" + }, + "maxQuantity": { + "type": "integer" + }, + "minQuantity": { + "type": "integer" + }, + "role": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/AssociationSpecRef.schema.json b/Common/AssociationSpecRef.schema.json index cc3fd459..92da747d 100644 --- a/Common/AssociationSpecRef.schema.json +++ b/Common/AssociationSpecRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AssociationSpecRef.schema.json", - "title": "AssociationSpecRef", - "definitions": { - "AssociationSpecRef": { - "$id": "#AssociationSpecRef", - "description": "reference to an AssociationSpecification object", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink reference to the target AssociationSpecification" - }, - "id": { - "type": "string", - "description": "reference id to the target AssociationSpecification" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AssociationSpecRef.schema.json", + "title": "AssociationSpecRef", + "definitions": { + "AssociationSpecRef": { + "$id": "#AssociationSpecRef", + "description": "reference to an AssociationSpecification object", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink reference to the target AssociationSpecification" + }, + "id": { + "type": "string", + "description": "reference id to the target AssociationSpecification" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/AssociationSpecification.schema.json b/Common/AssociationSpecification.schema.json index 855b281f..8ffa46be 100644 --- a/Common/AssociationSpecification.schema.json +++ b/Common/AssociationSpecification.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AssociationSpecification.schema.json", - "title": "AssociationSpecification", - "definitions": { - "AssociationSpecification": { - "$id": "#AssociationSpecification", - "description": "AssociationSpecification is an association class that describes a type of relationship between two entities. This is a generic construct that may be used to describe relationship types and roles. The role and type of each entity in the relationship is given by an association role specification. Two role specifications are embedded in the association specification.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the specification" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to this specification" - }, - "id": { - "type": "string", - "description": "unique identifier of the association specification" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "The last modified date of this specification" - }, - "lifecycleStatus": { - "type": "string", - "description": "Indicates the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name given to this association specification" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which this specification is valid" - }, - "version": { - "type": "string", - "description": "Version of this association" - }, - "constraint": { - "type": "array", - "items": { - "$ref": "ConstraintRef.schema.json#ConstraintRef" - } - }, - "associationRoleSpec": { - "$ref": "AssociationRoleSpec.schema.json#AssociationRoleSpec" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AssociationSpecification.schema.json", + "title": "AssociationSpecification", + "definitions": { + "AssociationSpecification": { + "$id": "#AssociationSpecification", + "description": "AssociationSpecification is an association class that describes a type of relationship between two entities. This is a generic construct that may be used to describe relationship types and roles. The role and type of each entity in the relationship is given by an association role specification. Two role specifications are embedded in the association specification.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the specification" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to this specification" + }, + "id": { + "type": "string", + "description": "unique identifier of the association specification" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "The last modified date of this specification" + }, + "lifecycleStatus": { + "type": "string", + "description": "Indicates the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name given to this association specification" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which this specification is valid" + }, + "version": { + "type": "string", + "description": "Version of this association" + }, + "constraint": { + "type": "array", + "items": { + "$ref": "ConstraintRef.schema.json#ConstraintRef" + } + }, + "associationRoleSpec": { + "$ref": "AssociationRoleSpec.schema.json#AssociationRoleSpec" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/Attachment.schema.json b/Common/Attachment.schema.json index 77182f4c..f81cca4e 100644 --- a/Common/Attachment.schema.json +++ b/Common/Attachment.schema.json @@ -1,80 +1,80 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Attachment.schema.json", - "title": "Attachment", - "definitions": { - "Attachment": { - "$id": "#Attachment", - "description": "Complements the description of an element (for instance a product) through video, pictures...", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for this particular attachment", - "examples": [ - "4aafacbd-11ff-4dc8-b445-305f2215715f", - "2334bc59-726e-4d34-ab96-f50e0561412f" - ] - }, - "href": { - "type": "string", - "format": "uri", - "description": "URI for this Attachment", - "examples": [ - "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f" - ] - }, - "name": { - "type": "string", - "description": "The name of the attachment" - }, - "description": { - "type": "string", - "description": "A narrative text describing the content of the attachment", - "examples": [ - "Photograph of the Product", - "Explanation Video" - ] - }, - "attachmentType": { - "type": "string", - "description": "Attachment type such as video, picture", - "examples": [ - "video", - "picture" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "Uniform Resource Locator, is a web page address (a subset of URI)", - "examples": [ - "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f" - ] - }, - "mimeType": { - "type": "string", - "description": "Attachment mime type such as extension file for video, picture and document" - }, - "content": { - "type": "string", - "format": "base64", - "description": "The actual contents of the attachment object, if embedded, encoded as base64" - }, - "size": { - "$ref": "Quantity.schema.json#Quantity", - "description": "The size of the attachment." - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period of time for which the attachment is valid" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Attachment.schema.json", + "title": "Attachment", + "definitions": { + "Attachment": { + "$id": "#Attachment", + "description": "Complements the description of an element (for instance a product) through video, pictures...", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for this particular attachment", + "examples": [ + "4aafacbd-11ff-4dc8-b445-305f2215715f", + "2334bc59-726e-4d34-ab96-f50e0561412f" + ] + }, + "href": { + "type": "string", + "format": "uri", + "description": "URI for this Attachment", + "examples": [ + "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f" + ] + }, + "name": { + "type": "string", + "description": "The name of the attachment" + }, + "description": { + "type": "string", + "description": "A narrative text describing the content of the attachment", + "examples": [ + "Photograph of the Product", + "Explanation Video" + ] + }, + "attachmentType": { + "type": "string", + "description": "Attachment type such as video, picture", + "examples": [ + "video", + "picture" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "Uniform Resource Locator, is a web page address (a subset of URI)", + "examples": [ + "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f" + ] + }, + "mimeType": { + "type": "string", + "description": "Attachment mime type such as extension file for video, picture and document" + }, + "content": { + "type": "string", + "format": "base64", + "description": "The actual contents of the attachment object, if embedded, encoded as base64" + }, + "size": { + "$ref": "Quantity.schema.json#Quantity", + "description": "The size of the attachment." + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period of time for which the attachment is valid" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/AttachmentRef.schema.json b/Common/AttachmentRef.schema.json index 475cfcaa..41c2f328 100644 --- a/Common/AttachmentRef.schema.json +++ b/Common/AttachmentRef.schema.json @@ -1,41 +1,41 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AttachmentRef.schema.json", - "title": "AttachmentRef", - "definitions": { - "AttachmentRef": { - "$id": "#AttachmentRef", - "description": "Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative text describing the content of the attachment" - }, - "href": { - "type": "string", - "description": "URL serving as reference for the attachment resource", - "format": "uri" - }, - "id": { - "description": "Unique-Identifier for this attachment", - "type": "string" - }, - "url": { - "description": "Link to the attachment media/content", - "type": "string", - "format": "uri" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AttachmentRef.schema.json", + "title": "AttachmentRef", + "definitions": { + "AttachmentRef": { + "$id": "#AttachmentRef", + "description": "Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative text describing the content of the attachment" + }, + "href": { + "type": "string", + "description": "URL serving as reference for the attachment resource", + "format": "uri" + }, + "id": { + "description": "Unique-Identifier for this attachment", + "type": "string" + }, + "url": { + "description": "Link to the attachment media/content", + "type": "string", + "format": "uri" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "EntityRef.schema.json#EntityRef" + } + ] } - }, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" - } - ] } - } } \ No newline at end of file diff --git a/Common/AttachmentRefOrValue.schema.json b/Common/AttachmentRefOrValue.schema.json index 8e45da53..3573f9e9 100644 --- a/Common/AttachmentRefOrValue.schema.json +++ b/Common/AttachmentRefOrValue.schema.json @@ -1,20 +1,20 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AttachmentRefOrValue.schema.json", - "title": "AttachmentRefOrValue", - "definitions": { - "AttachmentRefOrValue": { - "$id": "#AttachmentRefOrValue", - "type": "object", - "description": "An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and not to AttchmentRefOrValue itself", - "allOf": [ - { - "$ref": "AttachmentRef.schema.json#AttachmentRef" - }, - { - "$ref": "Attachment.schema.json#Attachment" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AttachmentRefOrValue.schema.json", + "title": "AttachmentRefOrValue", + "definitions": { + "AttachmentRefOrValue": { + "$id": "#AttachmentRefOrValue", + "type": "object", + "description": "An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and not to AttchmentRefOrValue itself", + "allOf": [ + { + "$ref": "AttachmentRef.schema.json#AttachmentRef" + }, + { + "$ref": "Attachment.schema.json#Attachment" + } + ] } - ] } - } } \ No newline at end of file diff --git a/Common/BaseEvent.schema.json b/Common/BaseEvent.schema.json index 0617c346..2c0ca7ac 100644 --- a/Common/BaseEvent.schema.json +++ b/Common/BaseEvent.schema.json @@ -1,65 +1,65 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BaseEvent.schema.json", - "title": "BaseEvent", - "definitions": { - "BaseEvent": { - "$id": "#BaseEvent", - "description": "Base event with common attributes.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Identifier of the Process flow" - }, - "href": { - "type": "string", - "description": "Reference of the ProcessFlow" - }, - "eventId": { - "type": "string", - "description": "The identifier of the notification." - }, - "eventTime": { - "type": "string", - "format": "date-time", - "description": "Time of the event occurrence." - }, - "eventType": { - "type": "string", - "description": "The type of the notification." - }, - "correlationId": { - "type": "string", - "description": "The correlation id for this event." - }, - "domain": { - "type": "string", - "description": "The domain of the event." - }, - "title": { - "type": "string", - "description": "The title of the event." - }, - "description": { - "type": "string", - "description": "An explnatory of the event." - }, - "priority": { - "type": "string", - "description": "A priority." - }, - "timeOcurred": { - "type": "string", - "format": "date-time", - "description": "The time the event occured." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BaseEvent.schema.json", + "title": "BaseEvent", + "definitions": { + "BaseEvent": { + "$id": "#BaseEvent", + "description": "Base event with common attributes.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the Process flow" + }, + "href": { + "type": "string", + "description": "Reference of the ProcessFlow" + }, + "eventId": { + "type": "string", + "description": "The identifier of the notification." + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "Time of the event occurrence." + }, + "eventType": { + "type": "string", + "description": "The type of the notification." + }, + "correlationId": { + "type": "string", + "description": "The correlation id for this event." + }, + "domain": { + "type": "string", + "description": "The domain of the event." + }, + "title": { + "type": "string", + "description": "The title of the event." + }, + "description": { + "type": "string", + "description": "An explnatory of the event." + }, + "priority": { + "type": "string", + "description": "A priority." + }, + "timeOcurred": { + "type": "string", + "format": "date-time", + "description": "The time the event occured." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/BasePlusEvent.schema.json b/Common/BasePlusEvent.schema.json index 73240532..a93e0ab9 100644 --- a/Common/BasePlusEvent.schema.json +++ b/Common/BasePlusEvent.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BasePlusEvent.schema.json", - "title": "BasePlusEvent", - "definitions": { - "BasePlusEvent": { - "$id": "#BasePlusEvent", - "description": "Base event with common attributes.", - "type": "object", - "properties": { - "eventId": { - "type": "string", - "description": "The identifier of the notification." - }, - "eventTime": { - "type": "string", - "format": "date-time", - "description": "Time of the event occurrence." - }, - "eventType": { - "type": "string", - "description": "The type of the notification." - }, - "correlationId": { - "type": "string", - "description": "The correlation id for this event." - }, - "domain": { - "type": "string", - "description": "The domain of the event." - }, - "title": { - "type": "string", - "description": "The title of the event." - }, - "description": { - "type": "string", - "description": "An explnatory of the event." - }, - "priority": { - "type": "string", - "description": "A priority." - }, - "timeOcurred": { - "type": "string", - "format": "date-time", - "description": "The time the event occured." - }, - "fieldPath": { - "type": "string", - "description": "The path identifying the object field concerned by this notification." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BasePlusEvent.schema.json", + "title": "BasePlusEvent", + "definitions": { + "BasePlusEvent": { + "$id": "#BasePlusEvent", + "description": "Base event with common attributes.", + "type": "object", + "properties": { + "eventId": { + "type": "string", + "description": "The identifier of the notification." + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "Time of the event occurrence." + }, + "eventType": { + "type": "string", + "description": "The type of the notification." + }, + "correlationId": { + "type": "string", + "description": "The correlation id for this event." + }, + "domain": { + "type": "string", + "description": "The domain of the event." + }, + "title": { + "type": "string", + "description": "The title of the event." + }, + "description": { + "type": "string", + "description": "An explnatory of the event." + }, + "priority": { + "type": "string", + "description": "A priority." + }, + "timeOcurred": { + "type": "string", + "format": "date-time", + "description": "The time the event occured." + }, + "fieldPath": { + "type": "string", + "description": "The path identifying the object field concerned by this notification." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/BusinessInteraction.schema.json b/Common/BusinessInteraction.schema.json index cee181ff..ff5093e0 100644 --- a/Common/BusinessInteraction.schema.json +++ b/Common/BusinessInteraction.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BusinessInteraction.schema.json", - "title": "BusinessInteraction", - "definitions": { - "BusinessInteraction": { - "$id": "#BusinessInteraction", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A description of this interaction" - }, - "id": { - "type": "string", - "description": "The unique ID for this interaction" - }, - "interactionData": { - "type": "string", - "format": "date-time" - }, - "interactionDataComplete": { - "type": "string", - "format": "date-time" - }, - "interactionDataStatus": { - "type": "string" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BusinessInteraction.schema.json", + "title": "BusinessInteraction", + "definitions": { + "BusinessInteraction": { + "$id": "#BusinessInteraction", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of this interaction" + }, + "id": { + "type": "string", + "description": "The unique ID for this interaction" + }, + "interactionData": { + "type": "string", + "format": "date-time" + }, + "interactionDataComplete": { + "type": "string", + "format": "date-time" + }, + "interactionDataStatus": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/CalendarEventRef.schema.json b/Common/CalendarEventRef.schema.json index f122814b..2b70302a 100644 --- a/Common/CalendarEventRef.schema.json +++ b/Common/CalendarEventRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CalendarEventRef.schema.json", - "title": "CalendarEventRef", - "definitions": { - "CalendarEventRef": { - "$id": "#CalendarEventRef", - "type": "object", - "description": "Reference of a CalendarEvent", - "properties": {}, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CalendarEventRef.schema.json", + "title": "CalendarEventRef", + "definitions": { + "CalendarEventRef": { + "$id": "#CalendarEventRef", + "type": "object", + "description": "Reference of a CalendarEvent", + "properties": {}, + "allOf": [ + { + "$ref": "EntityRef.schema.json#EntityRef" + } + ] } - ] } - } } \ No newline at end of file diff --git a/Common/CalendarPeriod.schema.json b/Common/CalendarPeriod.schema.json index ed3bc2e3..d4b0dfb0 100644 --- a/Common/CalendarPeriod.schema.json +++ b/Common/CalendarPeriod.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CalendarPeriod.schema.json", - "title": "CalendarPeriod", - "definitions": { - "CalendarPeriod": { - "$id": "#CalendarPeriod", - "type": "object", - "properties": { - "day": { - "type": "string", - "description": "Day where the calendar status applies (e.g.: monday, mon-to-fri, weekdays, weekend, all week, ...)" - }, - "status": { - "type": "string", - "description": "Indication of the availability of the site (e.g.: open)" - }, - "timeZone": { - "type": "string", - "description": "Indication of the timezone applicable to the calendar information (e.g.: Paris, GMT+1)" - }, - "hourPeriod": { - "type": "array", - "items": { - "$ref": "HourPeriod.schema.json#HourPeriod" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CalendarPeriod.schema.json", + "title": "CalendarPeriod", + "definitions": { + "CalendarPeriod": { + "$id": "#CalendarPeriod", + "type": "object", + "properties": { + "day": { + "type": "string", + "description": "Day where the calendar status applies (e.g.: monday, mon-to-fri, weekdays, weekend, all week, ...)" + }, + "status": { + "type": "string", + "description": "Indication of the availability of the site (e.g.: open)" + }, + "timeZone": { + "type": "string", + "description": "Indication of the timezone applicable to the calendar information (e.g.: Paris, GMT+1)" + }, + "hourPeriod": { + "type": "array", + "items": { + "$ref": "HourPeriod.schema.json#HourPeriod" + } + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/ChangeRequest.schema.json b/Common/ChangeRequest.schema.json index c0866d8e..f321a5d3 100644 --- a/Common/ChangeRequest.schema.json +++ b/Common/ChangeRequest.schema.json @@ -1,185 +1,185 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ChangeRequest.schema.json", - "title": "ChangeRequest", - "definitions": { - "ChangeRequest": { - "$id": "#ChangeRequest", - "description": "Change Request is a type of request which can be used for the management and control of Change Management \nprocess between a customer and a service provider or between a service provider and a partner and vice versa.", - "type": "object", - "properties": { - "actualEndTime": { - "type": "string", - "format": "date-time", - "description": "Date and time when the change implementation actually finished" - }, - "actualStartTime": { - "type": "string", - "format": "date-time", - "description": "Date and time when the change implementation actually started" - }, - "budget": { - "type": "string", - "description": "The budget reserved for the change" - }, - "channel": { - "type": "string", - "description": "A channel represents the way the Change Request was created" - }, - "completionDate": { - "type": "string", - "format": "date-time", - "description": "Date and time when the change request is confirmed to be completed" - }, - "currency": { - "type": "string", - "description": "The used currency related with cost" - }, - "description": { - "type": "string", - "description": "Description of the change request" - }, - "externalId": { - "type": "string", - "description": "ID given by the requestor to facilitate the relationship set up and subsequent searches" - }, - "href": { - "type": "string", - "description": "Hyperlink to access a change request" - }, - "id": { - "type": "string", - "description": "Identifier of a Change Request. It is created on repository side (a Change Management system)" - }, - "impact": { - "type": "string", - "description": "Indicates the impact of this change" - }, - "plannedEndTime": { - "type": "string", - "format": "date-time", - "description": "Date and time when the change implementation is planned to be finished" - }, - "plannedStartTime": { - "type": "string", - "format": "date-time", - "description": "Date and time when the change implementation is planned to be started" - }, - "priority": { - "type": "string", - "description": "Used by consumers to prioritize a change request in Change Management system" - }, - "requestDate": { - "type": "string", - "format": "date-time", - "description": "Date and time when the change request is raised" - }, - "requestType": { - "type": "string", - "description": "Indicates the type of the change request" - }, - "risk": { - "type": "string", - "description": "The risk to implement this change request" - }, - "riskMitigationPlan": { - "type": "string", - "description": "The risk mitigation plan" - }, - "riskValue": { - "type": "string", - "description": "The additional cost if the risk will happen" - }, - "scheduledDate": { - "type": "string", - "format": "date-time", - "description": "Date and time that the schedule is made" - }, - "status": { - "type": "string", - "description": "Status of the change request and its sub-state" - }, - "attachment": { - "type": "array", - "items": { - "$ref": "Attachment.schema.json#Attachment" - }, - "description": "The attachments of the communication message (when it is email type)" - }, - "workLog": { - "$ref": "WorkLog.schema.json#WorkLog" - }, - "incident": { - "type": "array", - "items": { - "$ref": "Incident.schema.json#Incident" - } - }, - "changeRequestSpecification": { - "$ref": "ChangeRequestSpecification.schema.json#ChangeRequestSpecification" - }, - "impactEntity": { - "type": "array", - "items": { - "$ref": "ImpactEntityRef.schema.json#ImpactEntityRef" - } - }, - "changeRequestCharacteristic": { - "type": "array", - "items": { - "$ref": "ChangeRequestCharacteristic.schema.json#ChangeRequestCharacteristic" - } - }, - "targetEntity": { - "type": "array", - "items": { - "$ref": "TargetEntityRef.schema.json#TargetEntityRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "description": "The parties involved in the change request" - }, - "resolution": { - "$ref": "Resolution.schema.json#Resolution" - }, - "sla": { - "type": "array", - "items": { - "$ref": "../EngagedParty/SLARef.schema.json#SLARef" - } - }, - "relateChangeRequest": { - "type": "array", - "items": { - "$ref": "RelatedChangeRequestRef.schema.json#RelatedChangeRequestRef" - } - }, - "category": { - "type": "array", - "items": { - "$ref": "../Product/CategoryRef.schema.json#CategoryRef" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "Note.schema.json#Note" - } - }, - "location": { - "$ref": "GeographicAddressRef.schema.json#GeographicAddressRef", - "description": "The place at which the change request occurred" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ChangeRequest.schema.json", + "title": "ChangeRequest", + "definitions": { + "ChangeRequest": { + "$id": "#ChangeRequest", + "description": "Change Request is a type of request which can be used for the management and control of Change Management \nprocess between a customer and a service provider or between a service provider and a partner and vice versa.", + "type": "object", + "properties": { + "actualEndTime": { + "type": "string", + "format": "date-time", + "description": "Date and time when the change implementation actually finished" + }, + "actualStartTime": { + "type": "string", + "format": "date-time", + "description": "Date and time when the change implementation actually started" + }, + "budget": { + "type": "string", + "description": "The budget reserved for the change" + }, + "channel": { + "type": "string", + "description": "A channel represents the way the Change Request was created" + }, + "completionDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the change request is confirmed to be completed" + }, + "currency": { + "type": "string", + "description": "The used currency related with cost" + }, + "description": { + "type": "string", + "description": "Description of the change request" + }, + "externalId": { + "type": "string", + "description": "ID given by the requestor to facilitate the relationship set up and subsequent searches" + }, + "href": { + "type": "string", + "description": "Hyperlink to access a change request" + }, + "id": { + "type": "string", + "description": "Identifier of a Change Request. It is created on repository side (a Change Management system)" + }, + "impact": { + "type": "string", + "description": "Indicates the impact of this change" + }, + "plannedEndTime": { + "type": "string", + "format": "date-time", + "description": "Date and time when the change implementation is planned to be finished" + }, + "plannedStartTime": { + "type": "string", + "format": "date-time", + "description": "Date and time when the change implementation is planned to be started" + }, + "priority": { + "type": "string", + "description": "Used by consumers to prioritize a change request in Change Management system" + }, + "requestDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the change request is raised" + }, + "requestType": { + "type": "string", + "description": "Indicates the type of the change request" + }, + "risk": { + "type": "string", + "description": "The risk to implement this change request" + }, + "riskMitigationPlan": { + "type": "string", + "description": "The risk mitigation plan" + }, + "riskValue": { + "type": "string", + "description": "The additional cost if the risk will happen" + }, + "scheduledDate": { + "type": "string", + "format": "date-time", + "description": "Date and time that the schedule is made" + }, + "status": { + "type": "string", + "description": "Status of the change request and its sub-state" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "Attachment.schema.json#Attachment" + }, + "description": "The attachments of the communication message (when it is email type)" + }, + "workLog": { + "$ref": "WorkLog.schema.json#WorkLog" + }, + "incident": { + "type": "array", + "items": { + "$ref": "Incident.schema.json#Incident" + } + }, + "changeRequestSpecification": { + "$ref": "ChangeRequestSpecification.schema.json#ChangeRequestSpecification" + }, + "impactEntity": { + "type": "array", + "items": { + "$ref": "ImpactEntityRef.schema.json#ImpactEntityRef" + } + }, + "changeRequestCharacteristic": { + "type": "array", + "items": { + "$ref": "ChangeRequestCharacteristic.schema.json#ChangeRequestCharacteristic" + } + }, + "targetEntity": { + "type": "array", + "items": { + "$ref": "TargetEntityRef.schema.json#TargetEntityRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "The parties involved in the change request" + }, + "resolution": { + "$ref": "Resolution.schema.json#Resolution" + }, + "sla": { + "type": "array", + "items": { + "$ref": "../EngagedParty/SLARef.schema.json#SLARef" + } + }, + "relateChangeRequest": { + "type": "array", + "items": { + "$ref": "RelatedChangeRequestRef.schema.json#RelatedChangeRequestRef" + } + }, + "category": { + "type": "array", + "items": { + "$ref": "../Product/CategoryRef.schema.json#CategoryRef" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "Note.schema.json#Note" + } + }, + "location": { + "$ref": "GeographicAddressRef.schema.json#GeographicAddressRef", + "description": "The place at which the change request occurred" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/ChangeRequestCharacteristic.schema.json b/Common/ChangeRequestCharacteristic.schema.json index 708ab679..95e28735 100644 --- a/Common/ChangeRequestCharacteristic.schema.json +++ b/Common/ChangeRequestCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ChangeRequestCharacteristic.schema.json", - "title": "ChangeRequestCharacteristic", - "definitions": { - "ChangeRequestCharacteristic": { - "$id": "#ChangeRequestCharacteristic", - "description": "Characteristics of the change request to instantiate or to modify", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic." - }, - "value": { - "type": "string", - "description": "Value of the characteristic." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ChangeRequestCharacteristic.schema.json", + "title": "ChangeRequestCharacteristic", + "definitions": { + "ChangeRequestCharacteristic": { + "$id": "#ChangeRequestCharacteristic", + "description": "Characteristics of the change request to instantiate or to modify", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic." + }, + "value": { + "type": "string", + "description": "Value of the characteristic." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/ChangeRequestRef.schema.json b/Common/ChangeRequestRef.schema.json index 6d3bd1ea..8a41186d 100644 --- a/Common/ChangeRequestRef.schema.json +++ b/Common/ChangeRequestRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ChangeRequestRef.schema.json", - "title": "ChangeRequestRef", - "definitions": { - "ChangeRequestRef": { - "$id": "#ChangeRequestRef", - "type": "object", - "description": "Reference to a Change Request", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "href": { - "type": "string", - "description": "The reference link to the change request" - }, - "id": { - "type": "string", - "description": "The identifier of the change request" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ChangeRequestRef.schema.json", + "title": "ChangeRequestRef", + "definitions": { + "ChangeRequestRef": { + "$id": "#ChangeRequestRef", + "type": "object", + "description": "Reference to a Change Request", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "href": { + "type": "string", + "description": "The reference link to the change request" + }, + "id": { + "type": "string", + "description": "The identifier of the change request" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/ChangeRequestSpecification.schema.json b/Common/ChangeRequestSpecification.schema.json index d20a4d5a..eb74264c 100644 --- a/Common/ChangeRequestSpecification.schema.json +++ b/Common/ChangeRequestSpecification.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ChangeRequestSpecification.schema.json", - "title": "ChangeRequestSpecification", - "definitions": { - "ChangeRequestSpecification": { - "$id": "#ChangeRequestSpecification", - "description": "Defines a set of attributes related to Change Request.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the specification" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the specification." - }, - "id": { - "type": "string", - "description": "Identifier of the specification." - }, - "name": { - "type": "string", - "description": "Name of the specification." - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ChangeRequestSpecification.schema.json", + "title": "ChangeRequestSpecification", + "definitions": { + "ChangeRequestSpecification": { + "$id": "#ChangeRequestSpecification", + "description": "Defines a set of attributes related to Change Request.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the specification" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the specification." + }, + "id": { + "type": "string", + "description": "Identifier of the specification." + }, + "name": { + "type": "string", + "description": "Name of the specification." + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/Channel.schema.json b/Common/Channel.schema.json index 4a87ebd0..131659f0 100755 --- a/Common/Channel.schema.json +++ b/Common/Channel.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Channel.schema.json", - "title": "Channel", - "definitions": { - "Channel": { - "$id": "#Channel", - "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the channel" - }, - "id": { - "type": "string", - "description": "Unique identifier of the channel" - }, - "name": { - "type": "string", - "description": "Name of the channel" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Channel.schema.json", + "title": "Channel", + "definitions": { + "Channel": { + "$id": "#Channel", + "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the channel" + }, + "id": { + "type": "string", + "description": "Unique identifier of the channel" + }, + "name": { + "type": "string", + "description": "Name of the channel" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/ChannelRef.schema.json b/Common/ChannelRef.schema.json index 73ab4876..6547487a 100644 --- a/Common/ChannelRef.schema.json +++ b/Common/ChannelRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ChannelRef.schema.json", - "title": "ChannelRef", - "definitions": { - "ChannelRef": { - "$id": "#ChannelRef", - "type": "object", - "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..", - "properties": { - "name": { - "type": "string", - "description": "Name of the channel." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ChannelRef.schema.json", + "title": "ChannelRef", + "definitions": { + "ChannelRef": { + "$id": "#ChannelRef", + "type": "object", + "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..", + "properties": { + "name": { + "type": "string", + "description": "Name of the channel." + } + }, + "allOf": [ + { + "$ref": "EntityRef.schema.json#EntityRef" + } + ] } - }, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" - } - ] } - } } \ No newline at end of file diff --git a/Common/Characteristic.schema.json b/Common/Characteristic.schema.json index a92a19f7..411c7d76 100644 --- a/Common/Characteristic.schema.json +++ b/Common/Characteristic.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Characteristic.schema.json", - "title": "Characteristic", - "definitions": { - "Characteristic": { - "$id": "#Characteristic", - "description": "Describes a given characteristic of an object or entity through a name/value pair.", - "type": "object", - "required": [ - "name", - "value" - ], - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "valueType": { - "type": "string", - "description": "Data type of the value of the characteristic" - }, - "value": { - "$ref": "Any.schema.json#Any", - "description": "The value of the characteristic" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Characteristic.schema.json", + "title": "Characteristic", + "definitions": { + "Characteristic": { + "$id": "#Characteristic", + "description": "Describes a given characteristic of an object or entity through a name/value pair.", + "type": "object", + "required": [ + "name", + "value" + ], + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "valueType": { + "type": "string", + "description": "Data type of the value of the characteristic" + }, + "value": { + "$ref": "Any.schema.json#Any", + "description": "The value of the characteristic" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/CommonComponents.schema.json b/Common/CommonComponents.schema.json index 27925062..8df17fe3 100644 --- a/Common/CommonComponents.schema.json +++ b/Common/CommonComponents.schema.json @@ -1,44 +1,44 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CommonComponents.json", - "title": "CommonComponents", - "description": "Highly reusable schema fragments for use in TMForum Open-APIs", - "definitions": { - "polymorphicPattern": { - "$id": "#polymorphicPattern", - "type": "object", - "properties": { - "@schemaLocation": { - "type": "string", - "format": "uri", - "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", - "examples": [ - "http://host/schemas/Subclass.schema.json" - ] - }, - "@baseType": { - "type": "string", - "description": "When sub-classing, this defines the super-class", - "examples": [ - "Place", - "ServiceSpecification" - ] - }, - "@type": { - "type": "string", - "description": "When sub-classing, this defines the sub-class entity name", - "examples": [ - "VendorProductOffering", - "DroneServiceSpecification" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CommonComponents.json", + "title": "CommonComponents", + "description": "Highly reusable schema fragments for use in TMForum Open-APIs", + "definitions": { + "polymorphicPattern": { + "$id": "#polymorphicPattern", + "type": "object", + "properties": { + "@schemaLocation": { + "type": "string", + "format": "uri", + "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", + "examples": [ + "http://host/schemas/Subclass.schema.json" + ] + }, + "@baseType": { + "type": "string", + "description": "When sub-classing, this defines the super-class", + "examples": [ + "Place", + "ServiceSpecification" + ] + }, + "@type": { + "type": "string", + "description": "When sub-classing, this defines the sub-class entity name", + "examples": [ + "VendorProductOffering", + "DroneServiceSpecification" + ] + } + }, + "dependencies": { + "@schemaLocation": [ + "@baseType", + "@type" + ] + } } - }, - "dependencies": { - "@schemaLocation": [ - "@baseType", - "@type" - ] - } } - } } \ No newline at end of file diff --git a/Common/CommunicationMessage.schema.json b/Common/CommunicationMessage.schema.json index 53356dbc..c5d448fb 100644 --- a/Common/CommunicationMessage.schema.json +++ b/Common/CommunicationMessage.schema.json @@ -1,97 +1,97 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CommunicationMessage.schema.json", - "title": "CommunicationMessage", - "definitions": { - "CommunicationMessage": { - "$id": "#CommunicationMessage", - "description": "Communication message means a notification approach in the format of a message which can be dispatched (sent) to the certain user by the system with the content which can be felt and understood by the recipient. The user can be either a final customer or a customer service agent. The message can reach the customer in different interaction channels, including: email, short message, mobile app notification (push).", - "type": "object", - "properties": { - "callbackFlag": { - "type": "boolean", - "description": "Do you want a callback on delivery of communication message?" - }, - "content": { - "type": "string", - "description": "The content of the communication message" - }, - "description": { - "type": "string", - "description": "Description for the whole object" - }, - "href": { - "type": "string", - "description": "Hypertext Reference of the Communication Message" - }, - "id": { - "type": "string", - "description": "Unique identifier of Communication Message" - }, - "logFlag": { - "type": "boolean" - }, - "priority": { - "type": "string", - "description": "The priority of the communication message.\nSmall number means higher priority." - }, - "sendTime": { - "type": "string", - "format": "date-time", - "description": "The time of sending communication message" - }, - "sendTimeComplete": { - "type": "string", - "format": "date-time", - "description": "The time of completion of sending communication message" - }, - "status": { - "type": "string", - "description": "Status of communication message" - }, - "subject": { - "type": "string", - "description": "The title of the message, necessary for the email and mobile app push" - }, - "tryTimes": { - "type": "integer", - "description": "How many times do you want to retry the delivery of this message?" - }, - "messageType": { - "type": "string", - "description": "The type of message, such as: SMS, Email, Mobile app push notification" - }, - "attachment": { - "type": "array", - "description": "Any attachment associated with this message", - "items": { - "$ref": "Attachment.schema.json#Attachment" - } - }, - "receiver": { - "type": "array", - "description": "The receiver(s) of this message", - "items": { - "$ref": "Receiver.schema.json#Receiver" - } - }, - "sender": { - "$ref": "Sender.schema.json#Sender", - "description": "The sender of this message" - }, - "characteristic": { - "type": "array", - "description": "Any additional characteristic(s) of this message", - "items": { - "$ref": "CommunicationRequestCharacteristic.schema.json#CommunicationRequestCharacteristic" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CommunicationMessage.schema.json", + "title": "CommunicationMessage", + "definitions": { + "CommunicationMessage": { + "$id": "#CommunicationMessage", + "description": "Communication message means a notification approach in the format of a message which can be dispatched (sent) to the certain user by the system with the content which can be felt and understood by the recipient. The user can be either a final customer or a customer service agent. The message can reach the customer in different interaction channels, including: email, short message, mobile app notification (push).", + "type": "object", + "properties": { + "callbackFlag": { + "type": "boolean", + "description": "Do you want a callback on delivery of communication message?" + }, + "content": { + "type": "string", + "description": "The content of the communication message" + }, + "description": { + "type": "string", + "description": "Description for the whole object" + }, + "href": { + "type": "string", + "description": "Hypertext Reference of the Communication Message" + }, + "id": { + "type": "string", + "description": "Unique identifier of Communication Message" + }, + "logFlag": { + "type": "boolean" + }, + "priority": { + "type": "string", + "description": "The priority of the communication message.\nSmall number means higher priority." + }, + "sendTime": { + "type": "string", + "format": "date-time", + "description": "The time of sending communication message" + }, + "sendTimeComplete": { + "type": "string", + "format": "date-time", + "description": "The time of completion of sending communication message" + }, + "status": { + "type": "string", + "description": "Status of communication message" + }, + "subject": { + "type": "string", + "description": "The title of the message, necessary for the email and mobile app push" + }, + "tryTimes": { + "type": "integer", + "description": "How many times do you want to retry the delivery of this message?" + }, + "messageType": { + "type": "string", + "description": "The type of message, such as: SMS, Email, Mobile app push notification" + }, + "attachment": { + "type": "array", + "description": "Any attachment associated with this message", + "items": { + "$ref": "Attachment.schema.json#Attachment" + } + }, + "receiver": { + "type": "array", + "description": "The receiver(s) of this message", + "items": { + "$ref": "Receiver.schema.json#Receiver" + } + }, + "sender": { + "$ref": "Sender.schema.json#Sender", + "description": "The sender of this message" + }, + "characteristic": { + "type": "array", + "description": "Any additional characteristic(s) of this message", + "items": { + "$ref": "CommunicationRequestCharacteristic.schema.json#CommunicationRequestCharacteristic" + } + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/CommunicationRequestCharacteristic.schema.json b/Common/CommunicationRequestCharacteristic.schema.json index 5cb0633d..79766c37 100644 --- a/Common/CommunicationRequestCharacteristic.schema.json +++ b/Common/CommunicationRequestCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CommunicationRequestCharacteristic.schema.json", - "title": "CommunicationRequestCharacteristic", - "definitions": { - "CommunicationRequestCharacteristic": { - "$id": "#CommunicationRequestCharacteristic", - "description": "The values of parameters which are used in the content if the content contains them.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Content parameter identifier" - }, - "value": { - "type": "string", - "description": "Content parameter value" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CommunicationRequestCharacteristic.schema.json", + "title": "CommunicationRequestCharacteristic", + "definitions": { + "CommunicationRequestCharacteristic": { + "$id": "#CommunicationRequestCharacteristic", + "description": "The values of parameters which are used in the content if the content contains them.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Content parameter identifier" + }, + "value": { + "type": "string", + "description": "Content parameter value" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/ConstraintRef.schema.json b/Common/ConstraintRef.schema.json index 2a2be543..5fabbf0a 100644 --- a/Common/ConstraintRef.schema.json +++ b/Common/ConstraintRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ConstraintRef.schema.json", - "title": "ConstraintRef", - "definitions": { - "ConstraintRef": { - "$id": "#ConstraintRef", - "type": "object", - "description": "Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.", - "properties": { - "@referredType": { - "type": "string", - "description": "The (class) type of the referred constraint" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to the target constraint" - }, - "id": { - "type": "string", - "description": "reference id to the target constraint" - }, - "name": { - "type": "string", - "description": "Name given to the constraint" - }, - "version": { - "type": "string", - "description": "constraint version" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ConstraintRef.schema.json", + "title": "ConstraintRef", + "definitions": { + "ConstraintRef": { + "$id": "#ConstraintRef", + "type": "object", + "description": "Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.", + "properties": { + "@referredType": { + "type": "string", + "description": "The (class) type of the referred constraint" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to the target constraint" + }, + "id": { + "type": "string", + "description": "reference id to the target constraint" + }, + "name": { + "type": "string", + "description": "Name given to the constraint" + }, + "version": { + "type": "string", + "description": "constraint version" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/ContactMedium.schema.json b/Common/ContactMedium.schema.json index ff799c11..c1318dc0 100644 --- a/Common/ContactMedium.schema.json +++ b/Common/ContactMedium.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ContactMedium.schema.json", - "title": "ContactMedium", - "definitions": { - "ContactMedium": { - "$id": "#ContactMedium", - "description": "Indicates the contact medium that could be used to contact the party.", - "type": "object", - "properties": { - "preferred": { - "type": "boolean", - "description": "If true, indicates that is the preferred contact medium" - }, - "mediumType": { - "type": "string", - "description": "Type of the contact medium, such as: email address, telephone number, postal address" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The time period that the contact medium is valid for" - }, - "characteristic": { - "$ref": "MediumCharacteristic.schema.json#MediumCharacteristic", - "description": "Any additional characteristic(s) of this contact medium" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ContactMedium.schema.json", + "title": "ContactMedium", + "definitions": { + "ContactMedium": { + "$id": "#ContactMedium", + "description": "Indicates the contact medium that could be used to contact the party.", + "type": "object", + "properties": { + "preferred": { + "type": "boolean", + "description": "If true, indicates that is the preferred contact medium" + }, + "mediumType": { + "type": "string", + "description": "Type of the contact medium, such as: email address, telephone number, postal address" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The time period that the contact medium is valid for" + }, + "characteristic": { + "$ref": "MediumCharacteristic.schema.json#MediumCharacteristic", + "description": "Any additional characteristic(s) of this contact medium" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/Document.schema.json b/Common/Document.schema.json index 47fdacdd..429ee1d3 100644 --- a/Common/Document.schema.json +++ b/Common/Document.schema.json @@ -1,97 +1,97 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Document.schema.json", - "title": "Document", - "definitions": { - "Document": { - "$id": "#Document", - "description": "Document is a tangible output from an activity", - "type": "object", - "properties": { - "creationDate": { - "type": "string", - "format": "date-time", - "description": "The date and time the document was created. A date and time formatted in compliance with the ISO8601 standard must be used." - }, - "description": { - "type": "string", - "description": "Free-text description of the document" - }, - "href": { - "type": "string", - "format": "uri", - "description": "The URI for the object itself" - }, - "id": { - "type": "string", - "description": "Identifier of an instance of the document. Required to be unique within the document type. Used in URIs as the identifier for specific instances of a type." - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "The date and time the document was last modified. A date and time formatted in compliance with the ISO8601 standard must be used." - }, - "lifecycleState": { - "type": "string", - "description": "The life cycle state of the document" - }, - "name": { - "type": "string", - "description": "A string used to give a name to the document" - }, - "documentType": { - "type": "string", - "description": "The specific type of this document" - }, - "version": { - "type": "string", - "description": "A particular form or variety of an artefact that is different from others or from the original. The form represents differences in properties that characterize an artefact, that are not enough to warrant creating a new artefact" - }, - "characteristic": { - "type": "array", - "description": "Any additional characteristic(s) specific to this Document", - "items": { - "$ref": "DocumentCharacteristic.schema.json#DocumentCharacteristic" - } - }, - "relatedParty": { - "type": "array", - "description": "Any Parties related to this Document (eg: author)", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "documentSpecification": { - "description": "The specification or this Document", - "$ref": "DocumentSpecification.schema.json#DocumentSpecification" - }, - "binaryAttachment": { - "type": "array", - "items": { - "$ref": "DocumentAttachment.schema.json#DocumentAttachment" - } - }, - "category": { - "type": "array", - "items": { - "$ref": "../Product/CategoryRef.schema.json#CategoryRef" - } - }, - "documentRelationship": { - "type": "array", - "items": { - "$ref": "DocumentRelationship.schema.json#DocumentRelationship" - } - }, - "relatedObject": { - "$ref": "RelatedObject.schema.json#RelatedObject" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Document.schema.json", + "title": "Document", + "definitions": { + "Document": { + "$id": "#Document", + "description": "Document is a tangible output from an activity", + "type": "object", + "properties": { + "creationDate": { + "type": "string", + "format": "date-time", + "description": "The date and time the document was created. A date and time formatted in compliance with the ISO8601 standard must be used." + }, + "description": { + "type": "string", + "description": "Free-text description of the document" + }, + "href": { + "type": "string", + "format": "uri", + "description": "The URI for the object itself" + }, + "id": { + "type": "string", + "description": "Identifier of an instance of the document. Required to be unique within the document type. Used in URIs as the identifier for specific instances of a type." + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "The date and time the document was last modified. A date and time formatted in compliance with the ISO8601 standard must be used." + }, + "lifecycleState": { + "type": "string", + "description": "The life cycle state of the document" + }, + "name": { + "type": "string", + "description": "A string used to give a name to the document" + }, + "documentType": { + "type": "string", + "description": "The specific type of this document" + }, + "version": { + "type": "string", + "description": "A particular form or variety of an artefact that is different from others or from the original. The form represents differences in properties that characterize an artefact, that are not enough to warrant creating a new artefact" + }, + "characteristic": { + "type": "array", + "description": "Any additional characteristic(s) specific to this Document", + "items": { + "$ref": "DocumentCharacteristic.schema.json#DocumentCharacteristic" + } + }, + "relatedParty": { + "type": "array", + "description": "Any Parties related to this Document (eg: author)", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "documentSpecification": { + "description": "The specification or this Document", + "$ref": "DocumentSpecification.schema.json#DocumentSpecification" + }, + "binaryAttachment": { + "type": "array", + "items": { + "$ref": "DocumentAttachment.schema.json#DocumentAttachment" + } + }, + "category": { + "type": "array", + "items": { + "$ref": "../Product/CategoryRef.schema.json#CategoryRef" + } + }, + "documentRelationship": { + "type": "array", + "items": { + "$ref": "DocumentRelationship.schema.json#DocumentRelationship" + } + }, + "relatedObject": { + "$ref": "RelatedObject.schema.json#RelatedObject" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/DocumentAttachment.schema.json b/Common/DocumentAttachment.schema.json index 2a799b39..5cafa1d8 100644 --- a/Common/DocumentAttachment.schema.json +++ b/Common/DocumentAttachment.schema.json @@ -1,56 +1,56 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DocumentAttachment.schema.json", - "title": "DocumentAttachment", - "definitions": { - "DocumentAttachment": { - "$id": "#DocumentAttachment", - "description": "Attachment refers to extensions or additional parts that is or may be attached to something (agreements, contracts, appointments) to perform a particular function. They can be communication attachments, documents and other.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description of the binary attachment" - }, - "id": { - "type": "string", - "description": "Identifier of the binary attachment" - }, - "mimeType": { - "type": "string", - "description": "mimeType of the Attachment, such as: application/pdf" - }, - "name": { - "type": "string", - "description": "Name of the binary attachment" - }, - "size": { - "type": "integer", - "description": "The size of the document or attachment. If this component contains the embedded data then the size is the size of the embedded data; if it is a reference without the data then it is the size of the referenced document" - }, - "sizeUnit": { - "type": "string", - "description": "The unit of measure for the size" - }, - "attachmentType": { - "type": "string", - "description": "Identifies the sub-type of the instance of binary attachment" - }, - "URL": { - "type": "string", - "format": "uri", - "description": "URL of the Attachment" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "Validity period of the Attachment" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DocumentAttachment.schema.json", + "title": "DocumentAttachment", + "definitions": { + "DocumentAttachment": { + "$id": "#DocumentAttachment", + "description": "Attachment refers to extensions or additional parts that is or may be attached to something (agreements, contracts, appointments) to perform a particular function. They can be communication attachments, documents and other.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of the binary attachment" + }, + "id": { + "type": "string", + "description": "Identifier of the binary attachment" + }, + "mimeType": { + "type": "string", + "description": "mimeType of the Attachment, such as: application/pdf" + }, + "name": { + "type": "string", + "description": "Name of the binary attachment" + }, + "size": { + "type": "integer", + "description": "The size of the document or attachment. If this component contains the embedded data then the size is the size of the embedded data; if it is a reference without the data then it is the size of the referenced document" + }, + "sizeUnit": { + "type": "string", + "description": "The unit of measure for the size" + }, + "attachmentType": { + "type": "string", + "description": "Identifies the sub-type of the instance of binary attachment" + }, + "URL": { + "type": "string", + "format": "uri", + "description": "URL of the Attachment" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "Validity period of the Attachment" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/DocumentCharacteristic.schema.json b/Common/DocumentCharacteristic.schema.json index c962d3f1..95cd4dab 100644 --- a/Common/DocumentCharacteristic.schema.json +++ b/Common/DocumentCharacteristic.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DocumentCharacteristic.schema.json", - "title": "DocumentCharacteristic", - "definitions": { - "DocumentCharacteristic": { - "$id": "#DocumentCharacteristic", - "description": "is a list of name value pairs that define the document characteristics.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "name of the characteristic" - }, - "value": { - "type": "string" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DocumentCharacteristic.schema.json", + "title": "DocumentCharacteristic", + "definitions": { + "DocumentCharacteristic": { + "$id": "#DocumentCharacteristic", + "description": "is a list of name value pairs that define the document characteristics.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "name of the characteristic" + }, + "value": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/DocumentRef.schema.json b/Common/DocumentRef.schema.json index 5c885a70..8325c1b0 100644 --- a/Common/DocumentRef.schema.json +++ b/Common/DocumentRef.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DocumentRef.schema.json", - "title": "DocumentRef", - "definitions": { - "DocumentRef": { - "$id": "#DocumentRef", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URI for the object itself." - }, - "id": { - "type": "string", - "description": "Identifier of the document" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DocumentRef.schema.json", + "title": "DocumentRef", + "definitions": { + "DocumentRef": { + "$id": "#DocumentRef", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URI for the object itself." + }, + "id": { + "type": "string", + "description": "Identifier of the document" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/DocumentRelationship.schema.json b/Common/DocumentRelationship.schema.json index 2c118cfa..6ee3c148 100644 --- a/Common/DocumentRelationship.schema.json +++ b/Common/DocumentRelationship.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DocumentRelationship.schema.json", - "title": "DocumentRelationship", - "definitions": { - "DocumentRelationship": { - "$id": "#DocumentRelationship", - "description": "Another document that is related to the current document;", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "The type of relationship" - }, - "documentRef": { - "$ref": "DocumentRef.schema.json#DocumentRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DocumentRelationship.schema.json", + "title": "DocumentRelationship", + "definitions": { + "DocumentRelationship": { + "$id": "#DocumentRelationship", + "description": "Another document that is related to the current document;", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of relationship" + }, + "documentRef": { + "$ref": "DocumentRef.schema.json#DocumentRef" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/DocumentSpecification.schema.json b/Common/DocumentSpecification.schema.json index fd1df4c4..08d7a27a 100644 --- a/Common/DocumentSpecification.schema.json +++ b/Common/DocumentSpecification.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DocumentSpecification.schema.json", - "title": "DocumentSpecification", - "definitions": { - "DocumentSpecification": { - "$id": "#DocumentSpecification", - "description": "A document specification reference", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URI for the object itself." - }, - "id": { - "type": "string", - "description": "Identifier of the DocumentSpecification" - }, - "name": { - "type": "string", - "description": "a String. Name of the DocumentSpecification" - }, - "URL": { - "type": "string", - "format": "uri", - "description": "URL of the Document Specification" - }, - "version": { - "type": "string", - "description": "A string, a version of the DocumentSpecification." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DocumentSpecification.schema.json", + "title": "DocumentSpecification", + "definitions": { + "DocumentSpecification": { + "$id": "#DocumentSpecification", + "description": "A document specification reference", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URI for the object itself." + }, + "id": { + "type": "string", + "description": "Identifier of the DocumentSpecification" + }, + "name": { + "type": "string", + "description": "a String. Name of the DocumentSpecification" + }, + "URL": { + "type": "string", + "format": "uri", + "description": "URL of the Document Specification" + }, + "version": { + "type": "string", + "description": "A string, a version of the DocumentSpecification." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/Duration.schema.json b/Common/Duration.schema.json index 13823d25..ed45f0fa 100644 --- a/Common/Duration.schema.json +++ b/Common/Duration.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Duration.schema.json", - "title": "Duration", - "definitions": { - "Duration": { - "$id": "#Duration", - "type": "object", - "description": "A time interval in a given unit of time", - "properties": { - "amount": { - "type": "integer", - "description": "Time interval (number of seconds, minutes, hours, etc.)" - }, - "units": { - "type": "string", - "description": "Unit of time (seconds, minutes, hours, etc.)" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Duration.schema.json", + "title": "Duration", + "definitions": { + "Duration": { + "$id": "#Duration", + "type": "object", + "description": "A time interval in a given unit of time", + "properties": { + "amount": { + "type": "integer", + "description": "Time interval (number of seconds, minutes, hours, etc.)" + }, + "units": { + "type": "string", + "description": "Unit of time (seconds, minutes, hours, etc.)" + } + } } - } } - } } \ No newline at end of file diff --git a/Common/Entity.schema.json b/Common/Entity.schema.json index 1a03c6cd..d3d44081 100644 --- a/Common/Entity.schema.json +++ b/Common/Entity.schema.json @@ -1,45 +1,45 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Entity.schema.json", - "title": "Entity", - "definitions": { - "Entity": { - "$id": "#Entity", - "type": "object", - "description": "Base entity schema for use in TMForum Open-APIs", - "discriminator": "@type", - "properties": { - "@schemaLocation": { - "type": "string", - "format": "uri", - "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", - "examples": [ - "http://host/schemas/Subclass.schema.json" - ] - }, - "@baseType": { - "type": "string", - "description": "When sub-classing, this defines the super-class", - "examples": [ - "Place", - "ServiceSpecification" - ] - }, - "@type": { - "type": "string", - "description": "When sub-classing, this defines the sub-class entity name", - "examples": [ - "VendorProductOffering", - "DroneServiceSpecification" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Entity.schema.json", + "title": "Entity", + "definitions": { + "Entity": { + "$id": "#Entity", + "type": "object", + "description": "Base entity schema for use in TMForum Open-APIs", + "discriminator": "@type", + "properties": { + "@schemaLocation": { + "type": "string", + "format": "uri", + "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", + "examples": [ + "http://host/schemas/Subclass.schema.json" + ] + }, + "@baseType": { + "type": "string", + "description": "When sub-classing, this defines the super-class", + "examples": [ + "Place", + "ServiceSpecification" + ] + }, + "@type": { + "type": "string", + "description": "When sub-classing, this defines the sub-class entity name", + "examples": [ + "VendorProductOffering", + "DroneServiceSpecification" + ] + } + }, + "dependencies": { + "@schemaLocation": [ + "@baseType", + "@type" + ] + } } - }, - "dependencies": { - "@schemaLocation": [ - "@baseType", - "@type" - ] - } } - } } \ No newline at end of file diff --git a/Common/EntityAttachment.schema.json b/Common/EntityAttachment.schema.json index 17787e6a..5714b6c0 100644 --- a/Common/EntityAttachment.schema.json +++ b/Common/EntityAttachment.schema.json @@ -1,48 +1,48 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntityAttachment.schema.json", - "title": "EntityAttachment", - "definitions": { - "EntityAttachment": { - "$id": "#EntityAttachment", - "description": "Complements the description of an entity through video, pictures...", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative text describing the content of the attachment" - }, - "href": { - "type": "string", - "description": "Reference of the attachment" - }, - "id": { - "type": "string", - "description": "Unique identifier of the attachment" - }, - "mimeType": { - "type": "string", - "description": "Attachment mime type such as extension file for video, picture and document" - }, - "name": { - "type": "string", - "description": "name given to the attachment" - }, - "uri": { - "type": "string", - "format": "uri", - "description": "Uniform Resource Identifier (URI) of the attachment" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which this attachment is valid" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntityAttachment.schema.json", + "title": "EntityAttachment", + "definitions": { + "EntityAttachment": { + "$id": "#EntityAttachment", + "description": "Complements the description of an entity through video, pictures...", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative text describing the content of the attachment" + }, + "href": { + "type": "string", + "description": "Reference of the attachment" + }, + "id": { + "type": "string", + "description": "Unique identifier of the attachment" + }, + "mimeType": { + "type": "string", + "description": "Attachment mime type such as extension file for video, picture and document" + }, + "name": { + "type": "string", + "description": "name given to the attachment" + }, + "uri": { + "type": "string", + "format": "uri", + "description": "Uniform Resource Identifier (URI) of the attachment" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which this attachment is valid" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/EntityCatalog.schema.json b/Common/EntityCatalog.schema.json index 28b68431..5107a28c 100644 --- a/Common/EntityCatalog.schema.json +++ b/Common/EntityCatalog.schema.json @@ -1,52 +1,52 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntityCatalog.schema.json", - "title": "EntityCatalog", - "definitions": { - "EntityCatalog": { - "$id": "#EntityCatalog", - "description": "The root entity for entity catalog management. An entity catalog can be defined as a collection of entity catalog items and arranging them in a particular manner based on the need.\nIn comparison to Product, Service and Resource catalogs, the entity catalog is intended for the purpose of providing any SID entity to consumers via a catalog, with its specification and policy providing governance over its content. Even Entity catalog may have an overlap with Product, Service or Resource catalog, it does not replace them. It is primarily intended to address those SID entities which may not be addressed by any of Product, Service or Resource catalog.\nAn entity catalog comprises of a list of RootEntities made available through EntityCatalogItems. This API addresses only RootEntity extended items as EntitySpecification. An entity catalog typically includes name, description and time period that it is valid for.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of this catalog" - }, - "href": { - "type": "string", - "description": "Unique reference of the catalog" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Catalog" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the catalog" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which the catalog is valid" - }, - "version": { - "type": "string", - "description": "Catalog version" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntityCatalog.schema.json", + "title": "EntityCatalog", + "definitions": { + "EntityCatalog": { + "$id": "#EntityCatalog", + "description": "The root entity for entity catalog management. An entity catalog can be defined as a collection of entity catalog items and arranging them in a particular manner based on the need.\nIn comparison to Product, Service and Resource catalogs, the entity catalog is intended for the purpose of providing any SID entity to consumers via a catalog, with its specification and policy providing governance over its content. Even Entity catalog may have an overlap with Product, Service or Resource catalog, it does not replace them. It is primarily intended to address those SID entities which may not be addressed by any of Product, Service or Resource catalog.\nAn entity catalog comprises of a list of RootEntities made available through EntityCatalogItems. This API addresses only RootEntity extended items as EntitySpecification. An entity catalog typically includes name, description and time period that it is valid for.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of this catalog" + }, + "href": { + "type": "string", + "description": "Unique reference of the catalog" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Catalog" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the catalog" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which the catalog is valid" + }, + "version": { + "type": "string", + "description": "Catalog version" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/EntityCatalogItem.schema.json b/Common/EntityCatalogItem.schema.json index e7e3b9a4..ef94fd5c 100644 --- a/Common/EntityCatalogItem.schema.json +++ b/Common/EntityCatalogItem.schema.json @@ -1,52 +1,52 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntityCatalogItem.schema.json", - "title": "EntityCatalogItem", - "definitions": { - "EntityCatalogItem": { - "$id": "#EntityCatalogItem", - "description": "An EntityCatalogItem is an entity that allows any ProductOffering, ServiceCandidate, ResourceCandidate, or even any object inheriting from RootEntity, to be available to a catalog. The CatalogSpecification and Policy of the catalog governs the content of the EntityCatalogItem. This API addresses only EntitySpecification items extended from RootEntity as EntityCatalogItem.\nThe EntityCatalogItem resource (JSON format) represents a set of characteristics that define the values given by the EntityCatalogItem.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of this REST resource" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to this REST resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of this REST resource" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update of this REST resource" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status of this catalog item" - }, - "name": { - "type": "string", - "description": "Name given to this REST resource" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which this REST resource is valid" - }, - "version": { - "type": "string", - "description": "EntityCatalogItem version" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntityCatalogItem.schema.json", + "title": "EntityCatalogItem", + "definitions": { + "EntityCatalogItem": { + "$id": "#EntityCatalogItem", + "description": "An EntityCatalogItem is an entity that allows any ProductOffering, ServiceCandidate, ResourceCandidate, or even any object inheriting from RootEntity, to be available to a catalog. The CatalogSpecification and Policy of the catalog governs the content of the EntityCatalogItem. This API addresses only EntitySpecification items extended from RootEntity as EntityCatalogItem.\nThe EntityCatalogItem resource (JSON format) represents a set of characteristics that define the values given by the EntityCatalogItem.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of this REST resource" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to this REST resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of this REST resource" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update of this REST resource" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status of this catalog item" + }, + "name": { + "type": "string", + "description": "Name given to this REST resource" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which this REST resource is valid" + }, + "version": { + "type": "string", + "description": "EntityCatalogItem version" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/EntityCatalogItemRef.schema.json b/Common/EntityCatalogItemRef.schema.json index e74688b7..09b92953 100644 --- a/Common/EntityCatalogItemRef.schema.json +++ b/Common/EntityCatalogItemRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntityCatalogItemRef.schema.json", - "title": "EntityCatalogItemRef", - "definitions": { - "EntityCatalogItemRef": { - "$id": "#EntityCatalogItemRef", - "description": "reference to EntityCatalogItem object", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink reference to the target EntityCatalogItem" - }, - "id": { - "type": "string", - "description": "reference id to the target EntityCatalogItem" - }, - "name": { - "type": "string", - "description": "Name given to the EntityCatalogItem" - }, - "version": { - "type": "string", - "description": "EntityCatalogItem version" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntityCatalogItemRef.schema.json", + "title": "EntityCatalogItemRef", + "definitions": { + "EntityCatalogItemRef": { + "$id": "#EntityCatalogItemRef", + "description": "reference to EntityCatalogItem object", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink reference to the target EntityCatalogItem" + }, + "id": { + "type": "string", + "description": "reference id to the target EntityCatalogItem" + }, + "name": { + "type": "string", + "description": "Name given to the EntityCatalogItem" + }, + "version": { + "type": "string", + "description": "EntityCatalogItem version" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/EntityCategory.schema.json b/Common/EntityCategory.schema.json index 51e5767d..1c4a18e9 100644 --- a/Common/EntityCategory.schema.json +++ b/Common/EntityCategory.schema.json @@ -1,60 +1,60 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntityCategory.schema.json", - "title": "EntityCategory", - "definitions": { - "EntityCategory": { - "$id": "#EntityCategory", - "description": "The (entity) category resource is used to group entity catalog items in logical containers. Categories can contain other categories.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the category" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to the category" - }, - "id": { - "type": "string", - "description": "Unique identifier of the category" - }, - "isRoot": { - "type": "boolean", - "description": "If true, this Boolean indicates that the category is a root of categories" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the category" - }, - "parentId": { - "type": "string", - "description": "Unique identifier of the parent category" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which the category is valid" - }, - "version": { - "type": "string", - "description": "Category version" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntityCategory.schema.json", + "title": "EntityCategory", + "definitions": { + "EntityCategory": { + "$id": "#EntityCategory", + "description": "The (entity) category resource is used to group entity catalog items in logical containers. Categories can contain other categories.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the category" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to the category" + }, + "id": { + "type": "string", + "description": "Unique identifier of the category" + }, + "isRoot": { + "type": "boolean", + "description": "If true, this Boolean indicates that the category is a root of categories" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the category" + }, + "parentId": { + "type": "string", + "description": "Unique identifier of the parent category" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which the category is valid" + }, + "version": { + "type": "string", + "description": "Category version" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/EntityRef.schema.json b/Common/EntityRef.schema.json index c0bd9213..8d35bab6 100644 --- a/Common/EntityRef.schema.json +++ b/Common/EntityRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntityRef.schema.json", - "title": "EntityRef", - "definitions": { - "EntityRef": { - "$id": "#EntityRef", - "description": "Entity reference schema to be use for all entityRef class.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of a related entity." - }, - "href": { - "type": "string", - "description": "Reference of the related entity." - }, - "name": { - "type": "string", - "description": "Name of the related entity." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntityRef.schema.json", + "title": "EntityRef", + "definitions": { + "EntityRef": { + "$id": "#EntityRef", + "description": "Entity reference schema to be use for all entityRef class.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of a related entity." + }, + "href": { + "type": "string", + "description": "Reference of the related entity." + }, + "name": { + "type": "string", + "description": "Name of the related entity." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/EntitySchemaRef.schema.json b/Common/EntitySchemaRef.schema.json index dc2a9c38..299a602a 100644 --- a/Common/EntitySchemaRef.schema.json +++ b/Common/EntitySchemaRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntitySchemaRef.schema.json", - "title": "EntitySchemaRef", - "definitions": { - "EntitySchemaRef": { - "$id": "#EntitySchemaRef", - "description": "The reference object to the schema and type of target entity which is described by an entity specification", - "type": "object", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntitySchemaRef.schema.json", + "title": "EntitySchemaRef", + "definitions": { + "EntitySchemaRef": { + "$id": "#EntitySchemaRef", + "description": "The reference object to the schema and type of target entity which is described by an entity specification", + "type": "object", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/EntitySpecRelationship.schema.json b/Common/EntitySpecRelationship.schema.json index 97e5836a..eae83851 100644 --- a/Common/EntitySpecRelationship.schema.json +++ b/Common/EntitySpecRelationship.schema.json @@ -1,46 +1,46 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntitySpecRelationship.schema.json", - "title": "EntitySpecRelationship", - "definitions": { - "EntitySpecRelationship": { - "$id": "#EntitySpecRelationship", - "description": "A migration, substitution, dependency or exclusivity relationship between/among entity specifications.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the target EntitySpecification" - }, - "id": { - "type": "string", - "description": "Unique identifier of target EntitySpecification" - }, - "name": { - "type": "string", - "description": "The name given to the target entity specification instance" - }, - "role": { - "type": "string", - "description": "The association role for this entity specification" - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship such as migration, substitution, dependency, exclusivity" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which the entitySpecRelationship is valid" - }, - "associationSpec": { - "$ref": "AssociationSpecRef.schema.json#AssociationSpecRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntitySpecRelationship.schema.json", + "title": "EntitySpecRelationship", + "definitions": { + "EntitySpecRelationship": { + "$id": "#EntitySpecRelationship", + "description": "A migration, substitution, dependency or exclusivity relationship between/among entity specifications.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the target EntitySpecification" + }, + "id": { + "type": "string", + "description": "Unique identifier of target EntitySpecification" + }, + "name": { + "type": "string", + "description": "The name given to the target entity specification instance" + }, + "role": { + "type": "string", + "description": "The association role for this entity specification" + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship such as migration, substitution, dependency, exclusivity" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which the entitySpecRelationship is valid" + }, + "associationSpec": { + "$ref": "AssociationSpecRef.schema.json#AssociationSpecRef" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/EntitySpecification.schema.json b/Common/EntitySpecification.schema.json index 4fd054af..5e2cafc6 100644 --- a/Common/EntitySpecification.schema.json +++ b/Common/EntitySpecification.schema.json @@ -1,73 +1,73 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntitySpecification.schema.json", - "title": "EntitySpecification", - "definitions": { - "EntitySpecification": { - "$id": "#EntitySpecification", - "description": "EntitySpecification is a class that offers characteristics to describe a type of entity. Entities are generic constructs that may be used to describe bespoke business entities that are not effectively covered by the existing SID model.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of this REST resource" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to this REST resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of this REST resource" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update of this REST resource" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status of this catalog item" - }, - "name": { - "type": "string", - "description": "Name given to this REST resource" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which this REST resource is valid" - }, - "version": { - "type": "string", - "description": "Entity specification version" - }, - "attachment": { - "type": "array", - "items": { - "$ref": "EntityAttachment.schema.json#EntityAttachment" - } - }, - "entitySchema": { - "$ref": "EntitySchemaRef.schema.json#EntitySchemaRef" - }, - "specCharacteristic": { - "type": "array", - "items": { - "$ref": "SpecCharacteristic.schema.json#SpecCharacteristic" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntitySpecification.schema.json", + "title": "EntitySpecification", + "definitions": { + "EntitySpecification": { + "$id": "#EntitySpecification", + "description": "EntitySpecification is a class that offers characteristics to describe a type of entity. Entities are generic constructs that may be used to describe bespoke business entities that are not effectively covered by the existing SID model.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of this REST resource" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to this REST resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of this REST resource" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update of this REST resource" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status of this catalog item" + }, + "name": { + "type": "string", + "description": "Name given to this REST resource" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which this REST resource is valid" + }, + "version": { + "type": "string", + "description": "Entity specification version" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "EntityAttachment.schema.json#EntityAttachment" + } + }, + "entitySchema": { + "$ref": "EntitySchemaRef.schema.json#EntitySchemaRef" + }, + "specCharacteristic": { + "type": "array", + "items": { + "$ref": "SpecCharacteristic.schema.json#SpecCharacteristic" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/EntitySpecificationRef.schema.json b/Common/EntitySpecificationRef.schema.json index 580c884a..f26cb943 100644 --- a/Common/EntitySpecificationRef.schema.json +++ b/Common/EntitySpecificationRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntitySpecificationRef.schema.json", - "title": "EntitySpecificationRef", - "definitions": { - "EntitySpecificationRef": { - "$id": "#EntitySpecificationRef", - "description": "reference to an EntitySpecification object", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink reference to the target EntitySpecification" - }, - "id": { - "type": "string", - "description": "reference id to the target EntitySpecification" - }, - "name": { - "type": "string", - "description": "Name given to the EntitySpecification" - }, - "version": { - "type": "string", - "description": "EntitySpecification version" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntitySpecificationRef.schema.json", + "title": "EntitySpecificationRef", + "definitions": { + "EntitySpecificationRef": { + "$id": "#EntitySpecificationRef", + "description": "reference to an EntitySpecification object", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink reference to the target EntitySpecification" + }, + "id": { + "type": "string", + "description": "reference id to the target EntitySpecification" + }, + "name": { + "type": "string", + "description": "Name given to the EntitySpecification" + }, + "version": { + "type": "string", + "description": "EntitySpecification version" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/Error.schema.json b/Common/Error.schema.json index 746c78ea..04da2f9d 100644 --- a/Common/Error.schema.json +++ b/Common/Error.schema.json @@ -1,64 +1,64 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Error.schema.json", - "title": "Error", - "definitions": { - "Error": { - "$id": "#Error", - "description": "Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)", - "type": "object", - "required": [ - "code", - "reason" - ], - "properties": { - "code": { - "type": "integer", - "description": "Application relevant detail, defined in the API or a common list", - "examples": [ - "1", - "2" - ] - }, - "reason": { - "type": "string", - "description": "Explanation of the reason for the error which can be shown to a client user", - "examples": [ - "This customer does not exist", - "The service is not available at this location" - ] - }, - "message": { - "type": "string", - "description": "More details and corrective actions related to the error which can be shown to a client user", - "examples": [ - "Please use a valid password", - "Please enter a smaller quantity" - ] - }, - "status": { - "type": "string", - "description": "HTTP Error code extension", - "examples": [ - "400-2", - "500-4" - ] - }, - "referenceError": { - "type": "string", - "format": "uri", - "description": "URI of documentation describing the error", - "examples": [ - "https://docs.microsoft.com/en-us/windows/desktop/wmdm/error-codes", - "https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Error.schema.json", + "title": "Error", + "definitions": { + "Error": { + "$id": "#Error", + "description": "Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)", + "type": "object", + "required": [ + "code", + "reason" + ], + "properties": { + "code": { + "type": "integer", + "description": "Application relevant detail, defined in the API or a common list", + "examples": [ + "1", + "2" + ] + }, + "reason": { + "type": "string", + "description": "Explanation of the reason for the error which can be shown to a client user", + "examples": [ + "This customer does not exist", + "The service is not available at this location" + ] + }, + "message": { + "type": "string", + "description": "More details and corrective actions related to the error which can be shown to a client user", + "examples": [ + "Please use a valid password", + "Please enter a smaller quantity" + ] + }, + "status": { + "type": "string", + "description": "HTTP Error code extension", + "examples": [ + "400-2", + "500-4" + ] + }, + "referenceError": { + "type": "string", + "format": "uri", + "description": "URI of documentation describing the error", + "examples": [ + "https://docs.microsoft.com/en-us/windows/desktop/wmdm/error-codes", + "https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html" + ] + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/EventRef.schema.json b/Common/EventRef.schema.json index be3eea47..5c437373 100644 --- a/Common/EventRef.schema.json +++ b/Common/EventRef.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EventRef.schema.json", - "title": "EventRef", - "definitions": { - "EventRef": { - "$id": "#EventRef", - "type": "object", - "description": "Events linked with service problem", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "eventTime": { - "type": "string", - "format": "date-time", - "description": "Time the event occurred" - }, - "eventType": { - "type": "string", - "description": "Type of the event" - }, - "href": { - "type": "string", - "description": "event reference" - }, - "id": { - "type": "string", - "description": "ID of the event" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EventRef.schema.json", + "title": "EventRef", + "definitions": { + "EventRef": { + "$id": "#EventRef", + "type": "object", + "description": "Events linked with service problem", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "Time the event occurred" + }, + "eventType": { + "type": "string", + "description": "Type of the event" + }, + "href": { + "type": "string", + "description": "event reference" + }, + "id": { + "type": "string", + "description": "ID of the event" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/ExportJob.schema.json b/Common/ExportJob.schema.json index 0ab5a450..5b0264d4 100644 --- a/Common/ExportJob.schema.json +++ b/Common/ExportJob.schema.json @@ -1,62 +1,62 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ExportJob.schema.json", - "title": "ExportJob", - "definitions": { - "ExportJob": { - "$id": "#ExportJob", - "description": "Represents a task used to export resources to a file", - "type": "object", - "properties": { - "completionDate": { - "type": "string", - "format": "date-time", - "description": "Data at which the job was completed" - }, - "contentType": { - "type": "string", - "description": "The format of the exported data" - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the job was created" - }, - "errorLog": { - "type": "string", - "description": "Reason for failure" - }, - "href": { - "type": "string", - "description": "Reference of the export job" - }, - "id": { - "type": "string", - "description": "Identifier of the export job" - }, - "path": { - "type": "string", - "description": "URL of the root resource acting as the source for streaming content to the file specified by the export job" - }, - "query": { - "type": "string", - "description": "Used to scope the exported data" - }, - "status": { - "description": "Status of the export job (not started, running, succeeded, failed)", - "$ref": "JobStateType.schema.json#JobStateType" - }, - "url": { - "type": "string", - "format": "uri", - "description": "URL of the file containing the data to be exported" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ExportJob.schema.json", + "title": "ExportJob", + "definitions": { + "ExportJob": { + "$id": "#ExportJob", + "description": "Represents a task used to export resources to a file", + "type": "object", + "properties": { + "completionDate": { + "type": "string", + "format": "date-time", + "description": "Data at which the job was completed" + }, + "contentType": { + "type": "string", + "description": "The format of the exported data" + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the job was created" + }, + "errorLog": { + "type": "string", + "description": "Reason for failure" + }, + "href": { + "type": "string", + "description": "Reference of the export job" + }, + "id": { + "type": "string", + "description": "Identifier of the export job" + }, + "path": { + "type": "string", + "description": "URL of the root resource acting as the source for streaming content to the file specified by the export job" + }, + "query": { + "type": "string", + "description": "Used to scope the exported data" + }, + "status": { + "description": "Status of the export job (not started, running, succeeded, failed)", + "$ref": "JobStateType.schema.json#JobStateType" + }, + "url": { + "type": "string", + "format": "uri", + "description": "URL of the file containing the data to be exported" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/ExternalReference.schema.json b/Common/ExternalReference.schema.json index 9f1ceccd..23aea5cf 100644 --- a/Common/ExternalReference.schema.json +++ b/Common/ExternalReference.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ExternalReference.schema.json", - "title": "ExternalReference", - "definitions": { - "ExternalReference": { - "$id": "#ExternalReference", - "type": "object", - "description": "External reference of the individual or reference in other system", - "properties": { - "externalReferenceType": { - "type": "string", - "description": "Type of the external reference" - }, - "name": { - "type": "string", - "description": "External reference name" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ExternalReference.schema.json", + "title": "ExternalReference", + "definitions": { + "ExternalReference": { + "$id": "#ExternalReference", + "type": "object", + "description": "External reference of the individual or reference in other system", + "properties": { + "externalReferenceType": { + "type": "string", + "description": "Type of the external reference" + }, + "name": { + "type": "string", + "description": "External reference name" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/FileDocument.schema.json b/Common/FileDocument.schema.json index 23a2325f..3c9912da 100644 --- a/Common/FileDocument.schema.json +++ b/Common/FileDocument.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "FileDocument.schema.json", - "title": "FileDocument", - "definitions": { - "FileDocument": { - "$id": "#FileDocument", - "description": "A document accompanying an entity", - "type": "object", - "properties": { - "downloadUrl": { - "type": "string", - "format": "uri", - "description": "URL where the document could be downloaded" - }, - "fileType": { - "type": "string", - "description": "Document file format of the file : csv, pdf, xls, txt... for example" - }, - "name": { - "type": "string", - "description": "Document name" - }, - "size": { - "type": "integer", - "description": "Document file size (by default in bytes)" - }, - "sizeUnit": { - "type": "integer", - "description": "Size unit (in bytes by default)" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "FileDocument.schema.json", + "title": "FileDocument", + "definitions": { + "FileDocument": { + "$id": "#FileDocument", + "description": "A document accompanying an entity", + "type": "object", + "properties": { + "downloadUrl": { + "type": "string", + "format": "uri", + "description": "URL where the document could be downloaded" + }, + "fileType": { + "type": "string", + "description": "Document file format of the file : csv, pdf, xls, txt... for example" + }, + "name": { + "type": "string", + "description": "Document name" + }, + "size": { + "type": "integer", + "description": "Document file size (by default in bytes)" + }, + "sizeUnit": { + "type": "integer", + "description": "Size unit (in bytes by default)" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/FloatCharacteristic.schema.json b/Common/FloatCharacteristic.schema.json index 37809ab0..cb7535d8 100644 --- a/Common/FloatCharacteristic.schema.json +++ b/Common/FloatCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "FloatCharacteristic.schema.json", - "title": "FloatCharacteristic", - "definitions": { - "FloatCharacteristic": { - "$id": "#FloatCharacteristic", - "description": "A characteristic which value is a float number", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "valueType": { - "type": "string", - "description": "Data type of the value of the characteristic" - }, - "value": { - "type": "number", - "format": "float", - "description": "Value of the characteristic" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "FloatCharacteristic.schema.json", + "title": "FloatCharacteristic", + "definitions": { + "FloatCharacteristic": { + "$id": "#FloatCharacteristic", + "description": "A characteristic which value is a float number", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "valueType": { + "type": "string", + "description": "Data type of the value of the characteristic" + }, + "value": { + "type": "number", + "format": "float", + "description": "Value of the characteristic" + } + } } - } } - } } \ No newline at end of file diff --git a/Common/GeographicAddress.schema.json b/Common/GeographicAddress.schema.json index ed359378..4f7ff306 100644 --- a/Common/GeographicAddress.schema.json +++ b/Common/GeographicAddress.schema.json @@ -1,76 +1,76 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicAddress.schema.json", - "title": "GeographicAddress", - "definitions": { - "GeographicAddress": { - "$id": "#GeographicAddress", - "description": "Structured textual way of describing how to find a Property in an urban area (country properties are often defined differently).\nNote : Address corresponds to SID UrbanPropertyAddress", - "type": "object", - "properties": { - "city": { - "type": "string", - "description": "City that the address is in" - }, - "country": { - "type": "string", - "description": "Country that the address is in" - }, - "locality": { - "type": "string", - "description": "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature. [ANZLIC-STREET], or a suburb, a bounded locality within a city, town or shire principally of urban character [ANZLICSTREET]" - }, - "postcode": { - "type": "string", - "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" - }, - "stateOrProvince": { - "type": "string", - "description": "the State or Province that the address is in" - }, - "streetName": { - "type": "string", - "description": "Name of the street or other street type" - }, - "streetNr": { - "type": "string", - "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" - }, - "streetNrLast": { - "type": "string", - "description": "Last number in a range of street numbers allocated to a property" - }, - "streetNrLastSuffix": { - "type": "string", - "description": "Last street number suffix for a ranged address" - }, - "streetNrSuffix": { - "type": "string", - "description": "the first street number suffix" - }, - "streetSuffix": { - "type": "string", - "description": "A modifier denoting a relative direction" - }, - "streetType": { - "type": "string", - "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf " - }, - "geographicLocation": { - "$ref": "GeographicLocation.schema.json#GeographicLocation" - }, - "geographicSubAddress": { - "type": "array", - "items": { - "$ref": "GeographicSubAddress.schema.json#GeographicSubAddress" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicAddress.schema.json", + "title": "GeographicAddress", + "definitions": { + "GeographicAddress": { + "$id": "#GeographicAddress", + "description": "Structured textual way of describing how to find a Property in an urban area (country properties are often defined differently).\nNote : Address corresponds to SID UrbanPropertyAddress", + "type": "object", + "properties": { + "city": { + "type": "string", + "description": "City that the address is in" + }, + "country": { + "type": "string", + "description": "Country that the address is in" + }, + "locality": { + "type": "string", + "description": "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature. [ANZLIC-STREET], or a suburb, a bounded locality within a city, town or shire principally of urban character [ANZLICSTREET]" + }, + "postcode": { + "type": "string", + "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" + }, + "stateOrProvince": { + "type": "string", + "description": "the State or Province that the address is in" + }, + "streetName": { + "type": "string", + "description": "Name of the street or other street type" + }, + "streetNr": { + "type": "string", + "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" + }, + "streetNrLast": { + "type": "string", + "description": "Last number in a range of street numbers allocated to a property" + }, + "streetNrLastSuffix": { + "type": "string", + "description": "Last street number suffix for a ranged address" + }, + "streetNrSuffix": { + "type": "string", + "description": "the first street number suffix" + }, + "streetSuffix": { + "type": "string", + "description": "A modifier denoting a relative direction" + }, + "streetType": { + "type": "string", + "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf " + }, + "geographicLocation": { + "$ref": "GeographicLocation.schema.json#GeographicLocation" + }, + "geographicSubAddress": { + "type": "array", + "items": { + "$ref": "GeographicSubAddress.schema.json#GeographicSubAddress" + } + } + }, + "allOf": [ + { + "$ref": "Place.schema.json#Place" + } + ] } - }, - "allOf": [ - { - "$ref": "Place.schema.json#Place" - } - ] } - } } \ No newline at end of file diff --git a/Common/GeographicAddressRef.schema.json b/Common/GeographicAddressRef.schema.json index 471071b1..03c525a9 100644 --- a/Common/GeographicAddressRef.schema.json +++ b/Common/GeographicAddressRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicAddressRef.schema.json", - "title": "GeographicAddressRef", - "definitions": { - "GeographicAddressRef": { - "$id": "#GeographicAddressRef", - "description": "The place at which the change request has occurred.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The detail address of the location." - }, - "id": { - "type": "string", - "description": "The post code of an address." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicAddressRef.schema.json", + "title": "GeographicAddressRef", + "definitions": { + "GeographicAddressRef": { + "$id": "#GeographicAddressRef", + "description": "The place at which the change request has occurred.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The detail address of the location." + }, + "id": { + "type": "string", + "description": "The post code of an address." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/GeographicAddressValidation.schema.json b/Common/GeographicAddressValidation.schema.json index 0a86a090..0a61525e 100644 --- a/Common/GeographicAddressValidation.schema.json +++ b/Common/GeographicAddressValidation.schema.json @@ -1,53 +1,53 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicAddressValidation.schema.json", - "title": "GeographicAddressValidation", - "definitions": { - "GeographicAddressValidation": { - "$id": "#GeographicAddressValidation", - "description": "This resource is used to manage address validation request and response", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "An URI used to access to the address validation resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Address Validation" - }, - "provideAlternative": { - "type": "boolean", - "description": "Indicator provided by the requester to specify if alternate addresses must be provided in case of partial or fail result." - }, - "status": { - "type": "string", - "description": "Status of the address validation (inProgress, terminatedWithError, done)" - }, - "validationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the address validation is performed" - }, - "validationResult": { - "type": "string", - "description": "Result of the address validation (success, partial, fail)" - }, - "validAddress": { - "$ref": "GeographicAddress.schema.json#GeographicAddress" - }, - "alternateGeographicAddress": { - "type": "array", - "items": { - "$ref": "GeographicAddress.schema.json#GeographicAddress" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicAddressValidation.schema.json", + "title": "GeographicAddressValidation", + "definitions": { + "GeographicAddressValidation": { + "$id": "#GeographicAddressValidation", + "description": "This resource is used to manage address validation request and response", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "An URI used to access to the address validation resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Address Validation" + }, + "provideAlternative": { + "type": "boolean", + "description": "Indicator provided by the requester to specify if alternate addresses must be provided in case of partial or fail result." + }, + "status": { + "type": "string", + "description": "Status of the address validation (inProgress, terminatedWithError, done)" + }, + "validationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the address validation is performed" + }, + "validationResult": { + "type": "string", + "description": "Result of the address validation (success, partial, fail)" + }, + "validAddress": { + "$ref": "GeographicAddress.schema.json#GeographicAddress" + }, + "alternateGeographicAddress": { + "type": "array", + "items": { + "$ref": "GeographicAddress.schema.json#GeographicAddress" + } + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/GeographicLocation.schema.json b/Common/GeographicLocation.schema.json index 27b937b7..e55bfac5 100644 --- a/Common/GeographicLocation.schema.json +++ b/Common/GeographicLocation.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicLocation.schema.json", - "title": "GeographicLocation", - "definitions": { - "GeographicLocation": { - "$id": "#GeographicLocation", - "description": "A GeographicLocation allows to describe through coordinate(s) a point, a line or a space", - "type": "object", - "properties": { - "accuracy": { - "type": "string" - }, - "geometryType": { - "type": "string", - "description": "Type allows to describe the GeoLocation form: it could be a point, a line, a polygon, a cylinder, etc" - }, - "spatialRef": { - "type": "string" - }, - "geometry": { - "type": "array", - "items": { - "$ref": "GeographicPoint.schema.json#GeographicPoint" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicLocation.schema.json", + "title": "GeographicLocation", + "definitions": { + "GeographicLocation": { + "$id": "#GeographicLocation", + "description": "A GeographicLocation allows to describe through coordinate(s) a point, a line or a space", + "type": "object", + "properties": { + "accuracy": { + "type": "string" + }, + "geometryType": { + "type": "string", + "description": "Type allows to describe the GeoLocation form: it could be a point, a line, a polygon, a cylinder, etc" + }, + "spatialRef": { + "type": "string" + }, + "geometry": { + "type": "array", + "items": { + "$ref": "GeographicPoint.schema.json#GeographicPoint" + } + } + }, + "allOf": [ + { + "$ref": "Place.schema.json#Place" + } + ] } - }, - "allOf": [ - { - "$ref": "Place.schema.json#Place" - } - ] } - } } \ No newline at end of file diff --git a/Common/GeographicLocationRef.schema.json b/Common/GeographicLocationRef.schema.json index 7f623e52..dc25b613 100644 --- a/Common/GeographicLocationRef.schema.json +++ b/Common/GeographicLocationRef.schema.json @@ -1,17 +1,17 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicLocationRef.schema.json", - "title": "GeographicLocationRef", - "definitions": { - "GeographicLocationRef": { - "$id": "#GeographicLocationRef", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "PlaceRef.schema.json#PlaceRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicLocationRef.schema.json", + "title": "GeographicLocationRef", + "definitions": { + "GeographicLocationRef": { + "$id": "#GeographicLocationRef", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "PlaceRef.schema.json#PlaceRef" + } + ] } - ] } - } } \ No newline at end of file diff --git a/Common/GeographicPoint.schema.json b/Common/GeographicPoint.schema.json index 3e2f4482..819ccfb1 100644 --- a/Common/GeographicPoint.schema.json +++ b/Common/GeographicPoint.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicPoint.schema.json", - "title": "GeographicPoint", - "definitions": { - "GeographicPoint": { - "$id": "#GeographicPoint", - "description": "A GeographicPoint defines a geographic point through coordinates.", - "type": "object", - "properties": { - "x": { - "type": "string", - "description": "x coordinate (usually latitude)" - }, - "y": { - "type": "string", - "description": "y coordinate (usually longitude)" - }, - "z": { - "type": "string", - "description": "z coordinate (usually elevation)" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicPoint.schema.json", + "title": "GeographicPoint", + "definitions": { + "GeographicPoint": { + "$id": "#GeographicPoint", + "description": "A GeographicPoint defines a geographic point through coordinates.", + "type": "object", + "properties": { + "x": { + "type": "string", + "description": "x coordinate (usually latitude)" + }, + "y": { + "type": "string", + "description": "y coordinate (usually longitude)" + }, + "z": { + "type": "string", + "description": "z coordinate (usually elevation)" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/GeographicSite.schema.json b/Common/GeographicSite.schema.json index b82f7930..6ad423ec 100644 --- a/Common/GeographicSite.schema.json +++ b/Common/GeographicSite.schema.json @@ -1,70 +1,70 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicSite.schema.json", - "title": "GeographicSite", - "definitions": { - "GeographicSite": { - "$id": "#GeographicSite", - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "A code that may be used for some addressing schemes eg: [ANSI T1.253-1999]" - }, - "description": { - "type": "string", - "description": "Text describing additional information regarding the site" - }, - "href": { - "type": "string", - "description": "An URI used to access to the site" - }, - "id": { - "type": "string", - "description": "Unique identifier of the site within the server" - }, - "name": { - "type": "string", - "description": "The name that the site is known by" - }, - "status": { - "type": "string", - "description": "The condition of the GeographicSite, such as active, inactive, planned address" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "calendar": { - "type": "array", - "items": { - "$ref": "CalendarPeriod.schema.json#CalendarPeriod" - } - }, - "geographicLocation": { - "$ref": "GeographicLocation.schema.json#GeographicLocation" - }, - "address": { - "$ref": "GeographicAddress.schema.json#GeographicAddress" - }, - "siteRelationship": { - "type": "array", - "items": { - "$ref": "SiteRelationship.schema.json#SiteRelationship" - } - }, - "role": { - "type": "string", - "description": "Role of the place, such as: [home delivery], [shop retrieval])" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicSite.schema.json", + "title": "GeographicSite", + "definitions": { + "GeographicSite": { + "$id": "#GeographicSite", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "A code that may be used for some addressing schemes eg: [ANSI T1.253-1999]" + }, + "description": { + "type": "string", + "description": "Text describing additional information regarding the site" + }, + "href": { + "type": "string", + "description": "An URI used to access to the site" + }, + "id": { + "type": "string", + "description": "Unique identifier of the site within the server" + }, + "name": { + "type": "string", + "description": "The name that the site is known by" + }, + "status": { + "type": "string", + "description": "The condition of the GeographicSite, such as active, inactive, planned address" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "calendar": { + "type": "array", + "items": { + "$ref": "CalendarPeriod.schema.json#CalendarPeriod" + } + }, + "geographicLocation": { + "$ref": "GeographicLocation.schema.json#GeographicLocation" + }, + "address": { + "$ref": "GeographicAddress.schema.json#GeographicAddress" + }, + "siteRelationship": { + "type": "array", + "items": { + "$ref": "SiteRelationship.schema.json#SiteRelationship" + } + }, + "role": { + "type": "string", + "description": "Role of the place, such as: [home delivery], [shop retrieval])" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/GeographicSiteRef.schema.json b/Common/GeographicSiteRef.schema.json index c8c081ed..38d2ebef 100644 --- a/Common/GeographicSiteRef.schema.json +++ b/Common/GeographicSiteRef.schema.json @@ -1,28 +1,28 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicSiteRef.schema.json", - "title": "GeographicSiteRef", - "definitions": { - "GeographicSiteRef": { - "$id": "#GeographicSiteRef", - "type": "object", - "properties": { - "href": { - "type": "integer" - }, - "id": { - "type": "integer" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicSiteRef.schema.json", + "title": "GeographicSiteRef", + "definitions": { + "GeographicSiteRef": { + "$id": "#GeographicSiteRef", + "type": "object", + "properties": { + "href": { + "type": "integer" + }, + "id": { + "type": "integer" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/GeographicSubAddress.schema.json b/Common/GeographicSubAddress.schema.json index dd345c49..59a3ecd5 100644 --- a/Common/GeographicSubAddress.schema.json +++ b/Common/GeographicSubAddress.schema.json @@ -1,63 +1,63 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicSubAddress.schema.json", - "title": "GeographicSubAddress", - "definitions": { - "GeographicSubAddress": { - "$id": "#GeographicSubAddress", - "description": "Representation of a GeographicSubAddress \nIt is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.", - "type": "object", - "properties": { - "buildingName": { - "type": "string", - "description": "allows for buildings that have well-known names" - }, - "href": { - "type": "string", - "description": "Link to the subAddress" - }, - "id": { - "type": "string", - "description": "Unique Identifier of the subAddress" - }, - "levelNumber": { - "type": "string", - "description": "used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2" - }, - "levelType": { - "type": "string", - "description": "describes level types within a building" - }, - "name": { - "type": "string", - "description": "Name of the subAddress to identify it with a meaningful identification" - }, - "privateStreetName": { - "type": "string", - "description": "private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office." - }, - "privateStreetNumber": { - "type": "string", - "description": "private streets numbers internal to a private street" - }, - "subUnitNumber": { - "type": "string", - "description": "the discriminator used for the subunit\noften just a simple number e.g. FLAT 5, may also be a range" - }, - "subUnitType": { - "type": "string", - "description": "the type of subunit\ne.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF" - }, - "subAddressType": { - "type": "string", - "description": "Type of subAddress : it can be a subunit or a private street" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicSubAddress.schema.json", + "title": "GeographicSubAddress", + "definitions": { + "GeographicSubAddress": { + "$id": "#GeographicSubAddress", + "description": "Representation of a GeographicSubAddress \nIt is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.", + "type": "object", + "properties": { + "buildingName": { + "type": "string", + "description": "allows for buildings that have well-known names" + }, + "href": { + "type": "string", + "description": "Link to the subAddress" + }, + "id": { + "type": "string", + "description": "Unique Identifier of the subAddress" + }, + "levelNumber": { + "type": "string", + "description": "used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2" + }, + "levelType": { + "type": "string", + "description": "describes level types within a building" + }, + "name": { + "type": "string", + "description": "Name of the subAddress to identify it with a meaningful identification" + }, + "privateStreetName": { + "type": "string", + "description": "private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office." + }, + "privateStreetNumber": { + "type": "string", + "description": "private streets numbers internal to a private street" + }, + "subUnitNumber": { + "type": "string", + "description": "the discriminator used for the subunit\noften just a simple number e.g. FLAT 5, may also be a range" + }, + "subUnitType": { + "type": "string", + "description": "the type of subunit\ne.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF" + }, + "subAddressType": { + "type": "string", + "description": "Type of subAddress : it can be a subunit or a private street" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/HeaderItem.schema.json b/Common/HeaderItem.schema.json index e75d42a2..92be6696 100644 --- a/Common/HeaderItem.schema.json +++ b/Common/HeaderItem.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "HeaderItem.schema.json", - "title": "HeaderItem", - "definitions": { - "HeaderItem": { - "$id": "#HeaderItem", - "type": "object", - "description": "An item typically included in a request or response", - "properties": { - "name": { - "description": "The name of the header item, e.g. locale", - "type": "string" - }, - "value": { - "description": "The value of the header item, e.g. en-us", - "type": "string" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "HeaderItem.schema.json", + "title": "HeaderItem", + "definitions": { + "HeaderItem": { + "$id": "#HeaderItem", + "type": "object", + "description": "An item typically included in a request or response", + "properties": { + "name": { + "description": "The name of the header item, e.g. locale", + "type": "string" + }, + "value": { + "description": "The value of the header item, e.g. en-us", + "type": "string" + } + }, + "required": [ + "name", + "value" + ] } - }, - "required": [ - "name", - "value" - ] } - } } \ No newline at end of file diff --git a/Common/HourPeriod.schema.json b/Common/HourPeriod.schema.json index 9d61567e..f4a13944 100644 --- a/Common/HourPeriod.schema.json +++ b/Common/HourPeriod.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "HourPeriod.schema.json", - "title": "HourPeriod", - "definitions": { - "HourPeriod": { - "$id": "#HourPeriod", - "type": "object", - "properties": { - "endHour": { - "type": "string", - "description": "The time when the status ends applying" - }, - "startHour": { - "type": "string", - "description": "The time when the status starts applying" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "HourPeriod.schema.json", + "title": "HourPeriod", + "definitions": { + "HourPeriod": { + "$id": "#HourPeriod", + "type": "object", + "properties": { + "endHour": { + "type": "string", + "description": "The time when the status ends applying" + }, + "startHour": { + "type": "string", + "description": "The time when the status starts applying" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/Hub.schema.json b/Common/Hub.schema.json index 78bac7ce..d2d61a7b 100644 --- a/Common/Hub.schema.json +++ b/Common/Hub.schema.json @@ -1,46 +1,46 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Hub.schema.json", - "title": "Hub", - "definitions": { - "Hub": { - "$id": "#Hub", - "description": "A Hub is used to subscribe to an event notification", - "type": "object", - "required": [ - "id", - "callback" - ], - "properties": { - "id": { - "type": "string", - "description": "The unique-id for your subscription - referenced when updating or deleting a subscription", - "examples": [ - "4aafacbd-11ff-4dc8-b445-305f2215715f", - "2334bc59-726e-4d34-ab96-f50e0561412f" - ] - }, - "callback": { - "type": "string", - "format": "uri", - "description": "The URI that will be POSTed to when a notification is triggered", - "examples": [ - "http://host/resource/id/listener" - ] - }, - "query": { - "type": "string", - "description": "This is a query string used to filter notifications in the context of the notifier", - "examples": [ - "status=active" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Hub.schema.json", + "title": "Hub", + "definitions": { + "Hub": { + "$id": "#Hub", + "description": "A Hub is used to subscribe to an event notification", + "type": "object", + "required": [ + "id", + "callback" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique-id for your subscription - referenced when updating or deleting a subscription", + "examples": [ + "4aafacbd-11ff-4dc8-b445-305f2215715f", + "2334bc59-726e-4d34-ab96-f50e0561412f" + ] + }, + "callback": { + "type": "string", + "format": "uri", + "description": "The URI that will be POSTed to when a notification is triggered", + "examples": [ + "http://host/resource/id/listener" + ] + }, + "query": { + "type": "string", + "description": "This is a query string used to filter notifications in the context of the notifier", + "examples": [ + "status=active" + ] + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/ImpactEntityRef.schema.json b/Common/ImpactEntityRef.schema.json index 4accb81d..e3e4f5a2 100644 --- a/Common/ImpactEntityRef.schema.json +++ b/Common/ImpactEntityRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ImpactEntityRef.schema.json", - "title": "ImpactEntityRef", - "definitions": { - "ImpactEntityRef": { - "$id": "#ImpactEntityRef", - "description": "Defines the entities (product, service, resource, and other related objects) which will be impacted while the change \nrequest is executed.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description and analysis of the impact of the change request on the Product, Service or Resource." - }, - "href": { - "type": "string", - "description": "Hyperlink to access the impacted party, it could be a party reference or a party role reference." - }, - "id": { - "type": "string", - "description": "Identifier of impacted entity." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ImpactEntityRef.schema.json", + "title": "ImpactEntityRef", + "definitions": { + "ImpactEntityRef": { + "$id": "#ImpactEntityRef", + "description": "Defines the entities (product, service, resource, and other related objects) which will be impacted while the change \nrequest is executed.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description and analysis of the impact of the change request on the Product, Service or Resource." + }, + "href": { + "type": "string", + "description": "Hyperlink to access the impacted party, it could be a party reference or a party role reference." + }, + "id": { + "type": "string", + "description": "Identifier of impacted entity." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/ImportJob.schema.json b/Common/ImportJob.schema.json index c027b329..e083b9f9 100644 --- a/Common/ImportJob.schema.json +++ b/Common/ImportJob.schema.json @@ -1,58 +1,58 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ImportJob.schema.json", - "title": "ImportJob", - "definitions": { - "ImportJob": { - "$id": "#ImportJob", - "description": "Represents a task used to import resources from a file", - "type": "object", - "properties": { - "completionDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the job was completed" - }, - "contentType": { - "type": "string", - "description": "Indicates the format of the imported data" - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the job was created" - }, - "errorLog": { - "type": "string", - "description": "Reason for failure if status is failed" - }, - "href": { - "type": "string", - "description": "Reference of the import job" - }, - "id": { - "type": "string", - "description": "Identifier of the import job" - }, - "path": { - "type": "string", - "description": "URL of the root resource where the content of the file specified by the import job must be applied" - }, - "status": { - "description": "Status of the import job (not started, running, succeeded, failed)", - "$ref": "JobStateType.schema.json#JobStateType" - }, - "url": { - "type": "string", - "format": "uri", - "description": "URL of the file containing the data to be imported" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ImportJob.schema.json", + "title": "ImportJob", + "definitions": { + "ImportJob": { + "$id": "#ImportJob", + "description": "Represents a task used to import resources from a file", + "type": "object", + "properties": { + "completionDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the job was completed" + }, + "contentType": { + "type": "string", + "description": "Indicates the format of the imported data" + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the job was created" + }, + "errorLog": { + "type": "string", + "description": "Reason for failure if status is failed" + }, + "href": { + "type": "string", + "description": "Reference of the import job" + }, + "id": { + "type": "string", + "description": "Identifier of the import job" + }, + "path": { + "type": "string", + "description": "URL of the root resource where the content of the file specified by the import job must be applied" + }, + "status": { + "description": "Status of the import job (not started, running, succeeded, failed)", + "$ref": "JobStateType.schema.json#JobStateType" + }, + "url": { + "type": "string", + "format": "uri", + "description": "URL of the file containing the data to be imported" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/Incident.schema.json b/Common/Incident.schema.json index 72e171f6..e8fb6ffe 100644 --- a/Common/Incident.schema.json +++ b/Common/Incident.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Incident.schema.json", - "title": "Incident", - "definitions": { - "Incident": { - "$id": "#Incident", - "description": "An Incident is a record of an event that has altered the operational state of a entity (Resource, Service or Customers Product)", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description of the incident." - }, - "name": { - "type": "string", - "description": "The name of the incident." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Incident.schema.json", + "title": "Incident", + "definitions": { + "Incident": { + "$id": "#Incident", + "description": "An Incident is a record of an event that has altered the operational state of a entity (Resource, Service or Customers Product)", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of the incident." + }, + "name": { + "type": "string", + "description": "The name of the incident." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/IntegerCharacteristic.schema.json b/Common/IntegerCharacteristic.schema.json index ba948af9..26f21dad 100644 --- a/Common/IntegerCharacteristic.schema.json +++ b/Common/IntegerCharacteristic.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "IntegerCharacteristic.schema.json", - "title": "IntegerCharacteristic", - "definitions": { - "IntegerCharacteristic": { - "$id": "#IntegerCharacteristic", - "description": "A characteristic which value is a integer number", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "valueType": { - "type": "string", - "description": "Data type of the value of the characteristic" - }, - "value": { - "type": "integer", - "description": "Value of the characteristic" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "IntegerCharacteristic.schema.json", + "title": "IntegerCharacteristic", + "definitions": { + "IntegerCharacteristic": { + "$id": "#IntegerCharacteristic", + "description": "A characteristic which value is a integer number", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "valueType": { + "type": "string", + "description": "Data type of the value of the characteristic" + }, + "value": { + "type": "integer", + "description": "Value of the characteristic" + } + } } - } } - } } \ No newline at end of file diff --git a/Common/JobStateType.schema.json b/Common/JobStateType.schema.json index 6247d6f9..991b9393 100644 --- a/Common/JobStateType.schema.json +++ b/Common/JobStateType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "JobStateType.schema.json", - "title": "JobStateType", - "definitions": { - "JobStateType": { - "$id": "#JobStateType", - "type": "string", - "description": "Valid values for the state of a batch job (e.g. catalog import)", - "enum": [ - "Not Started", - "Running", - "Succeeded", - "Failed" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "JobStateType.schema.json", + "title": "JobStateType", + "definitions": { + "JobStateType": { + "$id": "#JobStateType", + "type": "string", + "description": "Valid values for the state of a batch job (e.g. catalog import)", + "enum": [ + "Not Started", + "Running", + "Succeeded", + "Failed" + ] + } } - } } \ No newline at end of file diff --git a/Common/LocationCharacteristic.schema.json b/Common/LocationCharacteristic.schema.json index cfe35dd1..fe9885c2 100644 --- a/Common/LocationCharacteristic.schema.json +++ b/Common/LocationCharacteristic.schema.json @@ -1,25 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LocationCharacteristic.schema.json", - "title": "LocationCharacteristic", - "definitions": { - "LocationCharacteristic": { - "$id": "#LocationCharacteristic", - "description": "Name/value pairs, used to extra characterized the Area (e.g. if a standard\ncode set has been defined for the GeographicArea type, etc.)", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LocationCharacteristic.schema.json", + "title": "LocationCharacteristic", + "definitions": { + "LocationCharacteristic": { + "$id": "#LocationCharacteristic", + "description": "Name/value pairs, used to extra characterized the Area (e.g. if a standard\ncode set has been defined for the GeographicArea type, etc.)", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/MediumCharacteristic.schema.json b/Common/MediumCharacteristic.schema.json index debe6a28..9c660f4e 100644 --- a/Common/MediumCharacteristic.schema.json +++ b/Common/MediumCharacteristic.schema.json @@ -1,63 +1,63 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "MediumCharacteristic.schema.json", - "title": "MediumCharacteristic", - "definitions": { - "MediumCharacteristic": { - "$id": "#MediumCharacteristic", - "type": "object", - "description": "Describes the contact medium characteristics that could be used to contact a party (an individual or an organization)", - "properties": { - "city": { - "type": "string", - "description": "The city" - }, - "country": { - "type": "string", - "description": "The country" - }, - "emailAddress": { - "type": "string", - "description": "Full email address in standard format" - }, - "faxNumber": { - "type": "string", - "description": "The fax number of the contact" - }, - "contactType": { - "type": "string", - "description": "The type of contact, for example: phone number such as mobile, fixed home, fixed office. postal address such as shipping instalation…" - }, - "socialNetworkId": { - "type": "string", - "description": "Identifier as a member of a social network" - }, - "phoneNumber": { - "type": "string", - "description": "The primary phone number of the contact" - }, - "postCode": { - "type": "string", - "description": "Postcode" - }, - "stateOrProvince": { - "type": "string", - "description": "State or province" - }, - "street1": { - "type": "string", - "description": "Describes the street" - }, - "street2": { - "type": "string", - "description": "Complementary street description" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "MediumCharacteristic.schema.json", + "title": "MediumCharacteristic", + "definitions": { + "MediumCharacteristic": { + "$id": "#MediumCharacteristic", + "type": "object", + "description": "Describes the contact medium characteristics that could be used to contact a party (an individual or an organization)", + "properties": { + "city": { + "type": "string", + "description": "The city" + }, + "country": { + "type": "string", + "description": "The country" + }, + "emailAddress": { + "type": "string", + "description": "Full email address in standard format" + }, + "faxNumber": { + "type": "string", + "description": "The fax number of the contact" + }, + "contactType": { + "type": "string", + "description": "The type of contact, for example: phone number such as mobile, fixed home, fixed office. postal address such as shipping instalation…" + }, + "socialNetworkId": { + "type": "string", + "description": "Identifier as a member of a social network" + }, + "phoneNumber": { + "type": "string", + "description": "The primary phone number of the contact" + }, + "postCode": { + "type": "string", + "description": "Postcode" + }, + "stateOrProvince": { + "type": "string", + "description": "State or province" + }, + "street1": { + "type": "string", + "description": "Describes the street" + }, + "street2": { + "type": "string", + "description": "Complementary street description" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/Money.schema.json b/Common/Money.schema.json index 0ade88f6..07a02780 100644 --- a/Common/Money.schema.json +++ b/Common/Money.schema.json @@ -1,28 +1,28 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Money.schema.json", - "title": "Money", - "definitions": { - "Money": { - "$id": "#Money", - "description": "A base / value business entity used to represent money", - "type": "object", - "properties": { - "unit": { - "type": "string", - "description": "Currency (ISO4217 norm uses 3 letters to define the currency)" - }, - "value": { - "type": "number", - "format": "float", - "description": "A positive floating point number" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Money.schema.json", + "title": "Money", + "definitions": { + "Money": { + "$id": "#Money", + "description": "A base / value business entity used to represent money", + "type": "object", + "properties": { + "unit": { + "type": "string", + "description": "Currency (ISO4217 norm uses 3 letters to define the currency)" + }, + "value": { + "type": "number", + "format": "float", + "description": "A positive floating point number" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/Monitor.schema.json b/Common/Monitor.schema.json index 17f16d1a..817c847f 100644 --- a/Common/Monitor.schema.json +++ b/Common/Monitor.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Monitor.schema.json", - "title": "Monitor", - "definitions": { - "Monitor": { - "$id": "#Monitor", - "type": "object", - "description": "Monitoring of resources", - "properties": { - "href": { - "type": "string", - "description": "reference to this monitor" - }, - "id": { - "type": "string", - "description": "Identifier of an instance of the monitor. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type" - }, - "request": { - "description": "Represents the request", - "$ref": "Request.schema.json#Request" - }, - "response": { - "description": "Represents the response", - "$ref": "Response.schema.json#Response" - }, - "sourceHref": { - "type": "string", - "description": "The monitored resource href" - }, - "state": { - "type": "string", - "description": "The Monitor state of the resource. InProgress, InError, Completed" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Monitor.schema.json", + "title": "Monitor", + "definitions": { + "Monitor": { + "$id": "#Monitor", + "type": "object", + "description": "Monitoring of resources", + "properties": { + "href": { + "type": "string", + "description": "reference to this monitor" + }, + "id": { + "type": "string", + "description": "Identifier of an instance of the monitor. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type" + }, + "request": { + "description": "Represents the request", + "$ref": "Request.schema.json#Request" + }, + "response": { + "description": "Represents the response", + "$ref": "Response.schema.json#Response" + }, + "sourceHref": { + "type": "string", + "description": "The monitored resource href" + }, + "state": { + "type": "string", + "description": "The Monitor state of the resource. InProgress, InError, Completed" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/NetworkFunction.schema.json b/Common/NetworkFunction.schema.json index 5715990a..6d5e279f 100644 --- a/Common/NetworkFunction.schema.json +++ b/Common/NetworkFunction.schema.json @@ -1,19 +1,19 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "NetworkFunction.schema.json", - "title": "NetworkFunction", - "definitions": { - "NetworkFunction": { - "$id": "#NetworkFunction", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "id": { - "type": "string" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "NetworkFunction.schema.json", + "title": "NetworkFunction", + "definitions": { + "NetworkFunction": { + "$id": "#NetworkFunction", + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "id": { + "type": "string" + } + } } - } } - } } \ No newline at end of file diff --git a/Common/Note.schema.json b/Common/Note.schema.json index a74d713d..f08601da 100644 --- a/Common/Note.schema.json +++ b/Common/Note.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Note.schema.json", - "title": "Note", - "definitions": { - "Note": { - "$id": "#Note", - "description": "Extra information about a given entity", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)" - }, - "author": { - "type": "string", - "description": "Author of the note" - }, - "date": { - "type": "string", - "format": "date-time", - "description": "Date of the note" - }, - "text": { - "type": "string", - "description": "Text of the note" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Note.schema.json", + "title": "Note", + "definitions": { + "Note": { + "$id": "#Note", + "description": "Extra information about a given entity", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)" + }, + "author": { + "type": "string", + "description": "Author of the note" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "Date of the note" + }, + "text": { + "type": "string", + "description": "Text of the note" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/Notification.schema.json b/Common/Notification.schema.json index 9b115b1b..a2737f6a 100644 --- a/Common/Notification.schema.json +++ b/Common/Notification.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Notification.schema.json", - "title": "Notification", - "definitions": { - "Notification": { - "$id": "#Notification", - "description": "The notification is sent to each listener who has subscribed to receive it.", - "type": "object", - "properties": { - "eventId": { - "type": "string", - "description": "Identifier of the event" - }, - "eventTime": { - "type": "string", - "format": "date-time", - "description": "Creation date of the event" - }, - "eventType": { - "type": "string", - "description": "Type of event" - }, - "fieldPath": { - "type": "string", - "description": "details which field is missing, its structure is quite similar to GET filter criteria" - }, - "resourcePath": { - "type": "string", - "description": "To indicate which entity is concerned" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Notification.schema.json", + "title": "Notification", + "definitions": { + "Notification": { + "$id": "#Notification", + "description": "The notification is sent to each listener who has subscribed to receive it.", + "type": "object", + "properties": { + "eventId": { + "type": "string", + "description": "Identifier of the event" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "Creation date of the event" + }, + "eventType": { + "type": "string", + "description": "Type of event" + }, + "fieldPath": { + "type": "string", + "description": "details which field is missing, its structure is quite similar to GET filter criteria" + }, + "resourcePath": { + "type": "string", + "description": "To indicate which entity is concerned" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/Object.schema.json b/Common/Object.schema.json index 190a688f..f1ac81cc 100644 --- a/Common/Object.schema.json +++ b/Common/Object.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Object.schema.json", - "title": "Object", - "definitions": { - "Object": { - "$id": "#Object", - "type": "object", - "properties": { - "objectType": { - "type": "string", - "description": "The type of object" - }, - "uri": { - "type": "string", - "format": "uri" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Object.schema.json", + "title": "Object", + "definitions": { + "Object": { + "$id": "#Object", + "type": "object", + "properties": { + "objectType": { + "type": "string", + "description": "The type of object" + }, + "uri": { + "type": "string", + "format": "uri" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/ObjectCharacteristic.schema.json b/Common/ObjectCharacteristic.schema.json index cf55ddbb..cfa35c44 100644 --- a/Common/ObjectCharacteristic.schema.json +++ b/Common/ObjectCharacteristic.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ObjectCharacteristic.schema.json", - "title": "ObjectCharacteristic", - "definitions": { - "ObjectCharacteristic": { - "$id": "#ObjectCharacteristic", - "description": "A characteristic which value is an object", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "valueType": { - "type": "string", - "description": "Data type of the value of the characteristic" - }, - "value": { - "type": "string", - "description": "Value of the characteristic" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ObjectCharacteristic.schema.json", + "title": "ObjectCharacteristic", + "definitions": { + "ObjectCharacteristic": { + "$id": "#ObjectCharacteristic", + "description": "A characteristic which value is an object", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "valueType": { + "type": "string", + "description": "Data type of the value of the characteristic" + }, + "value": { + "type": "string", + "description": "Value of the characteristic" + } + } } - } } - } } \ No newline at end of file diff --git a/Common/Place.schema.json b/Common/Place.schema.json index 9eeff0c7..34bae903 100644 --- a/Common/Place.schema.json +++ b/Common/Place.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Place.schema.json", - "title": "Place", - "definitions": { - "Place": { - "$id": "#Place", - "description": "Place reference. Place defines the places where the products are sold or delivered.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Unique reference of the place" - }, - "id": { - "type": "string", - "description": "Unique identifier of the place" - }, - "name": { - "type": "string", - "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Place.schema.json", + "title": "Place", + "definitions": { + "Place": { + "$id": "#Place", + "description": "Place reference. Place defines the places where the products are sold or delivered.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Unique reference of the place" + }, + "id": { + "type": "string", + "description": "Unique identifier of the place" + }, + "name": { + "type": "string", + "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/PlaceRef.schema.json b/Common/PlaceRef.schema.json index 10b98a40..2a05e114 100644 --- a/Common/PlaceRef.schema.json +++ b/Common/PlaceRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PlaceRef.schema.json", - "title": "PlaceRef", - "definitions": { - "PlaceRef": { - "$id": "#PlaceRef", - "description": "Place reference. PlaceRef defines the placeRefs where the products are sold or delivered.", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PlaceRef.schema.json", + "title": "PlaceRef", + "definitions": { + "PlaceRef": { + "$id": "#PlaceRef", + "description": "Place reference. PlaceRef defines the placeRefs where the products are sold or delivered.", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "EntityRef.schema.json#EntityRef" + } + ] } - ] } - } } \ No newline at end of file diff --git a/Common/ProcessFlow.schema.json b/Common/ProcessFlow.schema.json index 6424622e..0ffa8670 100644 --- a/Common/ProcessFlow.schema.json +++ b/Common/ProcessFlow.schema.json @@ -1,74 +1,74 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProcessFlow.schema.json", - "title": "ProcessFlow", - "definitions": { - "ProcessFlow": { - "$id": "#ProcessFlow", - "type": "object", - "properties": { - "channel": { - "type": "array", - "items": { - "$ref": "ChannelRef.schema.json#ChannelRef" - }, - "description": "A list of channel(s) where this processFlow is executed" - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "Characteristic.schema.json#Characteristic" - }, - "description": "A list of characteristic(s) associated to this processFlow" - }, - "href": { - "type": "string", - "description": "Reference of the ProcessFlow" - }, - "id": { - "type": "string", - "description": "Identifier of the Process flow" - }, - "processFlowDate": { - "type": "string", - "format": "date-time", - "description": "Is the date when the processFlow was created in basse (timestamp)" - }, - "processFlowSpecification": { - "type": "string", - "description": "Specification of the processFlow." - }, - "relatedEntity": { - "type": "array", - "items": { - "$ref": "RelatedEntity.schema.json#RelatedEntity" - }, - "description": "A list of related entity(ies) to this processFlow" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "description": "A list of related party(ies) to this processFlow" - }, - "state": { - "$ref": "ProcessFlowStateType.schema.json#ProcessFlowStateType", - "description": "State of the ProcessFlow: described in the state machine diagram." - }, - "taskFlow": { - "type": "array", - "items": { - "$ref": "TaskFlowRef.schema.json#TaskFlowRef" - }, - "description": "A list of taskflow related to this processFlow" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProcessFlow.schema.json", + "title": "ProcessFlow", + "definitions": { + "ProcessFlow": { + "$id": "#ProcessFlow", + "type": "object", + "properties": { + "channel": { + "type": "array", + "items": { + "$ref": "ChannelRef.schema.json#ChannelRef" + }, + "description": "A list of channel(s) where this processFlow is executed" + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "Characteristic.schema.json#Characteristic" + }, + "description": "A list of characteristic(s) associated to this processFlow" + }, + "href": { + "type": "string", + "description": "Reference of the ProcessFlow" + }, + "id": { + "type": "string", + "description": "Identifier of the Process flow" + }, + "processFlowDate": { + "type": "string", + "format": "date-time", + "description": "Is the date when the processFlow was created in basse (timestamp)" + }, + "processFlowSpecification": { + "type": "string", + "description": "Specification of the processFlow." + }, + "relatedEntity": { + "type": "array", + "items": { + "$ref": "RelatedEntity.schema.json#RelatedEntity" + }, + "description": "A list of related entity(ies) to this processFlow" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "A list of related party(ies) to this processFlow" + }, + "state": { + "$ref": "ProcessFlowStateType.schema.json#ProcessFlowStateType", + "description": "State of the ProcessFlow: described in the state machine diagram." + }, + "taskFlow": { + "type": "array", + "items": { + "$ref": "TaskFlowRef.schema.json#TaskFlowRef" + }, + "description": "A list of taskflow related to this processFlow" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/ProcessFlowRef.schema.json b/Common/ProcessFlowRef.schema.json index 73c6dab9..88b71794 100644 --- a/Common/ProcessFlowRef.schema.json +++ b/Common/ProcessFlowRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProcessFlowRef.schema.json", - "title": "ProcessFlowRef", - "definitions": { - "ProcessFlowRef": { - "$id": "#ProcessFlowRef", - "description": "Process Flow ref class is used to provide process main information from Task sub resource.", - "type": "object", - "properties": { - "state": { - "description": "The life cycle state of the processFlow", - "$ref": "ProcessFlowStateType.schema.json#ProcessFlowStateType" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProcessFlowRef.schema.json", + "title": "ProcessFlowRef", + "definitions": { + "ProcessFlowRef": { + "$id": "#ProcessFlowRef", + "description": "Process Flow ref class is used to provide process main information from Task sub resource.", + "type": "object", + "properties": { + "state": { + "description": "The life cycle state of the processFlow", + "$ref": "ProcessFlowStateType.schema.json#ProcessFlowStateType" + } + }, + "allOf": [ + { + "$ref": "EntityRef.schema.json#EntityRef" + } + ] } - }, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" - } - ] } - } } \ No newline at end of file diff --git a/Common/ProcessFlowStateType.schema.json b/Common/ProcessFlowStateType.schema.json index 1a3552aa..661f1acc 100644 --- a/Common/ProcessFlowStateType.schema.json +++ b/Common/ProcessFlowStateType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProcessFlowStateType.schema.json", - "title": "ProcessFlowStateType", - "definitions": { - "ProcessFlowStateType": { - "$id": "#ProcessFlowStateType", - "type": "string", - "description": "Valid values for the lifecycle state of the processFlow", - "enum": [ - "active", - "cancelled", - "hold", - "completed" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProcessFlowStateType.schema.json", + "title": "ProcessFlowStateType", + "definitions": { + "ProcessFlowStateType": { + "$id": "#ProcessFlowStateType", + "type": "string", + "description": "Valid values for the lifecycle state of the processFlow", + "enum": [ + "active", + "cancelled", + "hold", + "completed" + ] + } } - } } \ No newline at end of file diff --git a/Common/QualificationRef.schema.json b/Common/QualificationRef.schema.json index 4af9c2e1..8123daf4 100644 --- a/Common/QualificationRef.schema.json +++ b/Common/QualificationRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QualificationRef.schema.json", - "title": "QualificationRef", - "definitions": { - "QualificationRef": { - "$id": "#QualificationRef", - "type": "object", - "description": "It could be a serviceQualification or a productOfferingQualification that has been executed previously and captured in the productOrder to provide eligibility information", - "properties": { - "qualificationItemId": { - "type": "string", - "description": "Id of an item of a qualification" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QualificationRef.schema.json", + "title": "QualificationRef", + "definitions": { + "QualificationRef": { + "$id": "#QualificationRef", + "type": "object", + "description": "It could be a serviceQualification or a productOfferingQualification that has been executed previously and captured in the productOrder to provide eligibility information", + "properties": { + "qualificationItemId": { + "type": "string", + "description": "Id of an item of a qualification" + } + }, + "allOf": [ + { + "$ref": "EntityRef.schema.json#EntityRef" + } + ] } - }, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" - } - ] } - } } \ No newline at end of file diff --git a/Common/Quantity.schema.json b/Common/Quantity.schema.json index 31947f52..7ed03213 100644 --- a/Common/Quantity.schema.json +++ b/Common/Quantity.schema.json @@ -1,24 +1,24 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Quantity.schema.json", - "title": "Quantity", - "definitions": { - "Quantity": { - "$id": "#Quantity", - "type": "object", - "description": "An amount in a given unit", - "properties": { - "amount": { - "type": "number", - "format": "float", - "default": 1, - "description": "Numeric value in a given unit" - }, - "units": { - "type": "string", - "description": "Unit" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Quantity.schema.json", + "title": "Quantity", + "definitions": { + "Quantity": { + "$id": "#Quantity", + "type": "object", + "description": "An amount in a given unit", + "properties": { + "amount": { + "type": "number", + "format": "float", + "default": 1, + "description": "Numeric value in a given unit" + }, + "units": { + "type": "string", + "description": "Unit" + } + } } - } } - } } \ No newline at end of file diff --git a/Common/QuantityType.schema.json b/Common/QuantityType.schema.json index a24291a3..adc426fe 100644 --- a/Common/QuantityType.schema.json +++ b/Common/QuantityType.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuantityType.schema.json", - "title": "QuantityType", - "definitions": { - "QuantityType": { - "$id": "#QuantityType", - "description": "Representation of a quantity of something. I can also be used to represent a quantity range", - "properties": { - "amount": { - "type": "number", - "format": "decimal", - "description": "Measured amount" - }, - "units": { - "type": "string", - "description": "Units the quantity is measured in" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuantityType.schema.json", + "title": "QuantityType", + "definitions": { + "QuantityType": { + "$id": "#QuantityType", + "description": "Representation of a quantity of something. I can also be used to represent a quantity range", + "properties": { + "amount": { + "type": "number", + "format": "decimal", + "description": "Measured amount" + }, + "units": { + "type": "string", + "description": "Units the quantity is measured in" + } + }, + "required": [ + "units", + "amount" + ], + "type": "object" } - }, - "required": [ - "units", - "amount" - ], - "type": "object" } - } } \ No newline at end of file diff --git a/Common/RatedProductUsage.schema.json b/Common/RatedProductUsage.schema.json index ca2a91f4..423033ff 100644 --- a/Common/RatedProductUsage.schema.json +++ b/Common/RatedProductUsage.schema.json @@ -1,72 +1,72 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RatedProductUsage.schema.json", - "title": "RatedProductUsage", - "definitions": { - "RatedProductUsage": { - "$id": "#RatedProductUsage", - "description": "An occurrence of employing a product for its intended purpose with all rating details", - "type": "object", - "properties": { - "bucketValueConvertedInAmount": { - "type": "number", - "format": "float", - "description": "Monetary value of bucket" - }, - "currencyCode": { - "type": "string", - "description": "A string used as a code for specifying the currency associated to the given amounts. The ISO4217 norm uses 3 letters to define the currency (for example USD for US dollar or EUR for Euro)" - }, - "isBilled": { - "type": "boolean", - "description": "Boolean indicating if usage have been billed or not" - }, - "isTaxExempt": { - "type": "boolean", - "description": "Indicates if the rated amount is exempt of tax" - }, - "offerTariffType": { - "type": "string", - "description": "Type of tariff applied" - }, - "productRef": { - "type": "string", - "description": "Reference of product specification" - }, - "ratingAmountType": { - "type": "string", - "description": "Type of amount" - }, - "ratingDate": { - "type": "string", - "format": "date-time", - "description": "Date of usage rating" - }, - "taxExcludedRatingAmount": { - "type": "number", - "format": "float", - "description": "All taxes excluded rated amount" - }, - "taxIncludedRatingAmount": { - "type": "number", - "format": "float", - "description": "All taxes included rated amount" - }, - "taxRate": { - "type": "number", - "format": "float", - "description": "Tax rate" - }, - "usageRatingTag": { - "type": "string", - "description": "Tag value: [usage]: the usage is always rated outside a usage bundle\n[included usage]: the usage is rated inside a usage bundle\n[non included usage]: the usage bundle is exhausted. The usage is rated outside the usage bundle" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RatedProductUsage.schema.json", + "title": "RatedProductUsage", + "definitions": { + "RatedProductUsage": { + "$id": "#RatedProductUsage", + "description": "An occurrence of employing a product for its intended purpose with all rating details", + "type": "object", + "properties": { + "bucketValueConvertedInAmount": { + "type": "number", + "format": "float", + "description": "Monetary value of bucket" + }, + "currencyCode": { + "type": "string", + "description": "A string used as a code for specifying the currency associated to the given amounts. The ISO4217 norm uses 3 letters to define the currency (for example USD for US dollar or EUR for Euro)" + }, + "isBilled": { + "type": "boolean", + "description": "Boolean indicating if usage have been billed or not" + }, + "isTaxExempt": { + "type": "boolean", + "description": "Indicates if the rated amount is exempt of tax" + }, + "offerTariffType": { + "type": "string", + "description": "Type of tariff applied" + }, + "productRef": { + "type": "string", + "description": "Reference of product specification" + }, + "ratingAmountType": { + "type": "string", + "description": "Type of amount" + }, + "ratingDate": { + "type": "string", + "format": "date-time", + "description": "Date of usage rating" + }, + "taxExcludedRatingAmount": { + "type": "number", + "format": "float", + "description": "All taxes excluded rated amount" + }, + "taxIncludedRatingAmount": { + "type": "number", + "format": "float", + "description": "All taxes included rated amount" + }, + "taxRate": { + "type": "number", + "format": "float", + "description": "Tax rate" + }, + "usageRatingTag": { + "type": "string", + "description": "Tag value: [usage]: the usage is always rated outside a usage bundle\n[included usage]: the usage is rated inside a usage bundle\n[non included usage]: the usage bundle is exhausted. The usage is rated outside the usage bundle" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/Receiver.schema.json b/Common/Receiver.schema.json index 03687cf8..bbe99c13 100644 --- a/Common/Receiver.schema.json +++ b/Common/Receiver.schema.json @@ -1,46 +1,46 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Receiver.schema.json", - "title": "Receiver", - "definitions": { - "Receiver": { - "$id": "#Receiver", - "description": "Receivers of the communication message.", - "type": "object", - "properties": { - "appUserId": { - "type": "string", - "description": "ID of the mobile app user" - }, - "email": { - "type": "string", - "description": "Receiver address of email, if the communication type is email" - }, - "id": { - "type": "string", - "description": "ID of the receiver" - }, - "ip": { - "type": "string", - "description": "IP address of the receiver" - }, - "name": { - "type": "string", - "description": "Name of the receiver" - }, - "phoneNumber": { - "type": "string", - "description": "Phone number of the receiver, if the communication type is SMS." - }, - "party": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Receiver.schema.json", + "title": "Receiver", + "definitions": { + "Receiver": { + "$id": "#Receiver", + "description": "Receivers of the communication message.", + "type": "object", + "properties": { + "appUserId": { + "type": "string", + "description": "ID of the mobile app user" + }, + "email": { + "type": "string", + "description": "Receiver address of email, if the communication type is email" + }, + "id": { + "type": "string", + "description": "ID of the receiver" + }, + "ip": { + "type": "string", + "description": "IP address of the receiver" + }, + "name": { + "type": "string", + "description": "Name of the receiver" + }, + "phoneNumber": { + "type": "string", + "description": "Phone number of the receiver, if the communication type is SMS." + }, + "party": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/ReceiverRef.schema.json b/Common/ReceiverRef.schema.json index 4dd7bd25..e83f2ef8 100644 --- a/Common/ReceiverRef.schema.json +++ b/Common/ReceiverRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ReceiverRef.schema.json", - "title": "ReceiverRef", - "definitions": { - "ReceiverRef": { - "$id": "#ReceiverRef", - "description": "Receiver reference. The receiver is the party role who will receive the settlement note.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the receiver" - }, - "id": { - "type": "string", - "description": "Identifier of the receiver" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ReceiverRef.schema.json", + "title": "ReceiverRef", + "definitions": { + "ReceiverRef": { + "$id": "#ReceiverRef", + "description": "Receiver reference. The receiver is the party role who will receive the settlement note.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the receiver" + }, + "id": { + "type": "string", + "description": "Identifier of the receiver" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/Record.schema.json b/Common/Record.schema.json index bde25712..80a744fc 100644 --- a/Common/Record.schema.json +++ b/Common/Record.schema.json @@ -1,32 +1,32 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Record.schema.json", - "title": "Record", - "definitions": { - "Record": { - "$id": "#Record", - "description": "A record in a worklog.", - "type": "object", - "properties": { - "dateTime": { - "type": "string", - "format": "date-time", - "description": "The date time that a record is generated." - }, - "description": { - "type": "string", - "description": "The detail description in a record." - }, - "supportPerson": { - "type": "string", - "description": "The person who logged that record." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Record.schema.json", + "title": "Record", + "definitions": { + "Record": { + "$id": "#Record", + "description": "A record in a worklog.", + "type": "object", + "properties": { + "dateTime": { + "type": "string", + "format": "date-time", + "description": "The date time that a record is generated." + }, + "description": { + "type": "string", + "description": "The detail description in a record." + }, + "supportPerson": { + "type": "string", + "description": "The person who logged that record." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/RelatedChangeRequestRef.schema.json b/Common/RelatedChangeRequestRef.schema.json index 9e446655..fa553b15 100644 --- a/Common/RelatedChangeRequestRef.schema.json +++ b/Common/RelatedChangeRequestRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedChangeRequestRef.schema.json", - "title": "RelatedChangeRequestRef", - "definitions": { - "RelatedChangeRequestRef": { - "$id": "#RelatedChangeRequestRef", - "description": "An existing Change Request that has some form of correlation with the given Change Request.", - "type": "object", - "properties": { - "correlation": { - "type": "string", - "description": "The correlation between two change requests" - }, - "description": { - "type": "string", - "description": "Description of a change request." - }, - "href": { - "type": "string", - "description": "Hyper link to access a change request." - }, - "id": { - "type": "string", - "description": "Identifier of an Change Request" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedChangeRequestRef.schema.json", + "title": "RelatedChangeRequestRef", + "definitions": { + "RelatedChangeRequestRef": { + "$id": "#RelatedChangeRequestRef", + "description": "An existing Change Request that has some form of correlation with the given Change Request.", + "type": "object", + "properties": { + "correlation": { + "type": "string", + "description": "The correlation between two change requests" + }, + "description": { + "type": "string", + "description": "Description of a change request." + }, + "href": { + "type": "string", + "description": "Hyper link to access a change request." + }, + "id": { + "type": "string", + "description": "Identifier of an Change Request" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/RelatedChannel.schema.json b/Common/RelatedChannel.schema.json index ef4b080f..c1d5f63c 100644 --- a/Common/RelatedChannel.schema.json +++ b/Common/RelatedChannel.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedChannel.schema.json", - "title": "RelatedChannel", - "definitions": { - "RelatedChannel": { - "$id": "#RelatedChannel", - "type": "object", - "description": "Related channel to another entity. May be online web, mobile app, social ,etc.", - "properties": { - "name": { - "type": "string", - "description": "Name of the channel." - }, - "role": { - "type": "string", - "description": "Role playing by the channel." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedChannel.schema.json", + "title": "RelatedChannel", + "definitions": { + "RelatedChannel": { + "$id": "#RelatedChannel", + "type": "object", + "description": "Related channel to another entity. May be online web, mobile app, social ,etc.", + "properties": { + "name": { + "type": "string", + "description": "Name of the channel." + }, + "role": { + "type": "string", + "description": "Role playing by the channel." + } + }, + "allOf": [ + { + "$ref": "EntityRef.schema.json#EntityRef" + } + ] } - }, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" - } - ] } - } } \ No newline at end of file diff --git a/Common/RelatedEntity.schema.json b/Common/RelatedEntity.schema.json index b8dcac70..50459906 100644 --- a/Common/RelatedEntity.schema.json +++ b/Common/RelatedEntity.schema.json @@ -1,28 +1,28 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedEntity.schema.json", - "title": "RelatedEntity", - "definitions": { - "RelatedEntity": { - "$id": "#RelatedEntity", - "description": "A reference to an entity, where the type of the entity is not known in advance.", - "type": "object", - "required": [ - "id", - "role", - "@referredType" - ], - "properties": { - "role": { - "type": "string", - "description": "The role of an entity." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedEntity.schema.json", + "title": "RelatedEntity", + "definitions": { + "RelatedEntity": { + "$id": "#RelatedEntity", + "description": "A reference to an entity, where the type of the entity is not known in advance.", + "type": "object", + "required": [ + "id", + "role", + "@referredType" + ], + "properties": { + "role": { + "type": "string", + "description": "The role of an entity." + } + }, + "allOf": [ + { + "$ref": "EntityRef.schema.json#EntityRef" + } + ] } - }, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" - } - ] } - } } \ No newline at end of file diff --git a/Common/RelatedEntityRef.schema.json b/Common/RelatedEntityRef.schema.json index d64ea908..a78e480b 100644 --- a/Common/RelatedEntityRef.schema.json +++ b/Common/RelatedEntityRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedEntityRef.schema.json", - "title": "RelatedEntityRef", - "definitions": { - "RelatedEntityRef": { - "$id": "#RelatedEntityRef", - "description": "A reference to an entity, where the type of the entity is not known in advance.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The hyperlink to access an entity." - }, - "id": { - "type": "string", - "description": "The identifier of an entity." - }, - "name": { - "type": "string", - "description": "The name of an entity." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedEntityRef.schema.json", + "title": "RelatedEntityRef", + "definitions": { + "RelatedEntityRef": { + "$id": "#RelatedEntityRef", + "description": "A reference to an entity, where the type of the entity is not known in advance.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The hyperlink to access an entity." + }, + "id": { + "type": "string", + "description": "The identifier of an entity." + }, + "name": { + "type": "string", + "description": "The name of an entity." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/RelatedGeographicAddressRefOrValue.schema.json b/Common/RelatedGeographicAddressRefOrValue.schema.json index e9c66820..7118427e 100644 --- a/Common/RelatedGeographicAddressRefOrValue.schema.json +++ b/Common/RelatedGeographicAddressRefOrValue.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedGeographicAddressRefOrValue.schema.json", - "title": "RelatedGeographicAddressRefOrValue", - "definitions": { - "RelatedGeographicAddressRefOrValue": { - "discriminator": "isRef", - "$id": "#RelatedGeographicAddressRefOrValue", - "description": "#TODO", - "type": "object", - "properties": { - "isRef": { - "type": "boolean", - "default": true - }, - "role": { - "type": "string" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedGeographicAddressRefOrValue.schema.json", + "title": "RelatedGeographicAddressRefOrValue", + "definitions": { + "RelatedGeographicAddressRefOrValue": { + "discriminator": "isRef", + "$id": "#RelatedGeographicAddressRefOrValue", + "description": "#TODO", + "type": "object", + "properties": { + "isRef": { + "type": "boolean", + "default": true + }, + "role": { + "type": "string" + } + }, + "required": [ + "role" + ], + "allOf": [ + { + "$ref": "RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" + } + ] } - }, - "required": [ - "role" - ], - "allOf": [ - { - "$ref": "RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" - } - ] } - } } \ No newline at end of file diff --git a/Common/RelatedGeographicLocationRefOrValue.schema.json b/Common/RelatedGeographicLocationRefOrValue.schema.json index d28e6ba4..c336aa94 100644 --- a/Common/RelatedGeographicLocationRefOrValue.schema.json +++ b/Common/RelatedGeographicLocationRefOrValue.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedGeographicLocationRefOrValue.schema.json", - "title": "RelatedGeographicLocationRefOrValue", - "definitions": { - "RelatedGeographicLocationRefOrValue": { - "discriminator": "isRef", - "$id": "#RelatedGeographicLocationRefOrValue", - "description": "#TODO", - "type": "object", - "properties": { - "isRef": { - "type": "boolean", - "default": true - }, - "role": { - "type": "string" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedGeographicLocationRefOrValue.schema.json", + "title": "RelatedGeographicLocationRefOrValue", + "definitions": { + "RelatedGeographicLocationRefOrValue": { + "discriminator": "isRef", + "$id": "#RelatedGeographicLocationRefOrValue", + "description": "#TODO", + "type": "object", + "properties": { + "isRef": { + "type": "boolean", + "default": true + }, + "role": { + "type": "string" + } + }, + "required": [ + "role" + ], + "allOf": [ + { + "$ref": "RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" + } + ] } - }, - "required": [ - "role" - ], - "allOf": [ - { - "$ref": "RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" - } - ] } - } } \ No newline at end of file diff --git a/Common/RelatedObject.schema.json b/Common/RelatedObject.schema.json index fe941c74..d9872e75 100644 --- a/Common/RelatedObject.schema.json +++ b/Common/RelatedObject.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedObject.schema.json", - "title": "RelatedObject", - "definitions": { - "RelatedObject": { - "$id": "#RelatedObject", - "description": "Defines objects linked with trouble ticket.", - "type": "object", - "properties": { - "involvement": { - "type": "string", - "description": "Consequence of the ticket on the related object (for instance disputed, adjusted...)" - }, - "reference": { - "type": "string", - "description": "Reference of object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedObject.schema.json", + "title": "RelatedObject", + "definitions": { + "RelatedObject": { + "$id": "#RelatedObject", + "description": "Defines objects linked with trouble ticket.", + "type": "object", + "properties": { + "involvement": { + "type": "string", + "description": "Consequence of the ticket on the related object (for instance disputed, adjusted...)" + }, + "reference": { + "type": "string", + "description": "Reference of object" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/RelatedPlace.schema.json b/Common/RelatedPlace.schema.json index e02be4b3..98388f55 100644 --- a/Common/RelatedPlace.schema.json +++ b/Common/RelatedPlace.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedPlace.schema.json", - "title": "RelatedPlace", - "definitions": { - "RelatedPlace": { - "$id": "#RelatedPlace", - "description": "A Place and an associated role as installation adress, delivery address, etc....", - "type": "object", - "properties": { - "role": { - "type": "string", - "description": "Role of the place, such as: [home delivery], [shop retrieval])" - }, - "href": { - "type": "string", - "description": "Unique reference of the place" - }, - "id": { - "type": "string", - "description": "Unique identifier of the place" - }, - "name": { - "type": "string", - "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedPlace.schema.json", + "title": "RelatedPlace", + "definitions": { + "RelatedPlace": { + "$id": "#RelatedPlace", + "description": "A Place and an associated role as installation adress, delivery address, etc....", + "type": "object", + "properties": { + "role": { + "type": "string", + "description": "Role of the place, such as: [home delivery], [shop retrieval])" + }, + "href": { + "type": "string", + "description": "Unique reference of the place" + }, + "id": { + "type": "string", + "description": "Unique identifier of the place" + }, + "name": { + "type": "string", + "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/RelatedPlaceRefOrValue.schema.json b/Common/RelatedPlaceRefOrValue.schema.json index 8aa31549..ffea8747 100644 --- a/Common/RelatedPlaceRefOrValue.schema.json +++ b/Common/RelatedPlaceRefOrValue.schema.json @@ -1,29 +1,29 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedPlaceRefOrValue.schema.json", - "title": "RelatedPlaceRefOrValue", - "definitions": { - "RelatedPlaceRefOrValue": { - "discriminator": "isRef", - "$id": "#RelatedPlaceRefOrValue", - "description": "Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself", - "type": "object", - "properties": { - "role": { - "type": "string" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedPlaceRefOrValue.schema.json", + "title": "RelatedPlaceRefOrValue", + "definitions": { + "RelatedPlaceRefOrValue": { + "discriminator": "isRef", + "$id": "#RelatedPlaceRefOrValue", + "description": "Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself", + "type": "object", + "properties": { + "role": { + "type": "string" + } + }, + "required": [ + "role" + ], + "allOf": [ + { + "$ref": "PlaceRef.schema.json#PlaceRef" + }, + { + "$ref": "Place.schema.json#Place" + } + ] } - }, - "required": [ - "role" - ], - "allOf": [ - { - "$ref": "PlaceRef.schema.json#PlaceRef" - }, - { - "$ref": "Place.schema.json#Place" - } - ] } - } } \ No newline at end of file diff --git a/Common/Request.schema.json b/Common/Request.schema.json index dbc629f0..0e90eb96 100644 --- a/Common/Request.schema.json +++ b/Common/Request.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Request.schema.json", - "title": "Request", - "definitions": { - "Request": { - "$id": "#Request", - "type": "object", - "description": "A response to a request", - "properties": { - "body": { - "description": "The body of the request. For example for an HTTP request might contain content of a form .", - "type": "string" - }, - "header": { - "type": "array", - "description": "Items included in the header of the request. For example for an HTTP request might contain requested locale, basic authentication.", - "items": { - "$ref": "HeaderItem.schema.json#HeaderItem" - }, - "title": "header" - }, - "method": { - "description": "The protocol of the request, e.g. http", - "type": "string" - }, - "to": { - "description": "The target of the request, e.g. a URL for an HTTP request", - "type": "string" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Request.schema.json", + "title": "Request", + "definitions": { + "Request": { + "$id": "#Request", + "type": "object", + "description": "A response to a request", + "properties": { + "body": { + "description": "The body of the request. For example for an HTTP request might contain content of a form .", + "type": "string" + }, + "header": { + "type": "array", + "description": "Items included in the header of the request. For example for an HTTP request might contain requested locale, basic authentication.", + "items": { + "$ref": "HeaderItem.schema.json#HeaderItem" + }, + "title": "header" + }, + "method": { + "description": "The protocol of the request, e.g. http", + "type": "string" + }, + "to": { + "description": "The target of the request, e.g. a URL for an HTTP request", + "type": "string" + } + }, + "required": [ + "body", + "header" + ] } - }, - "required": [ - "body", - "header" - ] } - } } \ No newline at end of file diff --git a/Common/Resolution.schema.json b/Common/Resolution.schema.json index 0d9ccddf..5cdb7d73 100644 --- a/Common/Resolution.schema.json +++ b/Common/Resolution.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Resolution.schema.json", - "title": "Resolution", - "definitions": { - "Resolution": { - "$id": "#Resolution", - "description": "The way one or more change request has been implementation through a direct remedy or task", - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The resolutions code, it can be configured as a multiple level hierarchy" - }, - "description": { - "type": "string", - "description": "The description of the resolution" - }, - "name": { - "type": "string", - "description": "The name of the resolution" - }, - "task": { - "type": "array", - "items": { - "$ref": "Task.schema.json#Task" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Resolution.schema.json", + "title": "Resolution", + "definitions": { + "Resolution": { + "$id": "#Resolution", + "description": "The way one or more change request has been implementation through a direct remedy or task", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The resolutions code, it can be configured as a multiple level hierarchy" + }, + "description": { + "type": "string", + "description": "The description of the resolution" + }, + "name": { + "type": "string", + "description": "The name of the resolution" + }, + "task": { + "type": "array", + "items": { + "$ref": "Task.schema.json#Task" + } + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/Response.schema.json b/Common/Response.schema.json index 44014a32..15cbdccb 100644 --- a/Common/Response.schema.json +++ b/Common/Response.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Response.schema.json", - "title": "Response", - "definitions": { - "Response": { - "$id": "#Response", - "type": "object", - "description": "A response to a request", - "properties": { - "body": { - "description": "The body of the response. For example for an HTTP response might contain HTML for rendering.", - "type": "string" - }, - "header": { - "description": "Items included in the header of the response. For example for an HTTP response might contain negotiated locale.", - "type": "array", - "items": { - "$ref": "HeaderItem.schema.json#HeaderItem" - }, - "title": "header" - }, - "statusCode": { - "description": "The status of the response. For example for an HTTP response would be codes such as 200, 400, etc.", - "type": "string" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Response.schema.json", + "title": "Response", + "definitions": { + "Response": { + "$id": "#Response", + "type": "object", + "description": "A response to a request", + "properties": { + "body": { + "description": "The body of the response. For example for an HTTP response might contain HTML for rendering.", + "type": "string" + }, + "header": { + "description": "Items included in the header of the response. For example for an HTTP response might contain negotiated locale.", + "type": "array", + "items": { + "$ref": "HeaderItem.schema.json#HeaderItem" + }, + "title": "header" + }, + "statusCode": { + "description": "The status of the response. For example for an HTTP response would be codes such as 200, 400, etc.", + "type": "string" + } + }, + "required": [ + "body", + "header" + ] } - }, - "required": [ - "body", - "header" - ] } - } } \ No newline at end of file diff --git a/Common/RetrieveGeographicLocation.schema.json b/Common/RetrieveGeographicLocation.schema.json index 8e09cc7b..b8eebea3 100644 --- a/Common/RetrieveGeographicLocation.schema.json +++ b/Common/RetrieveGeographicLocation.schema.json @@ -1,41 +1,41 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RetrieveGeographicLocation.schema.json", - "title": "RetrieveGeographicLocation", - "definitions": { - "RetrieveGeographicLocation": { - "$id": "#RetrieveGeographicLocation", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "id": { - "type": "string" - }, - "requestedAccuracy": { - "type": "number", - "format": "float" - }, - "status": { - "type": "string" - }, - "time": { - "type": "string", - "format": "date-time" - }, - "geographicLocation": { - "$ref": "GeographicLocation.schema.json#GeographicLocation" - }, - "thing": { - "$ref": "Object.schema.json#Object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RetrieveGeographicLocation.schema.json", + "title": "RetrieveGeographicLocation", + "definitions": { + "RetrieveGeographicLocation": { + "$id": "#RetrieveGeographicLocation", + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "id": { + "type": "string" + }, + "requestedAccuracy": { + "type": "number", + "format": "float" + }, + "status": { + "type": "string" + }, + "time": { + "type": "string", + "format": "date-time" + }, + "geographicLocation": { + "$ref": "GeographicLocation.schema.json#GeographicLocation" + }, + "thing": { + "$ref": "Object.schema.json#Object" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/RetrieveLocationRelation.schema.json b/Common/RetrieveLocationRelation.schema.json index 667b9ee1..0b7818ee 100644 --- a/Common/RetrieveLocationRelation.schema.json +++ b/Common/RetrieveLocationRelation.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RetrieveLocationRelation.schema.json", - "title": "RetrieveLocationRelation", - "definitions": { - "RetrieveLocationRelation": { - "$id": "#RetrieveLocationRelation", - "type": "object", - "properties": { - "distance": { - "type": "string" - }, - "href": { - "type": "string" - }, - "id": { - "type": "string" - }, - "status": { - "type": "string" - }, - "time": { - "type": "string", - "format": "date-time" - }, - "intersection": { - "type": "array", - "items": { - "$ref": "GeographicLocation.schema.json#GeographicLocation" - } - }, - "location": { - "$ref": "GeographicLocationRef.schema.json#GeographicLocationRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RetrieveLocationRelation.schema.json", + "title": "RetrieveLocationRelation", + "definitions": { + "RetrieveLocationRelation": { + "$id": "#RetrieveLocationRelation", + "type": "object", + "properties": { + "distance": { + "type": "string" + }, + "href": { + "type": "string" + }, + "id": { + "type": "string" + }, + "status": { + "type": "string" + }, + "time": { + "type": "string", + "format": "date-time" + }, + "intersection": { + "type": "array", + "items": { + "$ref": "GeographicLocation.schema.json#GeographicLocation" + } + }, + "location": { + "$ref": "GeographicLocationRef.schema.json#GeographicLocationRef" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/Sender.schema.json b/Common/Sender.schema.json index 500c4049..9ae646cf 100644 --- a/Common/Sender.schema.json +++ b/Common/Sender.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Sender.schema.json", - "title": "Sender", - "definitions": { - "Sender": { - "$id": "#Sender", - "description": "Sender of the communication message.", - "type": "object", - "properties": { - "email": { - "type": "string", - "description": "Sender address of email, if the communication type is email" - }, - "id": { - "type": "string", - "description": "ID of the sender" - }, - "name": { - "type": "string", - "description": "Name of the sender" - }, - "phoneNumber": { - "type": "string", - "description": "Phone number of the sender, if the communication type is SMS." - }, - "party": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Sender.schema.json", + "title": "Sender", + "definitions": { + "Sender": { + "$id": "#Sender", + "description": "Sender of the communication message.", + "type": "object", + "properties": { + "email": { + "type": "string", + "description": "Sender address of email, if the communication type is email" + }, + "id": { + "type": "string", + "description": "ID of the sender" + }, + "name": { + "type": "string", + "description": "Name of the sender" + }, + "phoneNumber": { + "type": "string", + "description": "Phone number of the sender, if the communication type is SMS." + }, + "party": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/SiteRelationship.schema.json b/Common/SiteRelationship.schema.json index 92fd3be6..d6b8ce45 100644 --- a/Common/SiteRelationship.schema.json +++ b/Common/SiteRelationship.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SiteRelationship.schema.json", - "title": "SiteRelationship", - "definitions": { - "SiteRelationship": { - "$id": "#SiteRelationship", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the related site" - }, - "id": { - "type": "string", - "description": "Unique identifier of the related site entity within the server" - }, - "role": { - "type": "string", - "description": "Role of the related site in the relationship" - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "Validity for the relationship" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SiteRelationship.schema.json", + "title": "SiteRelationship", + "definitions": { + "SiteRelationship": { + "$id": "#SiteRelationship", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the related site" + }, + "id": { + "type": "string", + "description": "Unique identifier of the related site entity within the server" + }, + "role": { + "type": "string", + "description": "Role of the related site in the relationship" + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "Validity for the relationship" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/SpecCharRelationship.schema.json b/Common/SpecCharRelationship.schema.json index 828f907c..f20d4964 100644 --- a/Common/SpecCharRelationship.schema.json +++ b/Common/SpecCharRelationship.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SpecCharRelationship.schema.json", - "title": "SpecCharRelationship", - "definitions": { - "SpecCharRelationship": { - "$id": "#SpecCharRelationship", - "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink reference to the target entity specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the target entity specification" - }, - "name": { - "type": "string", - "description": "Name of the target specCharacteristic" - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which the SpecCharRelationship is valid" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SpecCharRelationship.schema.json", + "title": "SpecCharRelationship", + "definitions": { + "SpecCharRelationship": { + "$id": "#SpecCharRelationship", + "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink reference to the target entity specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the target entity specification" + }, + "name": { + "type": "string", + "description": "Name of the target specCharacteristic" + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which the SpecCharRelationship is valid" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/SpecCharacteristic.schema.json b/Common/SpecCharacteristic.schema.json index 7875d3ee..a1cd39f6 100644 --- a/Common/SpecCharacteristic.schema.json +++ b/Common/SpecCharacteristic.schema.json @@ -1,51 +1,51 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SpecCharacteristic.schema.json", - "title": "SpecCharacteristic", - "definitions": { - "SpecCharacteristic": { - "$id": "#SpecCharacteristic", - "description": "A characteristic quality or distinctive feature of a Specification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", - "type": "object", - "properties": { - "configurable": { - "type": "boolean", - "description": "If true, the Boolean indicates that the SpecCharacteristic is configurable" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the SpecCharacteristic is" - }, - "name": { - "type": "string", - "description": "Name of the SpecCharacteristic" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productSpecCharacteristic is valid" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" - }, - "specCharacteristicValue": { - "type": "array", - "items": { - "$ref": "SpecCharacteristicValue.schema.json#SpecCharacteristicValue" - } - }, - "specCharRelationship": { - "type": "array", - "items": { - "$ref": "SpecCharRelationship.schema.json#SpecCharRelationship" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SpecCharacteristic.schema.json", + "title": "SpecCharacteristic", + "definitions": { + "SpecCharacteristic": { + "$id": "#SpecCharacteristic", + "description": "A characteristic quality or distinctive feature of a Specification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", + "type": "object", + "properties": { + "configurable": { + "type": "boolean", + "description": "If true, the Boolean indicates that the SpecCharacteristic is configurable" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the SpecCharacteristic is" + }, + "name": { + "type": "string", + "description": "Name of the SpecCharacteristic" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productSpecCharacteristic is valid" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" + }, + "specCharacteristicValue": { + "type": "array", + "items": { + "$ref": "SpecCharacteristicValue.schema.json#SpecCharacteristicValue" + } + }, + "specCharRelationship": { + "type": "array", + "items": { + "$ref": "SpecCharRelationship.schema.json#SpecCharRelationship" + } + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/SpecCharacteristicValue.schema.json b/Common/SpecCharacteristicValue.schema.json index 3bb3d55f..eb3efaed 100644 --- a/Common/SpecCharacteristicValue.schema.json +++ b/Common/SpecCharacteristicValue.schema.json @@ -1,55 +1,55 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SpecCharacteristicValue.schema.json", - "title": "SpecCharacteristicValue", - "definitions": { - "SpecCharacteristicValue": { - "$id": "#SpecCharacteristicValue", - "description": "A number or text that can be assigned to a SpecCharacteristic", - "type": "object", - "properties": { - "isDefault": { - "type": "boolean", - "description": "If true, the Boolean Indicates if the value is the default value for a characteristic" - }, - "rangeInterval": { - "type": "string", - "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." - }, - "regex": { - "type": "string", - "description": "A regular expression constraint for given value" - }, - "unitOfMeasure": { - "type": "string", - "description": "unit of measure for the valueCould be minutes, GB, etc" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which this object is valid" - }, - "value": { - "$ref": "Object.schema.json#Object", - "description": "the value that the characteristic can take on." - }, - "valueFrom": { - "type": "integer", - "description": "The low range value that a characteristic can take on" - }, - "valueTo": { - "type": "integer", - "description": "The upper range value that a characteristic can take on" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic value can take on, such as numeric, text and so forth" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SpecCharacteristicValue.schema.json", + "title": "SpecCharacteristicValue", + "definitions": { + "SpecCharacteristicValue": { + "$id": "#SpecCharacteristicValue", + "description": "A number or text that can be assigned to a SpecCharacteristic", + "type": "object", + "properties": { + "isDefault": { + "type": "boolean", + "description": "If true, the Boolean Indicates if the value is the default value for a characteristic" + }, + "rangeInterval": { + "type": "string", + "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." + }, + "regex": { + "type": "string", + "description": "A regular expression constraint for given value" + }, + "unitOfMeasure": { + "type": "string", + "description": "unit of measure for the valueCould be minutes, GB, etc" + }, + "validFor": { + "$ref": "TimePeriod.schema.json#TimePeriod", + "description": "The period for which this object is valid" + }, + "value": { + "$ref": "Object.schema.json#Object", + "description": "the value that the characteristic can take on." + }, + "valueFrom": { + "type": "integer", + "description": "The low range value that a characteristic can take on" + }, + "valueTo": { + "type": "integer", + "description": "The upper range value that a characteristic can take on" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic value can take on, such as numeric, text and so forth" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/StatusChange.schema.json b/Common/StatusChange.schema.json index f2d23f89..7f52bf2e 100644 --- a/Common/StatusChange.schema.json +++ b/Common/StatusChange.schema.json @@ -1,32 +1,32 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "StatusChange.schema.json", - "title": "StatusChange", - "definitions": { - "StatusChange": { - "$id": "#StatusChange", - "type": "object", - "description": "Holds the status notification reasons and associated date the status changed, populated by the server", - "properties": { - "changeDate": { - "type": "string", - "format": "date-time", - "description": "The date and time the status changed." - }, - "changeReason": { - "type": "string", - "description": "The reason why the status changed." - }, - "status": { - "type": "string", - "description": "The status of the trouble ticket" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "StatusChange.schema.json", + "title": "StatusChange", + "definitions": { + "StatusChange": { + "$id": "#StatusChange", + "type": "object", + "description": "Holds the status notification reasons and associated date the status changed, populated by the server", + "properties": { + "changeDate": { + "type": "string", + "format": "date-time", + "description": "The date and time the status changed." + }, + "changeReason": { + "type": "string", + "description": "The reason why the status changed." + }, + "status": { + "type": "string", + "description": "The status of the trouble ticket" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/Street.schema.json b/Common/Street.schema.json index a9f08b34..ef9dd6aa 100644 --- a/Common/Street.schema.json +++ b/Common/Street.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Street.schema.json", - "title": "Street", - "definitions": { - "Street": { - "$id": "#Street", - "description": "A street is a road in a city or locality that has buildings that are usually close together along one or both sides", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the Street" - }, - "name": { - "type": "string", - "description": "The defined name of the street" - }, - "streetType": { - "type": "string", - "description": "Alley, avenue, etc." - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "LocationCharacteristic.schema.json#LocationCharacteristic" - } - }, - "address": { - "type": "array", - "items": { - "$ref": "AddressRef.schema.json#AddressRef" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Street.schema.json", + "title": "Street", + "definitions": { + "Street": { + "$id": "#Street", + "description": "A street is a road in a city or locality that has buildings that are usually close together along one or both sides", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the Street" + }, + "name": { + "type": "string", + "description": "The defined name of the street" + }, + "streetType": { + "type": "string", + "description": "Alley, avenue, etc." + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "LocationCharacteristic.schema.json#LocationCharacteristic" + } + }, + "address": { + "type": "array", + "items": { + "$ref": "AddressRef.schema.json#AddressRef" + } + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/StreetSegment.schema.json b/Common/StreetSegment.schema.json index 5e770d09..421a1add 100644 --- a/Common/StreetSegment.schema.json +++ b/Common/StreetSegment.schema.json @@ -1,42 +1,42 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "StreetSegment.schema.json", - "title": "StreetSegment", - "definitions": { - "StreetSegment": { - "$id": "#StreetSegment", - "description": "StreetSegment corresponds to a part of a street referenced by a number or a set of number. Sometimes a suffix is added.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the Street Segment" - }, - "number": { - "type": "string", - "description": "number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" - }, - "numberLast": { - "type": "string", - "description": "the last number in a range of street numbers allocated to a property" - }, - "numberLastSuffix": { - "type": "string", - "description": "the last street number suffix for a ranged address" - }, - "numberSuffix": { - "type": "string", - "description": "the first street number suffix" - }, - "address": { - "$ref": "AddressRef.schema.json#AddressRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "StreetSegment.schema.json", + "title": "StreetSegment", + "definitions": { + "StreetSegment": { + "$id": "#StreetSegment", + "description": "StreetSegment corresponds to a part of a street referenced by a number or a set of number. Sometimes a suffix is added.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the Street Segment" + }, + "number": { + "type": "string", + "description": "number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" + }, + "numberLast": { + "type": "string", + "description": "the last number in a range of street numbers allocated to a property" + }, + "numberLastSuffix": { + "type": "string", + "description": "the last street number suffix for a ranged address" + }, + "numberSuffix": { + "type": "string", + "description": "the first street number suffix" + }, + "address": { + "$ref": "AddressRef.schema.json#AddressRef" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/StringCharacteristic.schema.json b/Common/StringCharacteristic.schema.json index e5c3b635..772a232c 100644 --- a/Common/StringCharacteristic.schema.json +++ b/Common/StringCharacteristic.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "StringCharacteristic.schema.json", - "title": "StringCharacteristic", - "definitions": { - "StringCharacteristic": { - "$id": "#StringCharacteristic", - "description": "A characteristic which value is a string", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "valueType": { - "type": "string", - "description": "Data type of the value of the characteristic" - }, - "value": { - "type": "string", - "description": "Value of the characteristic" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "StringCharacteristic.schema.json", + "title": "StringCharacteristic", + "definitions": { + "StringCharacteristic": { + "$id": "#StringCharacteristic", + "description": "A characteristic which value is a string", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "valueType": { + "type": "string", + "description": "Data type of the value of the characteristic" + }, + "value": { + "type": "string", + "description": "Value of the characteristic" + } + } } - } } - } } \ No newline at end of file diff --git a/Common/SubAddress.schema.json b/Common/SubAddress.schema.json index 11340c5a..a5c43fa5 100644 --- a/Common/SubAddress.schema.json +++ b/Common/SubAddress.schema.json @@ -1,62 +1,62 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SubAddress.schema.json", - "title": "SubAddress", - "definitions": { - "SubAddress": { - "$id": "#SubAddress", - "description": "Representation of a SubAddress \nIt is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.", - "type": "object", - "properties": { - "buildingName": { - "type": "string", - "description": "Allows for buildings that have well-known names" - }, - "href": { - "type": "string" - }, - "id": { - "type": "string", - "description": "Unique ID for this SubAddress" - }, - "levelNumber": { - "type": "string", - "description": "Used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2" - }, - "levelType": { - "type": "string", - "description": "Describes level types within a building" - }, - "name": { - "type": "string", - "description": "Name of the subAddress to identify it with a meaningful identification" - }, - "privateStreetName": { - "type": "string", - "description": "Private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office." - }, - "privateStreetNumber": { - "type": "string", - "description": "Private streets numbers internal to a private street" - }, - "subUnitNumber": { - "type": "string", - "description": "The discriminator of the subunit, often just a simple number e.g. FLAT 5, may also be a range" - }, - "subUnitType": { - "type": "string", - "description": "The type of subunit, such as BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF" - }, - "subAddressType": { - "type": "string", - "description": "The type of subaddress : it can be a subunit or a private street" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SubAddress.schema.json", + "title": "SubAddress", + "definitions": { + "SubAddress": { + "$id": "#SubAddress", + "description": "Representation of a SubAddress \nIt is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.", + "type": "object", + "properties": { + "buildingName": { + "type": "string", + "description": "Allows for buildings that have well-known names" + }, + "href": { + "type": "string" + }, + "id": { + "type": "string", + "description": "Unique ID for this SubAddress" + }, + "levelNumber": { + "type": "string", + "description": "Used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2" + }, + "levelType": { + "type": "string", + "description": "Describes level types within a building" + }, + "name": { + "type": "string", + "description": "Name of the subAddress to identify it with a meaningful identification" + }, + "privateStreetName": { + "type": "string", + "description": "Private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office." + }, + "privateStreetNumber": { + "type": "string", + "description": "Private streets numbers internal to a private street" + }, + "subUnitNumber": { + "type": "string", + "description": "The discriminator of the subunit, often just a simple number e.g. FLAT 5, may also be a range" + }, + "subUnitType": { + "type": "string", + "description": "The type of subunit, such as BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF" + }, + "subAddressType": { + "type": "string", + "description": "The type of subaddress : it can be a subunit or a private street" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/TargetEntityRef.schema.json b/Common/TargetEntityRef.schema.json index 801abf74..4b78a3f3 100644 --- a/Common/TargetEntityRef.schema.json +++ b/Common/TargetEntityRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TargetEntityRef.schema.json", - "title": "TargetEntityRef", - "definitions": { - "TargetEntityRef": { - "$id": "#TargetEntityRef", - "description": "The entity which will be changed or configured while the change request is executed.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description to the related party." - }, - "href": { - "type": "string", - "description": "Hyperlink to access the target entity." - }, - "id": { - "type": "string", - "description": "Identifier of target entity" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TargetEntityRef.schema.json", + "title": "TargetEntityRef", + "definitions": { + "TargetEntityRef": { + "$id": "#TargetEntityRef", + "description": "The entity which will be changed or configured while the change request is executed.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description to the related party." + }, + "href": { + "type": "string", + "description": "Hyperlink to access the target entity." + }, + "id": { + "type": "string", + "description": "Identifier of target entity" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/Task.schema.json b/Common/Task.schema.json index 579300e3..a647fba1 100644 --- a/Common/Task.schema.json +++ b/Common/Task.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Task.schema.json", - "title": "Task", - "definitions": { - "Task": { - "$id": "#Task", - "description": "A step or task along in the process of implementation a Change Request.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description of the task." - }, - "name": { - "type": "string", - "description": "The name of the task." - }, - "state": { - "type": "string", - "description": "The state of the task." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Task.schema.json", + "title": "Task", + "definitions": { + "Task": { + "$id": "#Task", + "description": "A step or task along in the process of implementation a Change Request.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of the task." + }, + "name": { + "type": "string", + "description": "The name of the task." + }, + "state": { + "type": "string", + "description": "The state of the task." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/TaskFlow.schema.json b/Common/TaskFlow.schema.json index 9b88998c..3e6e1145 100644 --- a/Common/TaskFlow.schema.json +++ b/Common/TaskFlow.schema.json @@ -1,85 +1,85 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaskFlow.schema.json", - "title": "TaskFlow", - "definitions": { - "TaskFlow": { - "$id": "#TaskFlow", - "type": "object", - "properties": { - "channel": { - "type": "array", - "items": { - "$ref": "ChannelRef.schema.json#ChannelRef" - }, - "description": "A list of channel(s) where this taskFlow is executed" - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "Characteristic.schema.json#Characteristic" - }, - "description": "A list of characteristic(s) associated to this taskFlow" - }, - "completionMethod": { - "type": "string", - "description": "TaskFlow completion method." - }, - "href": { - "type": "string", - "description": "Reference of the taskFlow" - }, - "id": { - "type": "string", - "description": "Identifier of the taskFlow" - }, - "isMandatory": { - "type": "boolean", - "description": "Indicate mandatory TaskFlow." - }, - "priority": { - "type": "integer", - "description": "TaskFlow priority." - }, - "processFlowId": { - "type": "string", - "description": "Identifier of the processFlow" - }, - "relatedEntity": { - "type": "array", - "items": { - "$ref": "RelatedEntity.schema.json#RelatedEntity" - }, - "description": "A list of related entity(ies) to this taskFlow" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "description": "A list of related party(ies) to this task" - }, - "state": { - "$ref": "TaskFlowStateType.schema.json#TaskFlowStateType", - "description": "State of the taskFlow: described in the state machine diagram." - }, - "taskFlowRelationship": { - "type": "array", - "items": { - "$ref": "TaskFlowRelationship.schema.json#TaskFlowRelationship" - }, - "description": "A list of taskFlows related to this taskFlow" - }, - "taskFlowSpecification": { - "type": "string", - "description": "Specification of the taskFlow." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaskFlow.schema.json", + "title": "TaskFlow", + "definitions": { + "TaskFlow": { + "$id": "#TaskFlow", + "type": "object", + "properties": { + "channel": { + "type": "array", + "items": { + "$ref": "ChannelRef.schema.json#ChannelRef" + }, + "description": "A list of channel(s) where this taskFlow is executed" + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "Characteristic.schema.json#Characteristic" + }, + "description": "A list of characteristic(s) associated to this taskFlow" + }, + "completionMethod": { + "type": "string", + "description": "TaskFlow completion method." + }, + "href": { + "type": "string", + "description": "Reference of the taskFlow" + }, + "id": { + "type": "string", + "description": "Identifier of the taskFlow" + }, + "isMandatory": { + "type": "boolean", + "description": "Indicate mandatory TaskFlow." + }, + "priority": { + "type": "integer", + "description": "TaskFlow priority." + }, + "processFlowId": { + "type": "string", + "description": "Identifier of the processFlow" + }, + "relatedEntity": { + "type": "array", + "items": { + "$ref": "RelatedEntity.schema.json#RelatedEntity" + }, + "description": "A list of related entity(ies) to this taskFlow" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "A list of related party(ies) to this task" + }, + "state": { + "$ref": "TaskFlowStateType.schema.json#TaskFlowStateType", + "description": "State of the taskFlow: described in the state machine diagram." + }, + "taskFlowRelationship": { + "type": "array", + "items": { + "$ref": "TaskFlowRelationship.schema.json#TaskFlowRelationship" + }, + "description": "A list of taskFlows related to this taskFlow" + }, + "taskFlowSpecification": { + "type": "string", + "description": "Specification of the taskFlow." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/TaskFlowRef.schema.json b/Common/TaskFlowRef.schema.json index d3711a7a..4b2a2e50 100644 --- a/Common/TaskFlowRef.schema.json +++ b/Common/TaskFlowRef.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaskFlowRef.schema.json", - "title": "TaskFlowRef", - "definitions": { - "TaskFlowRef": { - "$id": "#TaskFlowRef", - "type": "object", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "href": { - "type": "string", - "description": "Reference of the related entity." - }, - "id": { - "type": "string", - "description": "Unique identifier of a related entity." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaskFlowRef.schema.json", + "title": "TaskFlowRef", + "definitions": { + "TaskFlowRef": { + "$id": "#TaskFlowRef", + "type": "object", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "href": { + "type": "string", + "description": "Reference of the related entity." + }, + "id": { + "type": "string", + "description": "Unique identifier of a related entity." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/TaskFlowRelationship.schema.json b/Common/TaskFlowRelationship.schema.json index 0ecc084b..5578ba78 100644 --- a/Common/TaskFlowRelationship.schema.json +++ b/Common/TaskFlowRelationship.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaskFlowRelationship.schema.json", - "title": "TaskFlowRelationship", - "definitions": { - "TaskFlowRelationship": { - "$id": "#TaskFlowRelationship", - "description": "Describes relationship between taskFlow", - "type": "object", - "required": [ - "relationshipType", - "taskFlow" - ], - "properties": { - "relationshipType": { - "type": "string", - "description": "The type of taskFlow relationship (requires, triggers, etc.)" - }, - "taskFlow": { - "description": "The taskFlow being referred to", - "$ref": "TaskFlowRef.schema.json#TaskFlowRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaskFlowRelationship.schema.json", + "title": "TaskFlowRelationship", + "definitions": { + "TaskFlowRelationship": { + "$id": "#TaskFlowRelationship", + "description": "Describes relationship between taskFlow", + "type": "object", + "required": [ + "relationshipType", + "taskFlow" + ], + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of taskFlow relationship (requires, triggers, etc.)" + }, + "taskFlow": { + "description": "The taskFlow being referred to", + "$ref": "TaskFlowRef.schema.json#TaskFlowRef" + } + } } - } } - } } \ No newline at end of file diff --git a/Common/TaskFlowStateType.schema.json b/Common/TaskFlowStateType.schema.json index c6b640da..131384f8 100644 --- a/Common/TaskFlowStateType.schema.json +++ b/Common/TaskFlowStateType.schema.json @@ -1,19 +1,19 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaskFlowStateType.schema.json", - "title": "TaskFlowStateType", - "definitions": { - "TaskFlowStateType": { - "$id": "#TaskFlowStateType", - "type": "string", - "description": "Valid values for the lifecycle state of the taskFlow", - "enum": [ - "new", - "active", - "hold", - "cancelled", - "completed" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaskFlowStateType.schema.json", + "title": "TaskFlowStateType", + "definitions": { + "TaskFlowStateType": { + "$id": "#TaskFlowStateType", + "type": "string", + "description": "Valid values for the lifecycle state of the taskFlow", + "enum": [ + "new", + "active", + "hold", + "cancelled", + "completed" + ] + } } - } } \ No newline at end of file diff --git a/Common/TaskStateType.schema.json b/Common/TaskStateType.schema.json index ccd74dd2..592ca272 100644 --- a/Common/TaskStateType.schema.json +++ b/Common/TaskStateType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaskStateType.schema.json", - "title": "TaskStateType", - "definitions": { - "TaskStateType": { - "$id": "#TaskStateType", - "type": "string", - "description": "Possible values for the state of a task", - "enum": [ - "acknowledged", - "terminatedWithError", - "inProgress", - "done" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaskStateType.schema.json", + "title": "TaskStateType", + "definitions": { + "TaskStateType": { + "$id": "#TaskStateType", + "type": "string", + "description": "Possible values for the state of a task", + "enum": [ + "acknowledged", + "terminatedWithError", + "inProgress", + "done" + ] + } } - } } \ No newline at end of file diff --git a/Common/TaxDefinition.schema.json b/Common/TaxDefinition.schema.json index 73ea2b02..ed926fca 100644 --- a/Common/TaxDefinition.schema.json +++ b/Common/TaxDefinition.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaxDefinition.schema.json", - "title": "TaxDefinition", - "definitions": { - "TaxDefinition": { - "$id": "#TaxDefinition", - "type": "object", - "description": "Reference of a tax definition. A tax is levied by an authorized tax jurisdiction. There are many different types of tax (Federal Tax levied by the US Government, State Tax levied by the State of California,…).", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "id": { - "type": "string", - "description": "Unique identifier of the tax." - }, - "name": { - "type": "string", - "description": "Tax name." - }, - "taxType": { - "type": "string", - "description": "Type of the tax." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaxDefinition.schema.json", + "title": "TaxDefinition", + "definitions": { + "TaxDefinition": { + "$id": "#TaxDefinition", + "type": "object", + "description": "Reference of a tax definition. A tax is levied by an authorized tax jurisdiction. There are many different types of tax (Federal Tax levied by the US Government, State Tax levied by the State of California,…).", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "id": { + "type": "string", + "description": "Unique identifier of the tax." + }, + "name": { + "type": "string", + "description": "Tax name." + }, + "taxType": { + "type": "string", + "description": "Type of the tax." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/Ticket.schema.json b/Common/Ticket.schema.json index 7afa7946..37de7be4 100644 --- a/Common/Ticket.schema.json +++ b/Common/Ticket.schema.json @@ -1,96 +1,96 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Ticket.schema.json", - "title": "Ticket", - "definitions": { - "Ticket": { - "$id": "#Ticket", - "description": "A trouble ticket represents a record used for reporting and managing the resolution of resource problems", - "type": "object", - "properties": { - "correlationId": { - "type": "string", - "description": "Additional identifier coming from an external system" - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "The date on which the trouble was discovered" - }, - "description": { - "type": "string", - "description": "Description of the trouble" - }, - "href": { - "type": "string", - "description": "Reference of the trouble ticket" - }, - "id": { - "type": "string", - "description": "Unique identifier of the trouble ticket" - }, - "resolutionDate": { - "type": "string", - "format": "date-time", - "description": "The date on which the service was brought back to its original condition" - }, - "severity": { - "type": "string", - "description": "The severity of the trouble. It can be for example : minor, major, critical" - }, - "status": { - "type": "string", - "description": "The current status of the Trouble Ticket" - }, - "statusChangeDate": { - "type": "string", - "format": "date-time", - "description": "The date of state change" - }, - "statusChangeReason": { - "type": "string", - "description": "The reason of state change" - }, - "subStatus": { - "type": "string", - "description": "The current sub status of the Trouble Ticket" - }, - "targetResolutionDate": { - "type": "string", - "format": "date-time", - "description": "Foreseen trouble resolution date" - }, - "ticketType": { - "type": "string", - "description": "Type of trouble ticket" - }, - "relatedObject": { - "type": "array", - "description": "Any object(s) associated with this trouble ticket", - "items": { - "$ref": "RelatedObject.schema.json#RelatedObject" - } - }, - "note": { - "type": "array", - "description": "Any note(s) associated with this trouble ticket", - "items": { - "$ref": "Note.schema.json#Note" - } - }, - "relatedParty": { - "type": "array", - "description": "Any Party/Parties associated with this trouble ticket", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Ticket.schema.json", + "title": "Ticket", + "definitions": { + "Ticket": { + "$id": "#Ticket", + "description": "A trouble ticket represents a record used for reporting and managing the resolution of resource problems", + "type": "object", + "properties": { + "correlationId": { + "type": "string", + "description": "Additional identifier coming from an external system" + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "The date on which the trouble was discovered" + }, + "description": { + "type": "string", + "description": "Description of the trouble" + }, + "href": { + "type": "string", + "description": "Reference of the trouble ticket" + }, + "id": { + "type": "string", + "description": "Unique identifier of the trouble ticket" + }, + "resolutionDate": { + "type": "string", + "format": "date-time", + "description": "The date on which the service was brought back to its original condition" + }, + "severity": { + "type": "string", + "description": "The severity of the trouble. It can be for example : minor, major, critical" + }, + "status": { + "type": "string", + "description": "The current status of the Trouble Ticket" + }, + "statusChangeDate": { + "type": "string", + "format": "date-time", + "description": "The date of state change" + }, + "statusChangeReason": { + "type": "string", + "description": "The reason of state change" + }, + "subStatus": { + "type": "string", + "description": "The current sub status of the Trouble Ticket" + }, + "targetResolutionDate": { + "type": "string", + "format": "date-time", + "description": "Foreseen trouble resolution date" + }, + "ticketType": { + "type": "string", + "description": "Type of trouble ticket" + }, + "relatedObject": { + "type": "array", + "description": "Any object(s) associated with this trouble ticket", + "items": { + "$ref": "RelatedObject.schema.json#RelatedObject" + } + }, + "note": { + "type": "array", + "description": "Any note(s) associated with this trouble ticket", + "items": { + "$ref": "Note.schema.json#Note" + } + }, + "relatedParty": { + "type": "array", + "description": "Any Party/Parties associated with this trouble ticket", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/TicketRelationship.schema.json b/Common/TicketRelationship.schema.json index 988d3aa9..30109f86 100644 --- a/Common/TicketRelationship.schema.json +++ b/Common/TicketRelationship.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TicketRelationship.schema.json", - "title": "TicketRelationship", - "definitions": { - "TicketRelationship": { - "$id": "#TicketRelationship", - "type": "object", - "description": "Represents a relationship between trouble tickets", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of the trouble ticket relationship can be isChiled, dependent etc..." - }, - "product": { - "$ref": "TroubleTicketRef.schema.json#TroubleTicketRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TicketRelationship.schema.json", + "title": "TicketRelationship", + "definitions": { + "TicketRelationship": { + "$id": "#TicketRelationship", + "type": "object", + "description": "Represents a relationship between trouble tickets", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of the trouble ticket relationship can be isChiled, dependent etc..." + }, + "product": { + "$ref": "TroubleTicketRef.schema.json#TroubleTicketRef" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/TimePeriod.schema.json b/Common/TimePeriod.schema.json index 2be7f7ce..57900761 100644 --- a/Common/TimePeriod.schema.json +++ b/Common/TimePeriod.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TimePeriod.schema.json", - "title": "TimePeriod", - "definitions": { - "TimePeriod": { - "$id": "#TimePeriod", - "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", - "type": "object", - "properties": { - "startDateTime": { - "description": "Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end", - "type": "string", - "format": "date-time", - "examples": [ - "1985-04-12T23:20:50.52Z", - "2018-09-21T09:13:16-07:00" - ] - }, - "endDateTime": { - "description": "End of the time period, using IETC-RFC-3339 format", - "type": "string", - "format": "date-time", - "examples": [ - "1985-04-12T23:20:50.52Z", - "2018-09-21T09:13:16-07:00" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TimePeriod.schema.json", + "title": "TimePeriod", + "definitions": { + "TimePeriod": { + "$id": "#TimePeriod", + "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", + "type": "object", + "properties": { + "startDateTime": { + "description": "Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end", + "type": "string", + "format": "date-time", + "examples": [ + "1985-04-12T23:20:50.52Z", + "2018-09-21T09:13:16-07:00" + ] + }, + "endDateTime": { + "description": "End of the time period, using IETC-RFC-3339 format", + "type": "string", + "format": "date-time", + "examples": [ + "1985-04-12T23:20:50.52Z", + "2018-09-21T09:13:16-07:00" + ] + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/TimePeriodType.schema.json b/Common/TimePeriodType.schema.json index 56316c0b..1bb16b8b 100644 --- a/Common/TimePeriodType.schema.json +++ b/Common/TimePeriodType.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TimePeriodType.schema.json", - "title": "TimePeriodType", - "definitions": { - "TimePeriodType": { - "$id": "#TimePeriodType", - "description": "Representation of a time period", - "properties": { - "endDateTime": { - "type": "string", - "format": "date-time", - "description": "End date of the period" - }, - "startDateTime": { - "type": "string", - "format": "date-time", - "description": "Start date of the period" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TimePeriodType.schema.json", + "title": "TimePeriodType", + "definitions": { + "TimePeriodType": { + "$id": "#TimePeriodType", + "description": "Representation of a time period", + "properties": { + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "End date of the period" + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Start date of the period" + } + }, + "required": [ + "startDateTime" + ], + "type": "object" } - }, - "required": [ - "startDateTime" - ], - "type": "object" } - } } \ No newline at end of file diff --git a/Common/TroubleTicket.schema.json b/Common/TroubleTicket.schema.json index 58c6e711..bff3bb6c 100755 --- a/Common/TroubleTicket.schema.json +++ b/Common/TroubleTicket.schema.json @@ -1,135 +1,135 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TroubleTicket.schema.json", - "title": "TroubleTicket", - "definitions": { - "TroubleTicket": { - "$id": "#TroubleTicket", - "type": "object", - "description": "A trouble ticket is a record of an issue that is created, tracked, and managed by a trouble ticket management system", - "properties": { - "attachment": { - "type": "array", - "items": { - "$ref": "AttachmentRefOrValue.schema.json#AttachmentRefOrValue" - }, - "description": "File(s) attached to the trouble ticket. e.g. pictur of broken device, scaning of a bill or charge" - }, - "channel": { - "$ref": "ChannelRef.schema.json#ChannelRef", - "description": "The channel that origin the trouble ticket" - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "The date on which the trouble ticket was created" - }, - "description": { - "type": "string", - "description": "Description of the trouble or issue" - }, - "expectedResolutionDate": { - "type": "string", - "format": "date-time", - "description": "The expected resolution date determined by the trouble ticket system" - }, - "externalId": { - "type": "string", - "description": "Additional identifier coming from an external system" - }, - "href": { - "type": "string", - "description": "Hyperlink, a reference to the trouble ticket entity" - }, - "id": { - "type": "string", - "description": "Unique identifier of the trouble ticket" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "The date and time that the trouble ticked was last updated" - }, - "name": { - "type": "string", - "description": "Name of the trouble ticket, typically a short description provided by the user that create the ticket" - }, - "note": { - "type": "array", - "items": { - "$ref": "Note.schema.json#Note" - }, - "description": "The note(s) that are associated to the ticket." - }, - "priority": { - "type": "string", - "description": "The priority of the trouble ticket and how quickly the issue should be resolved. Example: Critical, High, Medium, Low. The value is set by the ticket management system considering the severity, ticket type etc..." - }, - "relatedEntity": { - "type": "array", - "items": { - "$ref": "RelatedEntity.schema.json#RelatedEntity" - }, - "description": "An entity that is related to the ticket such as a bill, a product, etc. The entity against which the ticket is associated." - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "description": "The related party(ies) that are associated to the ticket." - }, - "requestedResolutionDate": { - "type": "string", - "format": "date-time", - "description": "The resolution date requested by the user" - }, - "resolutionDate": { - "type": "string", - "format": "date-time", - "description": "The date and time the trouble ticket was resolved" - }, - "severity": { - "type": "string", - "description": "The severity of the issue. Indicate the implication of the issue on the expected functionality e.g. of a system, application, service etc.. \nSeverity values can be for example : Critical, Major, Minor" - }, - "status": { - "$ref": "TroubleTicketStatusType.schema.json#TroubleTicketStatusType", - "description": "The current status of the trouble ticket" - }, - "statusChange": { - "type": "array", - "items": { - "$ref": "StatusChange.schema.json#StatusChange" - }, - "description": "The status change history that are associated to the ticket.Populated by the server" - }, - "statusChangeDate": { - "type": "string", - "format": "date-time", - "description": "The date and time the status changed." - }, - "statusChangeReason": { - "type": "string", - "description": "The reason for changing the status" - }, - "troubleTicketRelationship": { - "type": "array", - "items": { - "$ref": "TroubleTicketRelationship.schema.json#TroubleTicketRelationship" - }, - "description": "A list of trouble ticket relationships (TroubleTicketRelationship [*]). Represents a relationship between trouble tickets" - }, - "ticketType": { - "type": "string", - "description": "represent a business type of the trouble ticket e.g. incident, complain, request" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TroubleTicket.schema.json", + "title": "TroubleTicket", + "definitions": { + "TroubleTicket": { + "$id": "#TroubleTicket", + "type": "object", + "description": "A trouble ticket is a record of an issue that is created, tracked, and managed by a trouble ticket management system", + "properties": { + "attachment": { + "type": "array", + "items": { + "$ref": "AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + }, + "description": "File(s) attached to the trouble ticket. e.g. pictur of broken device, scaning of a bill or charge" + }, + "channel": { + "$ref": "ChannelRef.schema.json#ChannelRef", + "description": "The channel that origin the trouble ticket" + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "The date on which the trouble ticket was created" + }, + "description": { + "type": "string", + "description": "Description of the trouble or issue" + }, + "expectedResolutionDate": { + "type": "string", + "format": "date-time", + "description": "The expected resolution date determined by the trouble ticket system" + }, + "externalId": { + "type": "string", + "description": "Additional identifier coming from an external system" + }, + "href": { + "type": "string", + "description": "Hyperlink, a reference to the trouble ticket entity" + }, + "id": { + "type": "string", + "description": "Unique identifier of the trouble ticket" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "The date and time that the trouble ticked was last updated" + }, + "name": { + "type": "string", + "description": "Name of the trouble ticket, typically a short description provided by the user that create the ticket" + }, + "note": { + "type": "array", + "items": { + "$ref": "Note.schema.json#Note" + }, + "description": "The note(s) that are associated to the ticket." + }, + "priority": { + "type": "string", + "description": "The priority of the trouble ticket and how quickly the issue should be resolved. Example: Critical, High, Medium, Low. The value is set by the ticket management system considering the severity, ticket type etc..." + }, + "relatedEntity": { + "type": "array", + "items": { + "$ref": "RelatedEntity.schema.json#RelatedEntity" + }, + "description": "An entity that is related to the ticket such as a bill, a product, etc. The entity against which the ticket is associated." + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "The related party(ies) that are associated to the ticket." + }, + "requestedResolutionDate": { + "type": "string", + "format": "date-time", + "description": "The resolution date requested by the user" + }, + "resolutionDate": { + "type": "string", + "format": "date-time", + "description": "The date and time the trouble ticket was resolved" + }, + "severity": { + "type": "string", + "description": "The severity of the issue. Indicate the implication of the issue on the expected functionality e.g. of a system, application, service etc.. \nSeverity values can be for example : Critical, Major, Minor" + }, + "status": { + "$ref": "TroubleTicketStatusType.schema.json#TroubleTicketStatusType", + "description": "The current status of the trouble ticket" + }, + "statusChange": { + "type": "array", + "items": { + "$ref": "StatusChange.schema.json#StatusChange" + }, + "description": "The status change history that are associated to the ticket.Populated by the server" + }, + "statusChangeDate": { + "type": "string", + "format": "date-time", + "description": "The date and time the status changed." + }, + "statusChangeReason": { + "type": "string", + "description": "The reason for changing the status" + }, + "troubleTicketRelationship": { + "type": "array", + "items": { + "$ref": "TroubleTicketRelationship.schema.json#TroubleTicketRelationship" + }, + "description": "A list of trouble ticket relationships (TroubleTicketRelationship [*]). Represents a relationship between trouble tickets" + }, + "ticketType": { + "type": "string", + "description": "represent a business type of the trouble ticket e.g. incident, complain, request" + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/TroubleTicketRef.schema.json b/Common/TroubleTicketRef.schema.json index 5f78ab44..aa297e9e 100644 --- a/Common/TroubleTicketRef.schema.json +++ b/Common/TroubleTicketRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TroubleTicketRef.schema.json", - "title": "TroubleTicketRef", - "definitions": { - "TroubleTicketRef": { - "$id": "#TroubleTicketRef", - "description": "TroubleTicket reference, for when a Trouble Ticket is used by other entities", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TroubleTicketRef.schema.json", + "title": "TroubleTicketRef", + "definitions": { + "TroubleTicketRef": { + "$id": "#TroubleTicketRef", + "description": "TroubleTicket reference, for when a Trouble Ticket is used by other entities", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "EntityRef.schema.json#EntityRef" + } + ] } - ] } - } } \ No newline at end of file diff --git a/Common/TroubleTicketRelationship.schema.json b/Common/TroubleTicketRelationship.schema.json index c69a74b9..bdbbf030 100755 --- a/Common/TroubleTicketRelationship.schema.json +++ b/Common/TroubleTicketRelationship.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TroubleTicketRelationship.schema.json", - "title": "TroubleTicketRelationship", - "definitions": { - "TroubleTicketRelationship": { - "$id": "#TroubleTicketRelationship", - "type": "object", - "description": "Represents a relationship between trouble TroubleTickets", - "properties": { - "troubleTicket": { - "$ref": "TroubleTicketRef.schema.json#TroubleTicketRef" - }, - "relationshipType": { - "type": "string", - "description": "Type of the Trouble Ticket relationship can be isChiled, dependent etc..." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TroubleTicketRelationship.schema.json", + "title": "TroubleTicketRelationship", + "definitions": { + "TroubleTicketRelationship": { + "$id": "#TroubleTicketRelationship", + "type": "object", + "description": "Represents a relationship between trouble TroubleTickets", + "properties": { + "troubleTicket": { + "$ref": "TroubleTicketRef.schema.json#TroubleTicketRef" + }, + "relationshipType": { + "type": "string", + "description": "Type of the Trouble Ticket relationship can be isChiled, dependent etc..." + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Common/TroubleTicketStatusType.schema.json b/Common/TroubleTicketStatusType.schema.json index b40e201a..fb50ef62 100644 --- a/Common/TroubleTicketStatusType.schema.json +++ b/Common/TroubleTicketStatusType.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TroubleTicketStatusType.schema.json", - "title": "TroubleTicketStatusType", - "definitions": { - "TroubleTicketStatusType": { - "$id": "#TroubleTicketStatusType", - "type": "string", - "description": "Possible values for the status of the trouble ticket", - "enum": [ - "acknowledged", - "rejected", - "pending", - "held", - "inProgress", - "cancelled", - "closed", - "resolved" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TroubleTicketStatusType.schema.json", + "title": "TroubleTicketStatusType", + "definitions": { + "TroubleTicketStatusType": { + "$id": "#TroubleTicketStatusType", + "type": "string", + "description": "Possible values for the status of the trouble ticket", + "enum": [ + "acknowledged", + "rejected", + "pending", + "held", + "inProgress", + "cancelled", + "closed", + "resolved" + ] + } } - } } \ No newline at end of file diff --git a/Common/Value.schema.json b/Common/Value.schema.json index 2075d2ad..191e46e1 100644 --- a/Common/Value.schema.json +++ b/Common/Value.schema.json @@ -1,17 +1,17 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Value.schema.json", - "title": "Value", - "definitions": { - "Value": { - "$id": "#Value", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Value.schema.json", + "title": "Value", + "definitions": { + "Value": { + "$id": "#Value", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - ] } - } } \ No newline at end of file diff --git a/Common/WorkLog.schema.json b/Common/WorkLog.schema.json index b8579373..0e0b13e1 100644 --- a/Common/WorkLog.schema.json +++ b/Common/WorkLog.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "WorkLog.schema.json", - "title": "WorkLog", - "definitions": { - "WorkLog": { - "$id": "#WorkLog", - "description": "A record of the work performed on the change request during the investigation and resolution process.", - "type": "object", - "properties": { - "createDateTime": { - "type": "string", - "format": "date-time", - "description": "Date and time of worklog generated." - }, - "description": { - "type": "string", - "description": "The description of the worklog." - }, - "lastUpdateDateTime": { - "type": "string", - "description": "Date and time when the worklog updated." - }, - "record": { - "type": "array", - "items": { - "$ref": "Record.schema.json#Record" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "WorkLog.schema.json", + "title": "WorkLog", + "definitions": { + "WorkLog": { + "$id": "#WorkLog", + "description": "A record of the work performed on the change request during the investigation and resolution process.", + "type": "object", + "properties": { + "createDateTime": { + "type": "string", + "format": "date-time", + "description": "Date and time of worklog generated." + }, + "description": { + "type": "string", + "description": "The description of the worklog." + }, + "lastUpdateDateTime": { + "type": "string", + "description": "Date and time when the worklog updated." + }, + "record": { + "type": "array", + "items": { + "$ref": "Record.schema.json#Record" + } + } + }, + "allOf": [ + { + "$ref": "Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/AccumulatedBalance.schema.json b/Customer/AccumulatedBalance.schema.json index cb50b070..8c2b4d49 100644 --- a/Customer/AccumulatedBalance.schema.json +++ b/Customer/AccumulatedBalance.schema.json @@ -1,60 +1,60 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccumulatedBalance.schema.json", - "title": "AccumulatedBalance", - "definitions": { - "AccumulatedBalance": { - "$id": "#AccumulatedBalance", - "description": "Represents and tracks the aggregated amount remained or owed in certain account which is owned by certain customer for a set of buckets.", - "properties": { - "bucket": { - "type": "array", - "items": { - "$ref": "BucketBalanceRef.schema.json#BucketBalanceRef" - }, - "description": "A reference to the buckets involved in the aggregation" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the aggregated balance" - }, - "name": { - "type": "string", - "description": "Friendly name to identify the aggregated balance" - }, - "partyAccount": { - "type": "array", - "items": { - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - }, - "description": "A reference to the account that owns the buckets aggregated" - }, - "product": { - "type": "array", - "items": { - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "description": "A reference to the product whose consumption is managed by the bucket . This is an array to allow scenarios where a buckets are shared between different products" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "description": "Used to provide information about any other entity with relation to the balance, for instance to define customer hierarchy for the balance (e.g.: customerId, userId, )" - }, - "totalBalance": { - "description": "Aggregated for a set of prepay balance buckets associated to the product", - "$ref": "../Common/QuantityType.schema.json#QuantityType" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccumulatedBalance.schema.json", + "title": "AccumulatedBalance", + "definitions": { + "AccumulatedBalance": { + "$id": "#AccumulatedBalance", + "description": "Represents and tracks the aggregated amount remained or owed in certain account which is owned by certain customer for a set of buckets.", + "properties": { + "bucket": { + "type": "array", + "items": { + "$ref": "BucketBalanceRef.schema.json#BucketBalanceRef" + }, + "description": "A reference to the buckets involved in the aggregation" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the aggregated balance" + }, + "name": { + "type": "string", + "description": "Friendly name to identify the aggregated balance" + }, + "partyAccount": { + "type": "array", + "items": { + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "description": "A reference to the account that owns the buckets aggregated" + }, + "product": { + "type": "array", + "items": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "description": "A reference to the product whose consumption is managed by the bucket . This is an array to allow scenarios where a buckets are shared between different products" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "Used to provide information about any other entity with relation to the balance, for instance to define customer hierarchy for the balance (e.g.: customerId, userId, )" + }, + "totalBalance": { + "description": "Aggregated for a set of prepay balance buckets associated to the product", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + } + }, + "required": [ + "name", + "totalBalance", + "bucket", + "product" + ], + "type": "object" } - }, - "required": [ - "name", - "totalBalance", - "bucket", - "product" - ], - "type": "object" } - } } \ No newline at end of file diff --git a/Customer/AppliedBillingRate.schema.json b/Customer/AppliedBillingRate.schema.json index 6cbf430b..09bddfe0 100644 --- a/Customer/AppliedBillingRate.schema.json +++ b/Customer/AppliedBillingRate.schema.json @@ -1,67 +1,67 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppliedBillingRate.schema.json", - "title": "AppliedBillingRate", - "definitions": { - "AppliedBillingRate": { - "$id": "#AppliedBillingRate", - "description": "An applied billing rate presented on a bill. It is created before or during the billing process", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time", - "description": "Creation date of the applied billing charge" - }, - "description": { - "type": "string", - "description": "Additional data to be displayed on the bill for this applied billing charge" - }, - "href": { - "type": "string", - "description": "Reference of the applied billing charge" - }, - "id": { - "type": "string", - "description": "Unique identifier of the applied billing charge" - }, - "name": { - "type": "string", - "description": "Name of the applied billing rate" - }, - "taxExcludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Tax excluded amount to be charged on the bill (expresses in the given currency) for this applied billing rate" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "All taxes included amount to be charged on the bill (expressed in the given currency) for this applied billing rate" - }, - "rateType": { - "type": "string", - "description": "Type of the applied billing rate : appliedBillingCharge (any kind of charge except taxation charges : recurringCharge, oneTimeCharge, usageCharge), appliedBillingCredit (any kind of credit : rebate or productAlteration) or appliedPenaltyCharge (penalty charges such as late fees, payment rejection fees,...)" - }, - "appliedTax": { - "type": "array", - "items": { - "$ref": "AppliedBillingTaxRate.schema.json#AppliedBillingTaxRate" - } - }, - "bill": { - "$ref": "BillRef.schema.json#BillRef" - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "AppliedBillingRateCharacteristic.schema.json#AppliedBillingRateCharacteristic" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppliedBillingRate.schema.json", + "title": "AppliedBillingRate", + "definitions": { + "AppliedBillingRate": { + "$id": "#AppliedBillingRate", + "description": "An applied billing rate presented on a bill. It is created before or during the billing process", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "Creation date of the applied billing charge" + }, + "description": { + "type": "string", + "description": "Additional data to be displayed on the bill for this applied billing charge" + }, + "href": { + "type": "string", + "description": "Reference of the applied billing charge" + }, + "id": { + "type": "string", + "description": "Unique identifier of the applied billing charge" + }, + "name": { + "type": "string", + "description": "Name of the applied billing rate" + }, + "taxExcludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Tax excluded amount to be charged on the bill (expresses in the given currency) for this applied billing rate" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "All taxes included amount to be charged on the bill (expressed in the given currency) for this applied billing rate" + }, + "rateType": { + "type": "string", + "description": "Type of the applied billing rate : appliedBillingCharge (any kind of charge except taxation charges : recurringCharge, oneTimeCharge, usageCharge), appliedBillingCredit (any kind of credit : rebate or productAlteration) or appliedPenaltyCharge (penalty charges such as late fees, payment rejection fees,...)" + }, + "appliedTax": { + "type": "array", + "items": { + "$ref": "AppliedBillingTaxRate.schema.json#AppliedBillingTaxRate" + } + }, + "bill": { + "$ref": "BillRef.schema.json#BillRef" + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "AppliedBillingRateCharacteristic.schema.json#AppliedBillingRateCharacteristic" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/AppliedBillingRateCharacteristic.schema.json b/Customer/AppliedBillingRateCharacteristic.schema.json index be09ed7b..82f8f41e 100644 --- a/Customer/AppliedBillingRateCharacteristic.schema.json +++ b/Customer/AppliedBillingRateCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppliedBillingRateCharacteristic.schema.json", - "title": "AppliedBillingRateCharacteristic", - "definitions": { - "AppliedBillingRateCharacteristic": { - "$id": "#AppliedBillingRateCharacteristic", - "description": "An applied billing rate has dynamic characteristics according to the its type (characteristics are based on the service type, line of business or on others parameters)", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Characteristic name" - }, - "value": { - "type": "string", - "description": "Value affected to the characteristic" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppliedBillingRateCharacteristic.schema.json", + "title": "AppliedBillingRateCharacteristic", + "definitions": { + "AppliedBillingRateCharacteristic": { + "$id": "#AppliedBillingRateCharacteristic", + "description": "An applied billing rate has dynamic characteristics according to the its type (characteristics are based on the service type, line of business or on others parameters)", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Characteristic name" + }, + "value": { + "type": "string", + "description": "Value affected to the characteristic" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/AppliedBillingTaxRate.schema.json b/Customer/AppliedBillingTaxRate.schema.json index 517aa462..844d41c5 100644 --- a/Customer/AppliedBillingTaxRate.schema.json +++ b/Customer/AppliedBillingTaxRate.schema.json @@ -1,32 +1,32 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppliedBillingTaxRate.schema.json", - "title": "AppliedBillingTaxRate", - "definitions": { - "AppliedBillingTaxRate": { - "$id": "#AppliedBillingTaxRate", - "description": "The applied billing tax rate represents taxes applied billing rate it refers to. It is calculated during the billing process.", - "type": "object", - "properties": { - "taxAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Tax amount expressed in the given currency" - }, - "taxCategory": { - "type": "string", - "description": "A categorization of the tax rate" - }, - "taxRate": { - "type": "number", - "format": "float", - "description": "Applied rate" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppliedBillingTaxRate.schema.json", + "title": "AppliedBillingTaxRate", + "definitions": { + "AppliedBillingTaxRate": { + "$id": "#AppliedBillingTaxRate", + "description": "The applied billing tax rate represents taxes applied billing rate it refers to. It is calculated during the billing process.", + "type": "object", + "properties": { + "taxAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Tax amount expressed in the given currency" + }, + "taxCategory": { + "type": "string", + "description": "A categorization of the tax rate" + }, + "taxRate": { + "type": "number", + "format": "float", + "description": "Applied rate" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/AppliedCustomerBillingRate.schema.json b/Customer/AppliedCustomerBillingRate.schema.json index ef423d7e..77eec26f 100644 --- a/Customer/AppliedCustomerBillingRate.schema.json +++ b/Customer/AppliedCustomerBillingRate.schema.json @@ -1,67 +1,67 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppliedCustomerBillingRate.schema.json", - "title": "AppliedCustomerBillingRate", - "definitions": { - "AppliedCustomerBillingRate": { - "$id": "#AppliedCustomerBillingRate", - "description": "An applied billing rate presented on a customer bill. It is created before or during the billing process.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time", - "description": "Creation date of the applied billing charge" - }, - "description": { - "type": "string", - "description": "Additional data to be displayed on the bill for this applied billing charge" - }, - "href": { - "type": "string", - "description": "Reference of the applied billing charge" - }, - "id": { - "type": "string", - "description": "Unique identifier of the applied billing charge" - }, - "name": { - "type": "string", - "description": "Name of the applied billing rate" - }, - "taxExcludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Tax excluded amount to be charged on the bill (expresses in the given currency) for this applied billing rate" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "All taxes included amount to be charged on the bill (expressed in the given currency) for this applied billing rate" - }, - "rateType": { - "type": "string", - "description": "Type of the applied billing rate : appliedBillingCharge (any kind of charge except taxation charges : recurringCharge, oneTimeCharge, usageCharge), appliedBillingCredit (any kind of credit : rebate or productAlteration) or appliedPenaltyCharge (penalty charges such as late fees, payment rejection fees,...)" - }, - "appliedTax": { - "type": "array", - "items": { - "$ref": "AppliedBillingTaxRate.schema.json#AppliedBillingTaxRate" - } - }, - "bill": { - "$ref": "BillRef.schema.json#BillRef" - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "AppliedBillingRateCharacteristic.schema.json#AppliedBillingRateCharacteristic" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppliedCustomerBillingRate.schema.json", + "title": "AppliedCustomerBillingRate", + "definitions": { + "AppliedCustomerBillingRate": { + "$id": "#AppliedCustomerBillingRate", + "description": "An applied billing rate presented on a customer bill. It is created before or during the billing process.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "Creation date of the applied billing charge" + }, + "description": { + "type": "string", + "description": "Additional data to be displayed on the bill for this applied billing charge" + }, + "href": { + "type": "string", + "description": "Reference of the applied billing charge" + }, + "id": { + "type": "string", + "description": "Unique identifier of the applied billing charge" + }, + "name": { + "type": "string", + "description": "Name of the applied billing rate" + }, + "taxExcludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Tax excluded amount to be charged on the bill (expresses in the given currency) for this applied billing rate" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "All taxes included amount to be charged on the bill (expressed in the given currency) for this applied billing rate" + }, + "rateType": { + "type": "string", + "description": "Type of the applied billing rate : appliedBillingCharge (any kind of charge except taxation charges : recurringCharge, oneTimeCharge, usageCharge), appliedBillingCredit (any kind of credit : rebate or productAlteration) or appliedPenaltyCharge (penalty charges such as late fees, payment rejection fees,...)" + }, + "appliedTax": { + "type": "array", + "items": { + "$ref": "AppliedBillingTaxRate.schema.json#AppliedBillingTaxRate" + } + }, + "bill": { + "$ref": "BillRef.schema.json#BillRef" + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "AppliedBillingRateCharacteristic.schema.json#AppliedBillingRateCharacteristic" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/AppliedPartyBillingRate.schema.json b/Customer/AppliedPartyBillingRate.schema.json index a8c57f88..063aac46 100644 --- a/Customer/AppliedPartyBillingRate.schema.json +++ b/Customer/AppliedPartyBillingRate.schema.json @@ -1,67 +1,67 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppliedPartyBillingRate.schema.json", - "title": "AppliedPartyBillingRate", - "definitions": { - "AppliedPartyBillingRate": { - "$id": "#AppliedPartyBillingRate", - "description": "An applied billing rate presented on a party bill. It is created before or during the billing process.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time", - "description": "Creation date of the applied billing charge" - }, - "description": { - "type": "string", - "description": "Additional data to be displayed on the bill for this applied billing charge" - }, - "href": { - "type": "string", - "description": "Reference of the applied billing charge" - }, - "id": { - "type": "string", - "description": "Unique identifier of the applied billing charge" - }, - "name": { - "type": "string", - "description": "Name of the applied billing rate" - }, - "taxExcludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Tax excluded amount to be charged on the bill (expresses in the given currency) for this applied billing rate" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "All taxes included amount to be charged on the bill (expressed in the given currency) for this applied billing rate" - }, - "rateType": { - "type": "string", - "description": "Type of the applied billing rate : appliedBillingCharge (any kind of charge except taxation charges : recurringCharge, oneTimeCharge, usageCharge), appliedBillingCredit (any kind of credit : rebate or productAlteration) or appliedPenaltyCharge (penalty charges such as late fees, payment rejection fees,...)" - }, - "appliedTax": { - "type": "array", - "items": { - "$ref": "AppliedBillingTaxRate.schema.json#AppliedBillingTaxRate" - } - }, - "bill": { - "$ref": "BillRef.schema.json#BillRef" - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "AppliedBillingRateCharacteristic.schema.json#AppliedBillingRateCharacteristic" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppliedPartyBillingRate.schema.json", + "title": "AppliedPartyBillingRate", + "definitions": { + "AppliedPartyBillingRate": { + "$id": "#AppliedPartyBillingRate", + "description": "An applied billing rate presented on a party bill. It is created before or during the billing process.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "Creation date of the applied billing charge" + }, + "description": { + "type": "string", + "description": "Additional data to be displayed on the bill for this applied billing charge" + }, + "href": { + "type": "string", + "description": "Reference of the applied billing charge" + }, + "id": { + "type": "string", + "description": "Unique identifier of the applied billing charge" + }, + "name": { + "type": "string", + "description": "Name of the applied billing rate" + }, + "taxExcludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Tax excluded amount to be charged on the bill (expresses in the given currency) for this applied billing rate" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "All taxes included amount to be charged on the bill (expressed in the given currency) for this applied billing rate" + }, + "rateType": { + "type": "string", + "description": "Type of the applied billing rate : appliedBillingCharge (any kind of charge except taxation charges : recurringCharge, oneTimeCharge, usageCharge), appliedBillingCredit (any kind of credit : rebate or productAlteration) or appliedPenaltyCharge (penalty charges such as late fees, payment rejection fees,...)" + }, + "appliedTax": { + "type": "array", + "items": { + "$ref": "AppliedBillingTaxRate.schema.json#AppliedBillingTaxRate" + } + }, + "bill": { + "$ref": "BillRef.schema.json#BillRef" + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "AppliedBillingRateCharacteristic.schema.json#AppliedBillingRateCharacteristic" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/Appointment.schema.json b/Customer/Appointment.schema.json index 73a8daf3..e200a81e 100644 --- a/Customer/Appointment.schema.json +++ b/Customer/Appointment.schema.json @@ -1,96 +1,96 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Appointment.schema.json", - "title": "Appointment", - "definitions": { - "Appointment": { - "$id": "#Appointment", - "type": "object", - "description": "An Appointment is an arrangement to do something or meet someone at a particular time, at a place (for face to face appointment) or in a contact medium (for phone appointment).", - "properties": { - "attachment": { - "type": "array", - "items": { - "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" - } - }, - "calendarEvent": { - "$ref": "../Common/CalendarEventRef.schema.json#CalendarEventRef", - "description": "A calendar event reference (CalendarEventRef). The appointment is associated with a calendar event (an happening at a point of time) associated to a calendar entry." - }, - "category": { - "type": "string", - "description": "Business category : intervention for example or to be more precise after SalesIntervention, orderDeliveryIntervention,..." - }, - "contactMedium": { - "type": "array", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "Appointment creation date" - }, - "description": { - "type": "string", - "description": "Short free text describing the appointment" - }, - "externalId": { - "type": "string", - "description": "External reference known by the customer" - }, - "href": { - "type": "string", - "description": "Unique URI used to access to the appointment resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of the appointment" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date of last appointment update" - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "relatedPlace": { - "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue", - "description": "Related place defines (by reference or value) the place where the appointment will take place." - }, - "relatedEntity": { - "type": "array", - "items": { - "$ref": "../Common/RelatedEntity.schema.json#RelatedEntity" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "status": { - "$ref": "AppointmentStateType.schema.json#AppointmentStateType" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Appointment.schema.json", + "title": "Appointment", + "definitions": { + "Appointment": { + "$id": "#Appointment", + "type": "object", + "description": "An Appointment is an arrangement to do something or meet someone at a particular time, at a place (for face to face appointment) or in a contact medium (for phone appointment).", + "properties": { + "attachment": { + "type": "array", + "items": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + } + }, + "calendarEvent": { + "$ref": "../Common/CalendarEventRef.schema.json#CalendarEventRef", + "description": "A calendar event reference (CalendarEventRef). The appointment is associated with a calendar event (an happening at a point of time) associated to a calendar entry." + }, + "category": { + "type": "string", + "description": "Business category : intervention for example or to be more precise after SalesIntervention, orderDeliveryIntervention,..." + }, + "contactMedium": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "Appointment creation date" + }, + "description": { + "type": "string", + "description": "Short free text describing the appointment" + }, + "externalId": { + "type": "string", + "description": "External reference known by the customer" + }, + "href": { + "type": "string", + "description": "Unique URI used to access to the appointment resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of the appointment" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date of last appointment update" + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "relatedPlace": { + "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue", + "description": "Related place defines (by reference or value) the place where the appointment will take place." + }, + "relatedEntity": { + "type": "array", + "items": { + "$ref": "../Common/RelatedEntity.schema.json#RelatedEntity" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "status": { + "$ref": "AppointmentStateType.schema.json#AppointmentStateType" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ], + "required": [ + "validFor" + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ], - "required": [ - "validFor" - ] } - } } \ No newline at end of file diff --git a/Customer/AppointmentRef.schema.json b/Customer/AppointmentRef.schema.json index 4a0452a9..aeb0465b 100644 --- a/Customer/AppointmentRef.schema.json +++ b/Customer/AppointmentRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppointmentRef.schema.json", - "title": "AppointmentRef", - "definitions": { - "AppointmentRef": { - "$id": "#AppointmentRef", - "description": "Refers an appointment, such as a Customer presentation or internal meeting or site visit", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "An explanatory text regarding the appointment made with a party" - }, - "href": { - "type": "string", - "description": "The reference of the appointment" - }, - "id": { - "type": "string", - "description": "The identifier of the referred appointment" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppointmentRef.schema.json", + "title": "AppointmentRef", + "definitions": { + "AppointmentRef": { + "$id": "#AppointmentRef", + "description": "Refers an appointment, such as a Customer presentation or internal meeting or site visit", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "An explanatory text regarding the appointment made with a party" + }, + "href": { + "type": "string", + "description": "The reference of the appointment" + }, + "id": { + "type": "string", + "description": "The identifier of the referred appointment" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/AppointmentStateType.schema.json b/Customer/AppointmentStateType.schema.json index fde1bca9..68ad3075 100644 --- a/Customer/AppointmentStateType.schema.json +++ b/Customer/AppointmentStateType.schema.json @@ -1,19 +1,19 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppointmentStateType.schema.json", - "title": "AppointmentStateType", - "definitions": { - "AppointmentStateType": { - "$id": "#AppointmentStateType", - "type": "string", - "description": "Valid values for the lifecycle state of the appointment", - "enum": [ - "initialized", - "confirmed", - "cancelled", - "completed", - "failed" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppointmentStateType.schema.json", + "title": "AppointmentStateType", + "definitions": { + "AppointmentStateType": { + "$id": "#AppointmentStateType", + "type": "string", + "description": "Valid values for the lifecycle state of the appointment", + "enum": [ + "initialized", + "confirmed", + "cancelled", + "completed", + "failed" + ] + } } - } } \ No newline at end of file diff --git a/Customer/AppointmentStateValues.schema.json b/Customer/AppointmentStateValues.schema.json index c86fe500..2bffbd92 100644 --- a/Customer/AppointmentStateValues.schema.json +++ b/Customer/AppointmentStateValues.schema.json @@ -1,19 +1,19 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppointmentStateValues.schema.json", - "title": "AppointmentStateValues", - "definitions": { - "AppointmentStateValues": { - "$id": "#AppointmentStateValues", - "type": "string", - "description": "", - "enum": [ - "initialized", - "confirmed", - "cancelled", - "completed", - "failed" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppointmentStateValues.schema.json", + "title": "AppointmentStateValues", + "definitions": { + "AppointmentStateValues": { + "$id": "#AppointmentStateValues", + "type": "string", + "description": "", + "enum": [ + "initialized", + "confirmed", + "cancelled", + "completed", + "failed" + ] + } } - } } \ No newline at end of file diff --git a/Customer/Authorization.schema.json b/Customer/Authorization.schema.json index cda02c4d..0ab5e8e4 100644 --- a/Customer/Authorization.schema.json +++ b/Customer/Authorization.schema.json @@ -1,47 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Authorization.schema.json", - "title": "Authorization", - "definitions": { - "Authorization": { - "$id": "#Authorization", - "description": "If special discount or special product offering price or specific condition need an approval for ISP sale representative it is described here.", - "type": "object", - "properties": { - "givenDate": { - "type": "string", - "format": "date-time", - "description": "Date when the authorization (approved or declined) was done" - }, - "name": { - "type": "string", - "description": "Name of the required authorization" - }, - "requestedDate": { - "type": "string", - "format": "date-time", - "description": "Date when the authorization is requested for" - }, - "signatureRepresentation": { - "type": "string", - "description": "To describe a digital or manual signature" - }, - "state": { - "type": "string", - "description": "State of the authorization, such as: approved or declined" - }, - "approver": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Authorization.schema.json", + "title": "Authorization", + "definitions": { + "Authorization": { + "$id": "#Authorization", + "description": "If special discount or special product offering price or specific condition need an approval for ISP sale representative it is described here.", + "type": "object", + "properties": { + "givenDate": { + "type": "string", + "format": "date-time", + "description": "Date when the authorization (approved or declined) was done" + }, + "name": { + "type": "string", + "description": "Name of the required authorization" + }, + "requestedDate": { + "type": "string", + "format": "date-time", + "description": "Date when the authorization is requested for" + }, + "signatureRepresentation": { + "type": "string", + "description": "To describe a digital or manual signature" + }, + "state": { + "type": "string", + "description": "State of the authorization, such as: approved or declined" + }, + "approver": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/BalanceActionRequestRef.schema.json b/Customer/BalanceActionRequestRef.schema.json index 480d28f8..e393aa95 100644 --- a/Customer/BalanceActionRequestRef.schema.json +++ b/Customer/BalanceActionRequestRef.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceActionRequestRef.schema.json", - "title": "BalanceActionRequestRef", - "definitions": { - "BalanceActionRequestRef": { - "$id": "#BalanceActionRequestRef", - "description": "link to the resource that holds balance-related request information", - "properties": { - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the request information for the balance-related action" - }, - "id": { - "type": "string", - "description": "Unique identifier for the balance related action request" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceActionRequestRef.schema.json", + "title": "BalanceActionRequestRef", + "definitions": { + "BalanceActionRequestRef": { + "$id": "#BalanceActionRequestRef", + "description": "link to the resource that holds balance-related request information", + "properties": { + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the request information for the balance-related action" + }, + "id": { + "type": "string", + "description": "Unique identifier for the balance related action request" + } + }, + "required": [ + "id", + "href" + ], + "type": "object" } - }, - "required": [ - "id", - "href" - ], - "type": "object" } - } } \ No newline at end of file diff --git a/Customer/BalanceActivity.schema.json b/Customer/BalanceActivity.schema.json index ca857b79..9a7cba2c 100644 --- a/Customer/BalanceActivity.schema.json +++ b/Customer/BalanceActivity.schema.json @@ -1,65 +1,65 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceActivity.schema.json", - "title": "BalanceActivity", - "definitions": { - "BalanceActivity": { - "$id": "#BalanceActivity", - "description": "The BalanceActivity resource is a detailed description of a specific balance-related action that has happened over a given bucket balance. Typically a recharge/transfer/adjustment request creates one activity, but a request for an auto-topup operation actually triggers multiple periodic balance-related activities.", - "properties": { - "action": { - "description": "A reference to the balance-related operation that triggered the action", - "$ref": "BalanceActionRequestRef.schema.json#BalanceActionRequestRef" - }, - "amount": { - "description": "Amount (can be monetary or non-monetary) that was involved in the balance operation", - "$ref": "../Common/QuantityType.schema.json#QuantityType" - }, - "amountAfter": { - "description": "Remained amount in the bucket involved in the operation after it took place", - "$ref": "../Common/QuantityType.schema.json#QuantityType" - }, - "amountBefore": { - "description": "Remained amount in the bucket involved in the operation before it took place", - "$ref": "../Common/QuantityType.schema.json#QuantityType" - }, - "bucketBalance": { - "description": "A reference to the bucket involved in the balance-related operation", - "$ref": "BucketBalanceRef.schema.json#BucketBalanceRef" - }, - "date": { - "type": "string", - "description": "Date when the balance related operation took place" - }, - "partyAccount": { - "description": "A reference to the account that owns the bucket impacted by the balance activity", - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - }, - "product": { - "description": "A reference to the product related to the bucket that is impacted by the balance activity", - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - }, - "description": "Used to provide information about any other entity with relation to the balance activity" - }, - "type": { - "type": "string", - "description": "A preconfigured value that describes a type of balance-related performed (topup, transfer, adjustment)" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceActivity.schema.json", + "title": "BalanceActivity", + "definitions": { + "BalanceActivity": { + "$id": "#BalanceActivity", + "description": "The BalanceActivity resource is a detailed description of a specific balance-related action that has happened over a given bucket balance. Typically a recharge/transfer/adjustment request creates one activity, but a request for an auto-topup operation actually triggers multiple periodic balance-related activities.", + "properties": { + "action": { + "description": "A reference to the balance-related operation that triggered the action", + "$ref": "BalanceActionRequestRef.schema.json#BalanceActionRequestRef" + }, + "amount": { + "description": "Amount (can be monetary or non-monetary) that was involved in the balance operation", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "amountAfter": { + "description": "Remained amount in the bucket involved in the operation after it took place", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "amountBefore": { + "description": "Remained amount in the bucket involved in the operation before it took place", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "bucketBalance": { + "description": "A reference to the bucket involved in the balance-related operation", + "$ref": "BucketBalanceRef.schema.json#BucketBalanceRef" + }, + "date": { + "type": "string", + "description": "Date when the balance related operation took place" + }, + "partyAccount": { + "description": "A reference to the account that owns the bucket impacted by the balance activity", + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "product": { + "description": "A reference to the product related to the bucket that is impacted by the balance activity", + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "description": "Used to provide information about any other entity with relation to the balance activity" + }, + "type": { + "type": "string", + "description": "A preconfigured value that describes a type of balance-related performed (topup, transfer, adjustment)" + } + }, + "required": [ + "type", + "date", + "action", + "amount", + "bucketBalance", + "product" + ], + "type": "object" } - }, - "required": [ - "type", - "date", - "action", - "amount", - "bucketBalance", - "product" - ], - "type": "object" } - } } \ No newline at end of file diff --git a/Customer/BalanceAdjustment.schema.json b/Customer/BalanceAdjustment.schema.json index 8fbb5bd8..2f29e208 100644 --- a/Customer/BalanceAdjustment.schema.json +++ b/Customer/BalanceAdjustment.schema.json @@ -1,12 +1,12 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceAdjustment.schema.json", - "title": "BalanceAdjustment", - "definitions": { - "BalanceAdjustment": { - "$id": "#BalanceAdjustment", - "description": "#TODO", - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceAdjustment.schema.json", + "title": "BalanceAdjustment", + "definitions": { + "BalanceAdjustment": { + "$id": "#BalanceAdjustment", + "description": "#TODO", + "type": "object" + } } - } } \ No newline at end of file diff --git a/Customer/BalanceAdjustmentBody.schema.json b/Customer/BalanceAdjustmentBody.schema.json index ad25e35d..f03bd09f 100644 --- a/Customer/BalanceAdjustmentBody.schema.json +++ b/Customer/BalanceAdjustmentBody.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceAdjustmentBody.schema.json", - "title": "BalanceAdjustmentBody", - "definitions": { - "BalanceAdjustmentBody": { - "$id": "#BalanceAdjustmentBody", - "properties": { - "amount": { - "description": "Amount (can be monetary or non-monetary) to be recharged in the bucket. It could refer to positive (increment) or negative (decrement) values", - "$ref": "../Common/QuantityType.schema.json#QuantityType" - }, - "product": { - "description": "A reference to the product related to the bucket that is impacted by the balance related operation", - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "reason": { - "type": "string", - "description": "Text describing the reason for the adjustment" - }, - "type": { - "type": "string", - "description": "A preconfigured value that describes a TopUp type which determines the prepay balance bucket in which the top-up is done (national-voice, roaming-voice, promotional-voice, data, ....)" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceAdjustmentBody.schema.json", + "title": "BalanceAdjustmentBody", + "definitions": { + "BalanceAdjustmentBody": { + "$id": "#BalanceAdjustmentBody", + "properties": { + "amount": { + "description": "Amount (can be monetary or non-monetary) to be recharged in the bucket. It could refer to positive (increment) or negative (decrement) values", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "product": { + "description": "A reference to the product related to the bucket that is impacted by the balance related operation", + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "reason": { + "type": "string", + "description": "Text describing the reason for the adjustment" + }, + "type": { + "type": "string", + "description": "A preconfigured value that describes a TopUp type which determines the prepay balance bucket in which the top-up is done (national-voice, roaming-voice, promotional-voice, data, ....)" + } + }, + "required": [ + "type", + "reason", + "amount" + ], + "type": "object" } - }, - "required": [ - "type", - "reason", - "amount" - ], - "type": "object" } - } } \ No newline at end of file diff --git a/Customer/BalanceAdjustmentRequest.schema.json b/Customer/BalanceAdjustmentRequest.schema.json index e6725fc9..cadb3614 100644 --- a/Customer/BalanceAdjustmentRequest.schema.json +++ b/Customer/BalanceAdjustmentRequest.schema.json @@ -1,64 +1,64 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceAdjustmentRequest.schema.json", - "title": "BalanceAdjustmentRequest", - "definitions": { - "BalanceAdjustmentRequest": { - "$id": "#BalanceAdjustmentRequest", - "description": "the BalanceAdjustment resource is a detailed description of credit adjustment operation erformed on a given bucket (defined by a specific product or reference to a product (i.e.: a commercial id such as an msisidn) and a service type)", - "properties": { - "bucket": { - "description": "A reference to the bucket impacted by the request. This is used in scenarios where the requestor knows beforehand the bucket that is going to be impacted instead of just referring to the commercial identifier of the impacted product and the type of bucket created under that product", - "$ref": "BucketBalanceRef.schema.json#BucketBalanceRef" - }, - "description": { - "type": "string", - "description": "Description of the recharge operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information. This is typically the resource url to retrieve individual top-up operation details" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the balance adjustment operation request" - }, - "partyAccount": { - "description": "A reference to the account that owns the bucket impacted by the balance related operation", - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - }, - "description": "Used to provide information about any other entity with relation to the operation" - }, - "requestedDate": { - "type": "string", - "description": "Date when the top-up request was received in the server" - }, - "requestor": { - "description": "Identifier for the user/customer/entity that performs the top-up action. This can be used to indicate the identifier of an agent that performs the operation on behalf of a user via a customer service channel. Structure including at least attributes �role� and �name�.", - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - }, - "validFor": { - "description": "The period defined for the adjusted amount to be part of the prepay balance. This could be used to define expiration times to remove balance not consumed.", - "$ref": "../Common/TimePeriodType.schema.json#TimePeriodType" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceAdjustmentRequest.schema.json", + "title": "BalanceAdjustmentRequest", + "definitions": { + "BalanceAdjustmentRequest": { + "$id": "#BalanceAdjustmentRequest", + "description": "the BalanceAdjustment resource is a detailed description of credit adjustment operation erformed on a given bucket (defined by a specific product or reference to a product (i.e.: a commercial id such as an msisidn) and a service type)", + "properties": { + "bucket": { + "description": "A reference to the bucket impacted by the request. This is used in scenarios where the requestor knows beforehand the bucket that is going to be impacted instead of just referring to the commercial identifier of the impacted product and the type of bucket created under that product", + "$ref": "BucketBalanceRef.schema.json#BucketBalanceRef" + }, + "description": { + "type": "string", + "description": "Description of the recharge operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information. This is typically the resource url to retrieve individual top-up operation details" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the balance adjustment operation request" + }, + "partyAccount": { + "description": "A reference to the account that owns the bucket impacted by the balance related operation", + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "description": "Used to provide information about any other entity with relation to the operation" + }, + "requestedDate": { + "type": "string", + "description": "Date when the top-up request was received in the server" + }, + "requestor": { + "description": "Identifier for the user/customer/entity that performs the top-up action. This can be used to indicate the identifier of an agent that performs the operation on behalf of a user via a customer service channel. Structure including at least attributes �role� and �name�.", + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "validFor": { + "description": "The period defined for the adjusted amount to be part of the prepay balance. This could be used to define expiration times to remove balance not consumed.", + "$ref": "../Common/TimePeriodType.schema.json#TimePeriodType" + } + }, + "allOf": [ + { + "$ref": "BalanceAdjustmentBody.schema.json#BalanceAdjustmentBody" + } + ], + "required": [ + "id", + "href", + "requestedDate", + "product" + ], + "type": "object" } - }, - "allOf": [ - { - "$ref": "BalanceAdjustmentBody.schema.json#BalanceAdjustmentBody" - } - ], - "required": [ - "id", - "href", - "requestedDate", - "product" - ], - "type": "object" } - } } \ No newline at end of file diff --git a/Customer/BalanceDeduct.schema.json b/Customer/BalanceDeduct.schema.json index 640058f2..ee2cabb9 100644 --- a/Customer/BalanceDeduct.schema.json +++ b/Customer/BalanceDeduct.schema.json @@ -1,64 +1,64 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceDeduct.schema.json", - "title": "BalanceDeduct", - "definitions": { - "BalanceDeduct": { - "$id": "#BalanceDeduct", - "description": "The Balance Deduct task resource is a detailed description of deduction operation. If balanceReserve Resource ID is contained in the deduct request message, the reserved balance will be performed deduct operation (if part of the reserved balance is deducted, the remain amount will be released); if balanceReserve Resource ID is not contained in the deduct request message, the balance will be deducted directly.", - "type": "object", - "properties": { - "confirmationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the deduction was confirmed in the server" - }, - "description": { - "type": "string", - "description": "Description of the deduct operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a deduction" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the deduction operation request" - }, - "requestedDate": { - "type": "string", - "format": "date-time", - "description": "Date when the deduction request was received in the server" - }, - "status": { - "type": "string", - "description": "Status of the deduction operation" - }, - "deductType": { - "type": "string", - "description": "A preconfigured value that describes a deduct type which determines the prepay balance bucket in which the deduct is done" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "product": { - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "balanceReserve": { - "$ref": "BalanceReserveRef.schema.json#BalanceReserveRef" - }, - "requestor": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "partyAccount": { - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceDeduct.schema.json", + "title": "BalanceDeduct", + "definitions": { + "BalanceDeduct": { + "$id": "#BalanceDeduct", + "description": "The Balance Deduct task resource is a detailed description of deduction operation. If balanceReserve Resource ID is contained in the deduct request message, the reserved balance will be performed deduct operation (if part of the reserved balance is deducted, the remain amount will be released); if balanceReserve Resource ID is not contained in the deduct request message, the balance will be deducted directly.", + "type": "object", + "properties": { + "confirmationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the deduction was confirmed in the server" + }, + "description": { + "type": "string", + "description": "Description of the deduct operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a deduction" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the deduction operation request" + }, + "requestedDate": { + "type": "string", + "format": "date-time", + "description": "Date when the deduction request was received in the server" + }, + "status": { + "type": "string", + "description": "Status of the deduction operation" + }, + "deductType": { + "type": "string", + "description": "A preconfigured value that describes a deduct type which determines the prepay balance bucket in which the deduct is done" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "product": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "balanceReserve": { + "$ref": "BalanceReserveRef.schema.json#BalanceReserveRef" + }, + "requestor": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "partyAccount": { + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/BalanceDeductRef.schema.json b/Customer/BalanceDeductRef.schema.json index 1b1fa6fd..5050f4f2 100644 --- a/Customer/BalanceDeductRef.schema.json +++ b/Customer/BalanceDeductRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceDeductRef.schema.json", - "title": "BalanceDeductRef", - "definitions": { - "BalanceDeductRef": { - "$id": "#BalanceDeductRef", - "description": "the resource that deduct balance information", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the balance information for a subscription" - }, - "id": { - "type": "string", - "description": "Unique identifier for the balancededuct entity" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceDeductRef.schema.json", + "title": "BalanceDeductRef", + "definitions": { + "BalanceDeductRef": { + "$id": "#BalanceDeductRef", + "description": "the resource that deduct balance information", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the balance information for a subscription" + }, + "id": { + "type": "string", + "description": "Unique identifier for the balancededuct entity" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/BalanceDeductRollback.schema.json b/Customer/BalanceDeductRollback.schema.json index c1d9660f..738fba98 100644 --- a/Customer/BalanceDeductRollback.schema.json +++ b/Customer/BalanceDeductRollback.schema.json @@ -1,55 +1,55 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceDeductRollback.schema.json", - "title": "BalanceDeductRollback", - "definitions": { - "BalanceDeductRollback": { - "$id": "#BalanceDeductRollback", - "description": "The Rollback Balance Deduct task resource is a detailed description of rollback deduction", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the rollback deduct operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a rollback deduction" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the rollback deduction operation request" - }, - "requestedDate": { - "type": "string", - "format": "date-time", - "description": "Date when the rollback deduction request was received in the server" - }, - "status": { - "type": "string", - "description": "Status of the rollback deduction operation" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "product": { - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "partyAccount": { - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - }, - "balanceDeduct": { - "$ref": "BalanceDeductRef.schema.json#BalanceDeductRef" - }, - "requestor": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceDeductRollback.schema.json", + "title": "BalanceDeductRollback", + "definitions": { + "BalanceDeductRollback": { + "$id": "#BalanceDeductRollback", + "description": "The Rollback Balance Deduct task resource is a detailed description of rollback deduction", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the rollback deduct operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a rollback deduction" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the rollback deduction operation request" + }, + "requestedDate": { + "type": "string", + "format": "date-time", + "description": "Date when the rollback deduction request was received in the server" + }, + "status": { + "type": "string", + "description": "Status of the rollback deduction operation" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "product": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "partyAccount": { + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "balanceDeduct": { + "$ref": "BalanceDeductRef.schema.json#BalanceDeductRef" + }, + "requestor": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/BalanceReserve.schema.json b/Customer/BalanceReserve.schema.json index b6ec7b23..5024416f 100644 --- a/Customer/BalanceReserve.schema.json +++ b/Customer/BalanceReserve.schema.json @@ -1,79 +1,79 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceReserve.schema.json", - "title": "BalanceReserve", - "definitions": { - "BalanceReserve": { - "$id": "#BalanceReserve", - "description": "The Balance Reserve Operation resource is a detailed description of a balance reserve operation requested over a subscription", - "type": "object", - "properties": { - "confirmationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the reserve request was confirmed in the server" - }, - "description": { - "type": "string", - "description": "Description of the reserve operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a reserve" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the reserve operation request" - }, - "isAutoDeduct": { - "type": "boolean", - "description": "Indicates if the reserved balance is auto deducted after a time period" - }, - "remainedAmount": { - "type": "number", - "format": "float", - "description": "Amount (can be monetary or non-monetary) to be remained in the bucket" - }, - "requestedDate": { - "type": "string", - "format": "date-time", - "description": "Date when the reserve request was received in the server" - }, - "reservedAmount": { - "type": "number", - "format": "float", - "description": "Amount (can be monetary or non-monetary) to be reserved in the bucket" - }, - "status": { - "type": "string", - "description": "Status of the reserve operation" - }, - "reserveType": { - "type": "string", - "description": "A preconfigured value that describes a reserve type which determines the prepay balance bucket in which the reserve is done" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Indicates if the reserved balance is auto deducted after a time period" - }, - "requestor": { - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - }, - "product": { - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "partyAccount": { - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceReserve.schema.json", + "title": "BalanceReserve", + "definitions": { + "BalanceReserve": { + "$id": "#BalanceReserve", + "description": "The Balance Reserve Operation resource is a detailed description of a balance reserve operation requested over a subscription", + "type": "object", + "properties": { + "confirmationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the reserve request was confirmed in the server" + }, + "description": { + "type": "string", + "description": "Description of the reserve operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a reserve" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the reserve operation request" + }, + "isAutoDeduct": { + "type": "boolean", + "description": "Indicates if the reserved balance is auto deducted after a time period" + }, + "remainedAmount": { + "type": "number", + "format": "float", + "description": "Amount (can be monetary or non-monetary) to be remained in the bucket" + }, + "requestedDate": { + "type": "string", + "format": "date-time", + "description": "Date when the reserve request was received in the server" + }, + "reservedAmount": { + "type": "number", + "format": "float", + "description": "Amount (can be monetary or non-monetary) to be reserved in the bucket" + }, + "status": { + "type": "string", + "description": "Status of the reserve operation" + }, + "reserveType": { + "type": "string", + "description": "A preconfigured value that describes a reserve type which determines the prepay balance bucket in which the reserve is done" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Indicates if the reserved balance is auto deducted after a time period" + }, + "requestor": { + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "product": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "partyAccount": { + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/BalanceReserveRef.schema.json b/Customer/BalanceReserveRef.schema.json index 466fbc8d..d82f6fd8 100644 --- a/Customer/BalanceReserveRef.schema.json +++ b/Customer/BalanceReserveRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceReserveRef.schema.json", - "title": "BalanceReserveRef", - "definitions": { - "BalanceReserveRef": { - "$id": "#BalanceReserveRef", - "description": "the resource that holds reserved balance information", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the balance information for a subscription" - }, - "id": { - "type": "string", - "description": "Unique identifier for the balancereserve entity" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceReserveRef.schema.json", + "title": "BalanceReserveRef", + "definitions": { + "BalanceReserveRef": { + "$id": "#BalanceReserveRef", + "description": "the resource that holds reserved balance information", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the balance information for a subscription" + }, + "id": { + "type": "string", + "description": "Unique identifier for the balancereserve entity" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/BalanceTopup.schema.json b/Customer/BalanceTopup.schema.json index 1ca77014..45a2ef23 100644 --- a/Customer/BalanceTopup.schema.json +++ b/Customer/BalanceTopup.schema.json @@ -1,12 +1,12 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTopup.schema.json", - "title": "BalanceTopup", - "definitions": { - "BalanceTopup": { - "$id": "#BalanceTopup", - "description": "#TODO", - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTopup.schema.json", + "title": "BalanceTopup", + "definitions": { + "BalanceTopup": { + "$id": "#BalanceTopup", + "description": "#TODO", + "type": "object" + } } - } } \ No newline at end of file diff --git a/Customer/BalanceTopupBody.schema.json b/Customer/BalanceTopupBody.schema.json index bc3a800e..3dd3e384 100644 --- a/Customer/BalanceTopupBody.schema.json +++ b/Customer/BalanceTopupBody.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTopupBody.schema.json", - "title": "BalanceTopupBody", - "definitions": { - "BalanceTopupBody": { - "$id": "#BalanceTopupBody", - "properties": { - "amount": { - "description": "Amount (can be monetary or non-monetary) to be recharged in the bucket", - "$ref": "../Common/QuantityType.schema.json#QuantityType" - }, - "channel": { - "description": "Indicator for the channel used to request the top-up operation. Structure including at least attribute �name�", - "$ref": "../Common/ChannelRef.schema.json#ChannelRef" - }, - "product": { - "description": "A reference to the product related to the bucket that is impacted by the balance related operation", - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "type": { - "type": "string", - "description": "A preconfigured value that describes a TopUp type which determines the prepay balance bucket in which the top-up is done (national-voice, roaming-voice, promotional-voice, data, ....)" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTopupBody.schema.json", + "title": "BalanceTopupBody", + "definitions": { + "BalanceTopupBody": { + "$id": "#BalanceTopupBody", + "properties": { + "amount": { + "description": "Amount (can be monetary or non-monetary) to be recharged in the bucket", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "channel": { + "description": "Indicator for the channel used to request the top-up operation. Structure including at least attribute �name�", + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "product": { + "description": "A reference to the product related to the bucket that is impacted by the balance related operation", + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "type": { + "type": "string", + "description": "A preconfigured value that describes a TopUp type which determines the prepay balance bucket in which the top-up is done (national-voice, roaming-voice, promotional-voice, data, ....)" + } + }, + "required": [ + "type", + "channel", + "amount" + ], + "type": "object" } - }, - "required": [ - "type", - "channel", - "amount" - ], - "type": "object" } - } } \ No newline at end of file diff --git a/Customer/BalanceTopupRequest.schema.json b/Customer/BalanceTopupRequest.schema.json index 3bf0e1c7..0a7c5ed8 100644 --- a/Customer/BalanceTopupRequest.schema.json +++ b/Customer/BalanceTopupRequest.schema.json @@ -1,99 +1,99 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTopupRequest.schema.json", - "title": "BalanceTopupRequest", - "definitions": { - "BalanceTopupRequest": { - "$id": "#BalanceTopupRequest", - "description": "Represents a detailed description of a recharge operation requested over a bucket (defined by a specific product or reference to a product (i.e.: a commercial id such as an msisidn) and a service type)", - "properties": { - "bucket": { - "description": "A reference to the bucket impacted by the request. This is used in scenarios where the requestor knows beforehand the bucket that is going to be impacted instead of just referring to the commercial identifier of the impacted product and the type of bucket created under that product", - "$ref": "BucketBalanceRef.schema.json#BucketBalanceRef" - }, - "confirmationDate": { - "type": "string", - "description": "Date when the top-up was confirmed in the server" - }, - "description": { - "type": "string", - "description": "Description of the recharge operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information. This is typically the resource url to retrieve individual top-up operation details" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the recharge operation request" - }, - "isAutoTopup": { - "type": "boolean", - "description": "Indicates if the topup requested is an autotopup (to be processed periodically)" - }, - "nrOfPeriods": { - "type": "integer", - "description": "For autotopup indicates the number of occurrences of the period the recharge operation must be executed. If not included then no limit is set to stop the executionof the topup every period" - }, - "partyAccount": { - "description": "A reference to the account that owns the bucket impacted by the balance related operation", - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - }, - "paymentMethod": { - "description": "Payment method used for the recharge operation (e.g.: cash, credit card, �). Structure including at least attribute �name�. Notice that the use of a voucher can be managed as a specific methodtype, where he voucher code can be passed as value.", - "$ref": "PaymentMethodRefOrValue.schema.json#PaymentMethodRefOrValue" - }, - "recurringPeriod": { - "type": "string", - "description": "For autotopup indicates the periodicity for the recharge operation (monthly, weekly, )" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - }, - "description": "Used to provide information about any other entity with relation to the operation" - }, - "requestedDate": { - "type": "string", - "description": "Date when the top-up request was received in the server" - }, - "requestor": { - "description": "Identifier for the user/customer/entity that performs the top-up action. This can be used to indicate the identifier of an agent that performs the operation on behalf of a user via a customer service channel. Structure including at least attributes �role� and �name�.", - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - }, - "status": { - "type": "string", - "description": "Status of the top-up operation Supported values are: - confirmed - cancelled - in progress", - "enum": [ - "confirmed", - "cancelled", - "in progress" - ] - }, - "validFor": { - "description": "The period defined for the recharged amount to be part of the prepay balance. This could be used to define expiration times to remove balance not consumed.", - "$ref": "../Common/TimePeriodType.schema.json#TimePeriodType" - }, - "voucher": { - "type": "string", - "description": "Identifier for the voucher when the topup can be perfomed by this means (referenced by a voucher based payment mean). This attribute is left in this release to keep compatibility with previous version and for implementations that do not relay on paymentMethods. A voucher can be managed as a specific methodtype, where he voucher code can be passed as value." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTopupRequest.schema.json", + "title": "BalanceTopupRequest", + "definitions": { + "BalanceTopupRequest": { + "$id": "#BalanceTopupRequest", + "description": "Represents a detailed description of a recharge operation requested over a bucket (defined by a specific product or reference to a product (i.e.: a commercial id such as an msisidn) and a service type)", + "properties": { + "bucket": { + "description": "A reference to the bucket impacted by the request. This is used in scenarios where the requestor knows beforehand the bucket that is going to be impacted instead of just referring to the commercial identifier of the impacted product and the type of bucket created under that product", + "$ref": "BucketBalanceRef.schema.json#BucketBalanceRef" + }, + "confirmationDate": { + "type": "string", + "description": "Date when the top-up was confirmed in the server" + }, + "description": { + "type": "string", + "description": "Description of the recharge operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information. This is typically the resource url to retrieve individual top-up operation details" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the recharge operation request" + }, + "isAutoTopup": { + "type": "boolean", + "description": "Indicates if the topup requested is an autotopup (to be processed periodically)" + }, + "nrOfPeriods": { + "type": "integer", + "description": "For autotopup indicates the number of occurrences of the period the recharge operation must be executed. If not included then no limit is set to stop the executionof the topup every period" + }, + "partyAccount": { + "description": "A reference to the account that owns the bucket impacted by the balance related operation", + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "paymentMethod": { + "description": "Payment method used for the recharge operation (e.g.: cash, credit card, �). Structure including at least attribute �name�. Notice that the use of a voucher can be managed as a specific methodtype, where he voucher code can be passed as value.", + "$ref": "PaymentMethodRefOrValue.schema.json#PaymentMethodRefOrValue" + }, + "recurringPeriod": { + "type": "string", + "description": "For autotopup indicates the periodicity for the recharge operation (monthly, weekly, )" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "description": "Used to provide information about any other entity with relation to the operation" + }, + "requestedDate": { + "type": "string", + "description": "Date when the top-up request was received in the server" + }, + "requestor": { + "description": "Identifier for the user/customer/entity that performs the top-up action. This can be used to indicate the identifier of an agent that performs the operation on behalf of a user via a customer service channel. Structure including at least attributes �role� and �name�.", + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "status": { + "type": "string", + "description": "Status of the top-up operation Supported values are: - confirmed - cancelled - in progress", + "enum": [ + "confirmed", + "cancelled", + "in progress" + ] + }, + "validFor": { + "description": "The period defined for the recharged amount to be part of the prepay balance. This could be used to define expiration times to remove balance not consumed.", + "$ref": "../Common/TimePeriodType.schema.json#TimePeriodType" + }, + "voucher": { + "type": "string", + "description": "Identifier for the voucher when the topup can be perfomed by this means (referenced by a voucher based payment mean). This attribute is left in this release to keep compatibility with previous version and for implementations that do not relay on paymentMethods. A voucher can be managed as a specific methodtype, where he voucher code can be passed as value." + } + }, + "allOf": [ + { + "$ref": "BalanceTopupBody.schema.json#BalanceTopupBody" + } + ], + "required": [ + "id", + "href", + "validFor", + "requestedDate", + "confirmationDate", + "status" + ], + "type": "object" } - }, - "allOf": [ - { - "$ref": "BalanceTopupBody.schema.json#BalanceTopupBody" - } - ], - "required": [ - "id", - "href", - "validFor", - "requestedDate", - "confirmationDate", - "status" - ], - "type": "object" } - } } \ No newline at end of file diff --git a/Customer/BalanceTopupStatus.schema.json b/Customer/BalanceTopupStatus.schema.json index 95b874e8..d3f34716 100644 --- a/Customer/BalanceTopupStatus.schema.json +++ b/Customer/BalanceTopupStatus.schema.json @@ -1,24 +1,24 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTopupStatus.schema.json", - "title": "BalanceTopupStatus", - "definitions": { - "BalanceTopupStatus": { - "description": "Structure including specific information about change of status for the topup operation", - "properties": { - "statusChangeDate": { - "type": "string", - "description": "Date in which the latest change of status was requested" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTopupStatus.schema.json", + "title": "BalanceTopupStatus", + "definitions": { + "BalanceTopupStatus": { + "description": "Structure including specific information about change of status for the topup operation", + "properties": { + "statusChangeDate": { + "type": "string", + "description": "Date in which the latest change of status was requested" + } + }, + "allOf": [ + { + "$ref": "BalanceTopupStatusTypeModify.schema.json#/definitions/BalanceTopupStatusTypeModify" + } + ], + "required": [ + "statusChangeDate" + ] } - }, - "allOf": [ - { - "$ref": "BalanceTopupStatusTypeModify.schema.json#/definitions/BalanceTopupStatusTypeModify" - } - ], - "required": [ - "statusChangeDate" - ] } - } } \ No newline at end of file diff --git a/Customer/BalanceTopupStatusTypeModify.schema.json b/Customer/BalanceTopupStatusTypeModify.schema.json index c6ac437c..4b3b36a2 100644 --- a/Customer/BalanceTopupStatusTypeModify.schema.json +++ b/Customer/BalanceTopupStatusTypeModify.schema.json @@ -1,20 +1,20 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTopupStatusTypeModify.schema.json", - "title": "BalanceTopupStatusTypeModify", - "definitions": { - "BalanceTopupStatusTypeModify": { - "$id": "#BalanceTopupStatusTypeModify", - "properties": { - "status": { - "type": "string", - "description": "Current status of the operation request" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTopupStatusTypeModify.schema.json", + "title": "BalanceTopupStatusTypeModify", + "definitions": { + "BalanceTopupStatusTypeModify": { + "$id": "#BalanceTopupStatusTypeModify", + "properties": { + "status": { + "type": "string", + "description": "Current status of the operation request" + } + }, + "required": [ + "status" + ], + "type": "object" } - }, - "required": [ - "status" - ], - "type": "object" } - } } \ No newline at end of file diff --git a/Customer/BalanceTransfer.schema.json b/Customer/BalanceTransfer.schema.json index c708f976..b08ec8b7 100644 --- a/Customer/BalanceTransfer.schema.json +++ b/Customer/BalanceTransfer.schema.json @@ -1,12 +1,12 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTransfer.schema.json", - "title": "BalanceTransfer", - "definitions": { - "BalanceTransfer": { - "$id": "#BalanceTransfer", - "description": "#TODO", - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTransfer.schema.json", + "title": "BalanceTransfer", + "definitions": { + "BalanceTransfer": { + "$id": "#BalanceTransfer", + "description": "#TODO", + "type": "object" + } } - } } \ No newline at end of file diff --git a/Customer/BalanceTransferBody.schema.json b/Customer/BalanceTransferBody.schema.json index 68a81e4e..c8d6d9ae 100644 --- a/Customer/BalanceTransferBody.schema.json +++ b/Customer/BalanceTransferBody.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTransferBody.schema.json", - "title": "BalanceTransferBody", - "definitions": { - "BalanceTransferBody": { - "$id": "#BalanceTransferBody", - "properties": { - "amount": { - "description": "Amount (can be monetary or non-monetary) to be transferred", - "$ref": "../Common/QuantityType.schema.json#QuantityType" - }, - "channel": { - "description": "Indicator for the channel used to request the top-up operation. Structure including at least attribute �name�", - "$ref": "../Common/ChannelRef.schema.json#ChannelRef" - }, - "product": { - "description": "A reference to the product related to the bucket that is impacted by the balance related operation", - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "targetId": { - "type": "string", - "description": "Identifier for the entity that receives the transfer (reference to a product via a commercial identifier such as an msisidn that relates to an internal product id)" - }, - "type": { - "type": "string", - "description": "A preconfigured value that describes a TopUp type which determines the prepay balance bucket in which the top-up is done (national-voice, roaming-voice, promotional-voice, data, ....)" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTransferBody.schema.json", + "title": "BalanceTransferBody", + "definitions": { + "BalanceTransferBody": { + "$id": "#BalanceTransferBody", + "properties": { + "amount": { + "description": "Amount (can be monetary or non-monetary) to be transferred", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "channel": { + "description": "Indicator for the channel used to request the top-up operation. Structure including at least attribute �name�", + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "product": { + "description": "A reference to the product related to the bucket that is impacted by the balance related operation", + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "targetId": { + "type": "string", + "description": "Identifier for the entity that receives the transfer (reference to a product via a commercial identifier such as an msisidn that relates to an internal product id)" + }, + "type": { + "type": "string", + "description": "A preconfigured value that describes a TopUp type which determines the prepay balance bucket in which the top-up is done (national-voice, roaming-voice, promotional-voice, data, ....)" + } + }, + "required": [ + "type", + "channel", + "targetId", + "amount" + ], + "type": "object" } - }, - "required": [ - "type", - "channel", - "targetId", - "amount" - ], - "type": "object" } - } } \ No newline at end of file diff --git a/Customer/BalanceTransferRequest.schema.json b/Customer/BalanceTransferRequest.schema.json index fa3b7ed8..badb405f 100644 --- a/Customer/BalanceTransferRequest.schema.json +++ b/Customer/BalanceTransferRequest.schema.json @@ -1,100 +1,100 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTransferRequest.schema.json", - "title": "BalanceTransferRequest", - "definitions": { - "BalanceTransferRequest": { - "$id": "#BalanceTransferRequest", - "description": "The BalanceTransfer resource is a detailed description of credit transfer operation requested between two buckets (reference to products owned by customers and consuming credit when using a service).", - "properties": { - "bucket": { - "description": "A reference to the bucket impacted by the request. This is used in scenarios where the requestor knows beforehand the bucket that is going to be impacted instead of just referring to the commercial identifier of the impacted product and the type of bucket created under that product", - "$ref": "BucketBalanceRef.schema.json#BucketBalanceRef" - }, - "confirmationDate": { - "type": "string", - "description": "Date when the transfer was confirmed in the server" - }, - "costOwner": { - "type": "string", - "description": "Indicates the entity responsible to assume the cost of the transfer operation", - "enum": [ - "originator", - "receiver" - ] - }, - "description": { - "type": "string", - "description": "Description of the transfer operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information. This is typically the resource url to retrieve individual transfer operation details" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the balance transfer operation request." - }, - "partyAccount": { - "description": "A reference to the account that owns the bucket impacted by the balance related operation", - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - }, - "reason": { - "type": "string", - "description": "Text describing the reason for the adjustment" - }, - "receiver": { - "description": "Identifier for the user/customer/entity that receives the transfer action when it is required to indicate additional customer hierarchy information regarding the entity receiving the balance transfer", - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - }, - "description": "Used to provide information about any other entity with relation to the operation" - }, - "requestedDate": { - "type": "string", - "description": "Date when the transfer request was received in the server" - }, - "requestor": { - "description": "Identifier for the user/customer/entity that performs the top-up action. This can be used to indicate the identifier of an agent that performs the operation on behalf of a user via a customer service channel. Structure including at least attributes �role� and �name�.", - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - }, - "status": { - "type": "string", - "description": "Status of the top-up.", - "enum": [ - "confirmed", - "cancelled", - "in progress" - ] - }, - "targetType": { - "type": "string", - "description": "Intended for scenarios where the transfer is done from one bucket type to another (from voice to data). A preconfigured value that describes a Transfer type which determines the prepay balance bucket in which the transfer is done" - }, - "transferCost": { - "description": "Associated cost to be charged for the transfer operation (can be monetary or non-monetary)", - "$ref": "../Common/QuantityType.schema.json#QuantityType" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTransferRequest.schema.json", + "title": "BalanceTransferRequest", + "definitions": { + "BalanceTransferRequest": { + "$id": "#BalanceTransferRequest", + "description": "The BalanceTransfer resource is a detailed description of credit transfer operation requested between two buckets (reference to products owned by customers and consuming credit when using a service).", + "properties": { + "bucket": { + "description": "A reference to the bucket impacted by the request. This is used in scenarios where the requestor knows beforehand the bucket that is going to be impacted instead of just referring to the commercial identifier of the impacted product and the type of bucket created under that product", + "$ref": "BucketBalanceRef.schema.json#BucketBalanceRef" + }, + "confirmationDate": { + "type": "string", + "description": "Date when the transfer was confirmed in the server" + }, + "costOwner": { + "type": "string", + "description": "Indicates the entity responsible to assume the cost of the transfer operation", + "enum": [ + "originator", + "receiver" + ] + }, + "description": { + "type": "string", + "description": "Description of the transfer operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information. This is typically the resource url to retrieve individual transfer operation details" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the balance transfer operation request." + }, + "partyAccount": { + "description": "A reference to the account that owns the bucket impacted by the balance related operation", + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "reason": { + "type": "string", + "description": "Text describing the reason for the adjustment" + }, + "receiver": { + "description": "Identifier for the user/customer/entity that receives the transfer action when it is required to indicate additional customer hierarchy information regarding the entity receiving the balance transfer", + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "description": "Used to provide information about any other entity with relation to the operation" + }, + "requestedDate": { + "type": "string", + "description": "Date when the transfer request was received in the server" + }, + "requestor": { + "description": "Identifier for the user/customer/entity that performs the top-up action. This can be used to indicate the identifier of an agent that performs the operation on behalf of a user via a customer service channel. Structure including at least attributes �role� and �name�.", + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "status": { + "type": "string", + "description": "Status of the top-up.", + "enum": [ + "confirmed", + "cancelled", + "in progress" + ] + }, + "targetType": { + "type": "string", + "description": "Intended for scenarios where the transfer is done from one bucket type to another (from voice to data). A preconfigured value that describes a Transfer type which determines the prepay balance bucket in which the transfer is done" + }, + "transferCost": { + "description": "Associated cost to be charged for the transfer operation (can be monetary or non-monetary)", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + } + }, + "allOf": [ + { + "$ref": "BalanceTransferBody.schema.json#BalanceTransferBody" + } + ], + "required": [ + "id", + "href", + "reason", + "requestedDate", + "confirmationDate", + "status", + "product" + ], + "type": "object" } - }, - "allOf": [ - { - "$ref": "BalanceTransferBody.schema.json#BalanceTransferBody" - } - ], - "required": [ - "id", - "href", - "reason", - "requestedDate", - "confirmationDate", - "status", - "product" - ], - "type": "object" } - } } \ No newline at end of file diff --git a/Customer/BalanceTransferStatusTypeModify.schema.json b/Customer/BalanceTransferStatusTypeModify.schema.json index f6c43481..98c211ae 100644 --- a/Customer/BalanceTransferStatusTypeModify.schema.json +++ b/Customer/BalanceTransferStatusTypeModify.schema.json @@ -1,19 +1,19 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTransferStatusTypeModify.schema.json", - "title": "BalanceTransferStatusTypeModify", - "definitions": { - "BalanceTransferStatusTypeModify": { - "$id": "#BalanceTransferStatusTypeModify", - "properties": { - "status": { - "type": "string" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTransferStatusTypeModify.schema.json", + "title": "BalanceTransferStatusTypeModify", + "definitions": { + "BalanceTransferStatusTypeModify": { + "$id": "#BalanceTransferStatusTypeModify", + "properties": { + "status": { + "type": "string" + } + }, + "required": [ + "status" + ], + "type": "object" } - }, - "required": [ - "status" - ], - "type": "object" } - } } \ No newline at end of file diff --git a/Customer/BalanceUnreserve.schema.json b/Customer/BalanceUnreserve.schema.json index 80d011e4..249de9e5 100644 --- a/Customer/BalanceUnreserve.schema.json +++ b/Customer/BalanceUnreserve.schema.json @@ -1,52 +1,52 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceUnreserve.schema.json", - "title": "BalanceUnreserve", - "definitions": { - "BalanceUnreserve": { - "$id": "#BalanceUnreserve", - "description": "The Balance Unreserve Operation resource is a detailed description of a balance unreserve operation requested over a subscription", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the unreserve operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a unreserve" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the unreserve operation request" - }, - "requestedDate": { - "type": "string", - "format": "date-time", - "description": "Date when the unreserve request was received in the server" - }, - "status": { - "type": "string", - "description": "Status of the unreserve operation" - }, - "balanceReserve": { - "$ref": "BalanceReserveRef.schema.json#BalanceReserveRef" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "requestor": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "product": { - "$ref": "../Product/ProductRef.schema.json#ProductRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceUnreserve.schema.json", + "title": "BalanceUnreserve", + "definitions": { + "BalanceUnreserve": { + "$id": "#BalanceUnreserve", + "description": "The Balance Unreserve Operation resource is a detailed description of a balance unreserve operation requested over a subscription", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the unreserve operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a unreserve" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the unreserve operation request" + }, + "requestedDate": { + "type": "string", + "format": "date-time", + "description": "Date when the unreserve request was received in the server" + }, + "status": { + "type": "string", + "description": "Status of the unreserve operation" + }, + "balanceReserve": { + "$ref": "BalanceReserveRef.schema.json#BalanceReserveRef" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "requestor": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "product": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/BankCardDetails.schema.json b/Customer/BankCardDetails.schema.json index e09a4e9b..6ea1f2a2 100644 --- a/Customer/BankCardDetails.schema.json +++ b/Customer/BankCardDetails.schema.json @@ -1,52 +1,52 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankCardDetails.schema.json", - "title": "BankCardDetails", - "definitions": { - "BankCardDetails": { - "$id": "#BankCardDetails", - "description": "Detailed information for a bank card", - "type": "object", - "properties": { - "bank": { - "type": "string", - "description": "Bank that issued the card" - }, - "brand": { - "type": "string", - "description": "Card brand, such as Visa, MasterCard, AmericanExpress" - }, - "cardNumber": { - "type": "string", - "description": "Credit long card number" - }, - "cvv": { - "type": "string", - "description": "The security code (e.g.: CVV, CVV2) of the card" - }, - "expirationDate": { - "type": "string", - "format": "date-time", - "description": "Expiration date of the card" - }, - "lastFourDigits": { - "type": "string", - "description": "Last four digits of the credit card" - }, - "nameOnCard": { - "type": "string", - "description": "Name on the card" - }, - "cardType": { - "type": "string", - "description": "Type of the card, such as Credit, Debit" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankCardDetails.schema.json", + "title": "BankCardDetails", + "definitions": { + "BankCardDetails": { + "$id": "#BankCardDetails", + "description": "Detailed information for a bank card", + "type": "object", + "properties": { + "bank": { + "type": "string", + "description": "Bank that issued the card" + }, + "brand": { + "type": "string", + "description": "Card brand, such as Visa, MasterCard, AmericanExpress" + }, + "cardNumber": { + "type": "string", + "description": "Credit long card number" + }, + "cvv": { + "type": "string", + "description": "The security code (e.g.: CVV, CVV2) of the card" + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "Expiration date of the card" + }, + "lastFourDigits": { + "type": "string", + "description": "Last four digits of the credit card" + }, + "nameOnCard": { + "type": "string", + "description": "Name on the card" + }, + "cardType": { + "type": "string", + "description": "Type of the card, such as Credit, Debit" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/BankCardMethod.schema.json b/Customer/BankCardMethod.schema.json index 25d72f1a..f8d15da2 100644 --- a/Customer/BankCardMethod.schema.json +++ b/Customer/BankCardMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankCardMethod.schema.json", - "title": "BankCardMethod", - "definitions": { - "BankCardMethod": { - "$id": "#BankCardMethod", - "type": "object", - "properties": { - "details": { - "$ref": "BankCardDetails.schema.json#BankCardDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankCardMethod.schema.json", + "title": "BankCardMethod", + "definitions": { + "BankCardMethod": { + "$id": "#BankCardMethod", + "type": "object", + "properties": { + "details": { + "$ref": "BankCardDetails.schema.json#BankCardDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/Bill.schema.json b/Customer/Bill.schema.json index 698af8d3..c408be29 100644 --- a/Customer/Bill.schema.json +++ b/Customer/Bill.schema.json @@ -1,118 +1,118 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Bill.schema.json", - "title": "Bill", - "definitions": { - "Bill": { - "$id": "#Bill", - "description": "The Bill entity is used to model a bill (aka an invoice). It represents a total amount due for all products during the billing period and all significant date.", - "type": "object", - "properties": { - "amountDue": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Amount due for this bill expressed in the given currency" - }, - "billDate": { - "type": "string", - "format": "date-time", - "description": "Bill date" - }, - "billingPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Billing period of the bill (used for onCycle bill only)" - }, - "billNo": { - "type": "string", - "description": "Bill reference known by the customer or the party and displayed on the bill. Could be different from the id." - }, - "category": { - "type": "string", - "description": "Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note" - }, - "href": { - "type": "string", - "description": "Bill unique reference" - }, - "id": { - "type": "string", - "description": "Bill unique identifier" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date of bill last update" - }, - "nextBillDate": { - "type": "string", - "format": "date-time", - "description": "Approximate date of the next bill production given for information (only used for onCycle bill)" - }, - "paymentDueDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the amount due should have been paid" - }, - "remainingAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Remaining amount to be paid for this bill expressed in the given currency" - }, - "runType": { - "type": "string", - "description": "onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close)" - }, - "state": { - "type": "string", - "description": "State that a bill could take during its lifecycle : New, Validated, On Hold, Sent, Partially paid or Settled" - }, - "taxExcludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Total tax excluded amount expressed in the given currency" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Total tax included amount expressed in the given" - }, - "billDocument": { - "type": "array", - "items": { - "$ref": "../Common/FileDocument.schema.json#FileDocument" - }, - "description": "Document(s) associated to the bill" - }, - "paymentItem": { - "type": "array", - "items": { - "$ref": "PaymentItem.schema.json#PaymentItem" - }, - "description": "Payment items already lettered on this bill." - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef" - }, - "taxItem": { - "type": "array", - "items": { - "$ref": "TaxItem.schema.json#TaxItem" - } - }, - "paymentMethod": { - "$ref": "PaymentMethodRef.schema.json#PaymentMethodRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "financialAccount": { - "$ref": "../EngagedParty/FinancialAccountRef.schema.json#FinancialAccountRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Bill.schema.json", + "title": "Bill", + "definitions": { + "Bill": { + "$id": "#Bill", + "description": "The Bill entity is used to model a bill (aka an invoice). It represents a total amount due for all products during the billing period and all significant date.", + "type": "object", + "properties": { + "amountDue": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Amount due for this bill expressed in the given currency" + }, + "billDate": { + "type": "string", + "format": "date-time", + "description": "Bill date" + }, + "billingPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Billing period of the bill (used for onCycle bill only)" + }, + "billNo": { + "type": "string", + "description": "Bill reference known by the customer or the party and displayed on the bill. Could be different from the id." + }, + "category": { + "type": "string", + "description": "Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note" + }, + "href": { + "type": "string", + "description": "Bill unique reference" + }, + "id": { + "type": "string", + "description": "Bill unique identifier" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date of bill last update" + }, + "nextBillDate": { + "type": "string", + "format": "date-time", + "description": "Approximate date of the next bill production given for information (only used for onCycle bill)" + }, + "paymentDueDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the amount due should have been paid" + }, + "remainingAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Remaining amount to be paid for this bill expressed in the given currency" + }, + "runType": { + "type": "string", + "description": "onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close)" + }, + "state": { + "type": "string", + "description": "State that a bill could take during its lifecycle : New, Validated, On Hold, Sent, Partially paid or Settled" + }, + "taxExcludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Total tax excluded amount expressed in the given currency" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Total tax included amount expressed in the given" + }, + "billDocument": { + "type": "array", + "items": { + "$ref": "../Common/FileDocument.schema.json#FileDocument" + }, + "description": "Document(s) associated to the bill" + }, + "paymentItem": { + "type": "array", + "items": { + "$ref": "PaymentItem.schema.json#PaymentItem" + }, + "description": "Payment items already lettered on this bill." + }, + "billingAccount": { + "$ref": "BillingAccountRef.schema.json#BillingAccountRef" + }, + "taxItem": { + "type": "array", + "items": { + "$ref": "TaxItem.schema.json#TaxItem" + } + }, + "paymentMethod": { + "$ref": "PaymentMethodRef.schema.json#PaymentMethodRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "financialAccount": { + "$ref": "../EngagedParty/FinancialAccountRef.schema.json#FinancialAccountRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/BillFormat.schema.json b/Customer/BillFormat.schema.json index b4a11aac..604c782a 100644 --- a/Customer/BillFormat.schema.json +++ b/Customer/BillFormat.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillFormat.schema.json", - "title": "BillFormat", - "definitions": { - "BillFormat": { - "$id": "#BillFormat", - "description": "A detailed description of the way in which a bill is presented.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "description": { - "type": "string", - "description": "An explanatory text for this bill format" - }, - "href": { - "type": "string", - "description": "Reference of the bill format" - }, - "id": { - "type": "string", - "description": "Unique identifier of the bill format" - }, - "name": { - "type": "string", - "description": "A short descriptive name" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillFormat.schema.json", + "title": "BillFormat", + "definitions": { + "BillFormat": { + "$id": "#BillFormat", + "description": "A detailed description of the way in which a bill is presented.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "description": { + "type": "string", + "description": "An explanatory text for this bill format" + }, + "href": { + "type": "string", + "description": "Reference of the bill format" + }, + "id": { + "type": "string", + "description": "Unique identifier of the bill format" + }, + "name": { + "type": "string", + "description": "A short descriptive name" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/BillFormatRef.schema.json b/Customer/BillFormatRef.schema.json index 517bc774..5b63a1c3 100644 --- a/Customer/BillFormatRef.schema.json +++ b/Customer/BillFormatRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillFormatRef.schema.json", - "title": "BillFormatRef", - "definitions": { - "BillFormatRef": { - "$id": "#BillFormatRef", - "description": "BillFormat reference. A bill format is a description of the way in which a bill is presented.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the bill format" - }, - "id": { - "type": "string", - "description": "Unique identifier of the bill format" - }, - "name": { - "type": "string", - "description": "A short descriptive name" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillFormatRef.schema.json", + "title": "BillFormatRef", + "definitions": { + "BillFormatRef": { + "$id": "#BillFormatRef", + "description": "BillFormat reference. A bill format is a description of the way in which a bill is presented.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the bill format" + }, + "id": { + "type": "string", + "description": "Unique identifier of the bill format" + }, + "name": { + "type": "string", + "description": "A short descriptive name" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/BillFormatRefOrValue.schema.json b/Customer/BillFormatRefOrValue.schema.json index e2b05516..dfed3a83 100644 --- a/Customer/BillFormatRefOrValue.schema.json +++ b/Customer/BillFormatRefOrValue.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillFormatRefOrValue.schema.json", - "title": "BillFormatRefOrValue", - "definitions": { - "BillFormatRefOrValue": { - "discriminator": "isRef", - "$id": "#BillFormatRefOrValue", - "description": "An attachment by value or by reference.", - "type": "object", - "properties": { - "isRef": { - "type": "boolean", - "default": true + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillFormatRefOrValue.schema.json", + "title": "BillFormatRefOrValue", + "definitions": { + "BillFormatRefOrValue": { + "discriminator": "isRef", + "$id": "#BillFormatRefOrValue", + "description": "An attachment by value or by reference.", + "type": "object", + "properties": { + "isRef": { + "type": "boolean", + "default": true + } + }, + "required": [ + "isRef", + "role" + ], + "allOf": [ + { + "$ref": "BillFormatRef.schema.json#BillFormatRef" + }, + { + "$ref": "BillFormat.schema.json#BillFormat" + } + ] } - }, - "required": [ - "isRef", - "role" - ], - "allOf": [ - { - "$ref": "BillFormatRef.schema.json#BillFormatRef" - }, - { - "$ref": "BillFormat.schema.json#BillFormat" - } - ] } - } } \ No newline at end of file diff --git a/Customer/BillPresentationMedia.schema.json b/Customer/BillPresentationMedia.schema.json index 14069795..b6caf7db 100644 --- a/Customer/BillPresentationMedia.schema.json +++ b/Customer/BillPresentationMedia.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillPresentationMedia.schema.json", - "title": "BillPresentationMedia", - "definitions": { - "BillPresentationMedia": { - "$id": "#BillPresentationMedia", - "description": "A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "description": { - "type": "string", - "description": "An explanatory text describing this bill presentation media" - }, - "href": { - "type": "string", - "description": "Reference of the bill presentation media" - }, - "id": { - "type": "string", - "description": "Unique identifier of the bill presentation media" - }, - "name": { - "type": "string", - "description": "A short descriptive name" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillPresentationMedia.schema.json", + "title": "BillPresentationMedia", + "definitions": { + "BillPresentationMedia": { + "$id": "#BillPresentationMedia", + "description": "A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "description": { + "type": "string", + "description": "An explanatory text describing this bill presentation media" + }, + "href": { + "type": "string", + "description": "Reference of the bill presentation media" + }, + "id": { + "type": "string", + "description": "Unique identifier of the bill presentation media" + }, + "name": { + "type": "string", + "description": "A short descriptive name" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/BillPresentationMediaRef.schema.json b/Customer/BillPresentationMediaRef.schema.json index 9a2ae302..8b4cc306 100644 --- a/Customer/BillPresentationMediaRef.schema.json +++ b/Customer/BillPresentationMediaRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillPresentationMediaRef.schema.json", - "title": "BillPresentationMediaRef", - "definitions": { - "BillPresentationMediaRef": { - "$id": "#BillPresentationMediaRef", - "description": "PresentationMedia reference. A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the bill presentation media" - }, - "id": { - "type": "string", - "description": "Unique identifier of the bill presentation media" - }, - "name": { - "type": "string", - "description": "A short descriptive name" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillPresentationMediaRef.schema.json", + "title": "BillPresentationMediaRef", + "definitions": { + "BillPresentationMediaRef": { + "$id": "#BillPresentationMediaRef", + "description": "PresentationMedia reference. A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the bill presentation media" + }, + "id": { + "type": "string", + "description": "Unique identifier of the bill presentation media" + }, + "name": { + "type": "string", + "description": "A short descriptive name" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/BillPresentationMediaRefOrValue.schema.json b/Customer/BillPresentationMediaRefOrValue.schema.json index f56afe1f..37f9ba21 100644 --- a/Customer/BillPresentationMediaRefOrValue.schema.json +++ b/Customer/BillPresentationMediaRefOrValue.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillPresentationMediaRefOrValue.schema.json", - "title": "BillPresentationMediaRefOrValue", - "definitions": { - "BillPresentationMediaRefOrValue": { - "discriminator": "isRef", - "$id": "#BillPresentationMediaRefOrValue", - "description": "An attachment by value or by reference.", - "type": "object", - "properties": { - "isRef": { - "type": "boolean", - "default": true + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillPresentationMediaRefOrValue.schema.json", + "title": "BillPresentationMediaRefOrValue", + "definitions": { + "BillPresentationMediaRefOrValue": { + "discriminator": "isRef", + "$id": "#BillPresentationMediaRefOrValue", + "description": "An attachment by value or by reference.", + "type": "object", + "properties": { + "isRef": { + "type": "boolean", + "default": true + } + }, + "required": [ + "isRef", + "role" + ], + "allOf": [ + { + "$ref": "BillPresentationMediaRef.schema.json#BillPresentationMediaRef" + }, + { + "$ref": "BillPresentationMedia.schema.json#BillPresentationMedia" + } + ] } - }, - "required": [ - "isRef", - "role" - ], - "allOf": [ - { - "$ref": "BillPresentationMediaRef.schema.json#BillPresentationMediaRef" - }, - { - "$ref": "BillPresentationMedia.schema.json#BillPresentationMedia" - } - ] } - } } \ No newline at end of file diff --git a/Customer/BillRef.schema.json b/Customer/BillRef.schema.json index c82b1fdf..76823980 100644 --- a/Customer/BillRef.schema.json +++ b/Customer/BillRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillRef.schema.json", - "title": "BillRef", - "definitions": { - "BillRef": { - "$id": "#BillRef", - "description": "Bill reference.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Unique reference of the bill." - }, - "id": { - "type": "string", - "description": "Unique identifier of the bill" - }, - "name": { - "type": "string", - "description": "Name of the bill" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillRef.schema.json", + "title": "BillRef", + "definitions": { + "BillRef": { + "$id": "#BillRef", + "description": "Bill reference.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Unique reference of the bill." + }, + "id": { + "type": "string", + "description": "Unique identifier of the bill" + }, + "name": { + "type": "string", + "description": "Name of the bill" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/BillStructure.schema.json b/Customer/BillStructure.schema.json index 4ccfac80..df2706e1 100644 --- a/Customer/BillStructure.schema.json +++ b/Customer/BillStructure.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillStructure.schema.json", - "title": "BillStructure", - "definitions": { - "BillStructure": { - "$id": "#BillStructure", - "description": "The structure of the bill for party accounts (billing or settlement).", - "type": "object", - "properties": { - "presentationMedia": { - "type": "array", - "items": { - "$ref": "BillPresentationMediaRefOrValue.schema.json#BillPresentationMediaRefOrValue" - } - }, - "format": { - "$ref": "BillFormatRefOrValue.schema.json#BillFormatRefOrValue" - }, - "cycleSpecification": { - "$ref": "BillingCycleSpecificationRefOrValue.schema.json#BillingCycleSpecificationRefOrValue" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillStructure.schema.json", + "title": "BillStructure", + "definitions": { + "BillStructure": { + "$id": "#BillStructure", + "description": "The structure of the bill for party accounts (billing or settlement).", + "type": "object", + "properties": { + "presentationMedia": { + "type": "array", + "items": { + "$ref": "BillPresentationMediaRefOrValue.schema.json#BillPresentationMediaRefOrValue" + } + }, + "format": { + "$ref": "BillFormatRefOrValue.schema.json#BillFormatRefOrValue" + }, + "cycleSpecification": { + "$ref": "BillingCycleSpecificationRefOrValue.schema.json#BillingCycleSpecificationRefOrValue" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/BillingAccount.schema.json b/Customer/BillingAccount.schema.json index 1296b6c9..f16cf127 100644 --- a/Customer/BillingAccount.schema.json +++ b/Customer/BillingAccount.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillingAccount.schema.json", - "title": "BillingAccount", - "definitions": { - "BillingAccount": { - "$id": "#BillingAccount", - "description": "A party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.", - "type": "object", - "required": [ - "name", - "relatedParty" - ], - "properties": {}, - "allOf": [ - { - "$ref": "../EngagedParty/PartyAccount.schema.json#PartyAccount" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillingAccount.schema.json", + "title": "BillingAccount", + "definitions": { + "BillingAccount": { + "$id": "#BillingAccount", + "description": "A party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.", + "type": "object", + "required": [ + "name", + "relatedParty" + ], + "properties": {}, + "allOf": [ + { + "$ref": "../EngagedParty/PartyAccount.schema.json#PartyAccount" + } + ] } - ] } - } } \ No newline at end of file diff --git a/Customer/BillingAccountRef.schema.json b/Customer/BillingAccountRef.schema.json index 6a5addf9..e169a82b 100644 --- a/Customer/BillingAccountRef.schema.json +++ b/Customer/BillingAccountRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillingAccountRef.schema.json", - "title": "BillingAccountRef", - "definitions": { - "BillingAccountRef": { - "$id": "#BillingAccountRef", - "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the billing account" - }, - "id": { - "type": "string", - "description": "Unique identifier of the billing account" - }, - "name": { - "type": "string", - "description": "Name of the billing account" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillingAccountRef.schema.json", + "title": "BillingAccountRef", + "definitions": { + "BillingAccountRef": { + "$id": "#BillingAccountRef", + "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the billing account" + }, + "id": { + "type": "string", + "description": "Unique identifier of the billing account" + }, + "name": { + "type": "string", + "description": "Name of the billing account" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/BillingCycleSpecification.schema.json b/Customer/BillingCycleSpecification.schema.json index 584cb48c..9bff8903 100644 --- a/Customer/BillingCycleSpecification.schema.json +++ b/Customer/BillingCycleSpecification.schema.json @@ -1,70 +1,70 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillingCycleSpecification.schema.json", - "title": "BillingCycleSpecification", - "definitions": { - "BillingCycleSpecification": { - "$id": "#BillingCycleSpecification", - "description": "A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "billingDateShift": { - "type": "integer", - "description": "An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period." - }, - "billingPeriod": { - "type": "string", - "description": "A billing time period. It can be recurring, for example: week, month, quarter of year, year ." - }, - "chargeDateOffset": { - "type": "integer", - "description": "An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod." - }, - "creditDateOffset": { - "type": "integer", - "description": "An offset of a date through which credits previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod." - }, - "description": { - "type": "string", - "description": "An explanation regarding this billing cycle specification" - }, - "frequency": { - "type": "string", - "description": "Frequency of the billing cycle (monthly for instance)" - }, - "href": { - "type": "string", - "description": "Reference of the billing cycle specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the billing cycle specification" - }, - "mailingDateOffset": { - "type": "integer", - "description": "An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod." - }, - "name": { - "type": "string", - "description": "A short descriptive name" - }, - "paymentDueDateOffset": { - "type": "integer", - "description": "An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the billing specification cycle is valid" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillingCycleSpecification.schema.json", + "title": "BillingCycleSpecification", + "definitions": { + "BillingCycleSpecification": { + "$id": "#BillingCycleSpecification", + "description": "A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "billingDateShift": { + "type": "integer", + "description": "An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period." + }, + "billingPeriod": { + "type": "string", + "description": "A billing time period. It can be recurring, for example: week, month, quarter of year, year ." + }, + "chargeDateOffset": { + "type": "integer", + "description": "An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod." + }, + "creditDateOffset": { + "type": "integer", + "description": "An offset of a date through which credits previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod." + }, + "description": { + "type": "string", + "description": "An explanation regarding this billing cycle specification" + }, + "frequency": { + "type": "string", + "description": "Frequency of the billing cycle (monthly for instance)" + }, + "href": { + "type": "string", + "description": "Reference of the billing cycle specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the billing cycle specification" + }, + "mailingDateOffset": { + "type": "integer", + "description": "An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod." + }, + "name": { + "type": "string", + "description": "A short descriptive name" + }, + "paymentDueDateOffset": { + "type": "integer", + "description": "An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the billing specification cycle is valid" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/BillingCycleSpecificationRef.schema.json b/Customer/BillingCycleSpecificationRef.schema.json index 676ef715..5e4fbd83 100644 --- a/Customer/BillingCycleSpecificationRef.schema.json +++ b/Customer/BillingCycleSpecificationRef.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillingCycleSpecificationRef.schema.json", - "title": "BillingCycleSpecificationRef", - "definitions": { - "BillingCycleSpecificationRef": { - "$id": "#BillingCycleSpecificationRef", - "description": "BillingCycleSpecification reference. A description of when to initiate a billing cycle and the various sub steps of a billing cycle.", - "type": "object", - "properties": { - "dateShift": { - "type": "integer", - "description": "An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period." - }, - "frequency": { - "type": "string", - "description": "Frequency of the billing cycle (monthly for instance)" - }, - "href": { - "type": "string", - "description": "Reference of the billing cycle specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the billing cycle specification" - }, - "name": { - "type": "string", - "description": "A short descriptive name" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillingCycleSpecificationRef.schema.json", + "title": "BillingCycleSpecificationRef", + "definitions": { + "BillingCycleSpecificationRef": { + "$id": "#BillingCycleSpecificationRef", + "description": "BillingCycleSpecification reference. A description of when to initiate a billing cycle and the various sub steps of a billing cycle.", + "type": "object", + "properties": { + "dateShift": { + "type": "integer", + "description": "An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period." + }, + "frequency": { + "type": "string", + "description": "Frequency of the billing cycle (monthly for instance)" + }, + "href": { + "type": "string", + "description": "Reference of the billing cycle specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the billing cycle specification" + }, + "name": { + "type": "string", + "description": "A short descriptive name" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/BillingCycleSpecificationRefOrValue.schema.json b/Customer/BillingCycleSpecificationRefOrValue.schema.json index 9157847c..76c5679b 100644 --- a/Customer/BillingCycleSpecificationRefOrValue.schema.json +++ b/Customer/BillingCycleSpecificationRefOrValue.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillingCycleSpecificationRefOrValue.schema.json", - "title": "BillingCycleSpecificationRefOrValue", - "definitions": { - "BillingCycleSpecificationRefOrValue": { - "discriminator": "isRef", - "$id": "#BillingCycleSpecificationRefOrValue", - "description": "An attachment by value or by reference.", - "type": "object", - "properties": { - "isRef": { - "type": "boolean", - "default": true + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillingCycleSpecificationRefOrValue.schema.json", + "title": "BillingCycleSpecificationRefOrValue", + "definitions": { + "BillingCycleSpecificationRefOrValue": { + "discriminator": "isRef", + "$id": "#BillingCycleSpecificationRefOrValue", + "description": "An attachment by value or by reference.", + "type": "object", + "properties": { + "isRef": { + "type": "boolean", + "default": true + } + }, + "required": [ + "isRef", + "role" + ], + "allOf": [ + { + "$ref": "BillingCycleSpecificationRef.schema.json#BillingCycleSpecificationRef" + }, + { + "$ref": "BillingCycleSpecification.schema.json#BillingCycleSpecification" + } + ] } - }, - "required": [ - "isRef", - "role" - ], - "allOf": [ - { - "$ref": "BillingCycleSpecificationRef.schema.json#BillingCycleSpecificationRef" - }, - { - "$ref": "BillingCycleSpecification.schema.json#BillingCycleSpecification" - } - ] } - } } \ No newline at end of file diff --git a/Customer/Bucket.schema.json b/Customer/Bucket.schema.json index 159c8c5c..d3197229 100644 --- a/Customer/Bucket.schema.json +++ b/Customer/Bucket.schema.json @@ -1,17 +1,17 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Bucket.schema.json", - "title": "Bucket", - "definitions": { - "Bucket": { - "$id": "#Bucket", - "description": "desc", - "allOf": [ - { - "$ref": "BucketBalance.schema.json#BucketBalance" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Bucket.schema.json", + "title": "Bucket", + "definitions": { + "Bucket": { + "$id": "#Bucket", + "description": "desc", + "allOf": [ + { + "$ref": "BucketBalance.schema.json#BucketBalance" + } + ], + "type": "object" } - ], - "type": "object" } - } } \ No newline at end of file diff --git a/Customer/BucketBalance.schema.json b/Customer/BucketBalance.schema.json index 98ca1fed..1c86d978 100644 --- a/Customer/BucketBalance.schema.json +++ b/Customer/BucketBalance.schema.json @@ -1,83 +1,83 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BucketBalance.schema.json", - "title": "BucketBalance", - "definitions": { - "BucketBalance": { - "$id": "#BucketBalance", - "description": "Represents and tracks the amount remained or owed for a certain type of service by certain customer", - "properties": { - "bucketType": { - "type": "string", - "description": "Type of prepay balance bucket (e.g.: promotion, deposit, bonus, data, voice, or any other service type)" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the balance managed by the bucket" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information for the bucket" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the bucket" - }, - "name": { - "type": "string", - "description": "Friendly name to identify the bucket" - }, - "partyAccount": { - "description": "A reference to the account that owns the bucket", - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - }, - "product": { - "type": "array", - "items": { - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "description": "A reference to the product whose consumption is managed by the bucket. This is an array to allow scenarios where a given bucket is shared between different products." - }, - "realizingResource": { - "type": "array", - "items": { - "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" - }, - "description": "A reference to the resource that realizes a product. This is an array to allow scenarios where a given bucket is shared between different resources." - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "description": "Used to provide information about any other entity with relation to the balance, for instance to define customer hierarchy for the balance (e.g.: customerId, userId, )" - }, - "remainedAmount": { - "description": "Amount remained in the bucket", - "$ref": "../Common/QuantityType.schema.json#QuantityType" - }, - "reservedAmount": { - "description": "Indicate the reserved amount on the bucket", - "$ref": "../Common/QuantityType.schema.json#QuantityType" - }, - "status": { - "type": "string", - "description": "Status for the balance (active, expired, suspended)" - }, - "validFor": { - "description": "The period for which the balance in the bucket is valid", - "$ref": "../Common/TimePeriodType.schema.json#TimePeriodType" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BucketBalance.schema.json", + "title": "BucketBalance", + "definitions": { + "BucketBalance": { + "$id": "#BucketBalance", + "description": "Represents and tracks the amount remained or owed for a certain type of service by certain customer", + "properties": { + "bucketType": { + "type": "string", + "description": "Type of prepay balance bucket (e.g.: promotion, deposit, bonus, data, voice, or any other service type)" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the balance managed by the bucket" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information for the bucket" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the bucket" + }, + "name": { + "type": "string", + "description": "Friendly name to identify the bucket" + }, + "partyAccount": { + "description": "A reference to the account that owns the bucket", + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "product": { + "type": "array", + "items": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "description": "A reference to the product whose consumption is managed by the bucket. This is an array to allow scenarios where a given bucket is shared between different products." + }, + "realizingResource": { + "type": "array", + "items": { + "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" + }, + "description": "A reference to the resource that realizes a product. This is an array to allow scenarios where a given bucket is shared between different resources." + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "Used to provide information about any other entity with relation to the balance, for instance to define customer hierarchy for the balance (e.g.: customerId, userId, )" + }, + "remainedAmount": { + "description": "Amount remained in the bucket", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "reservedAmount": { + "description": "Indicate the reserved amount on the bucket", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "status": { + "type": "string", + "description": "Status for the balance (active, expired, suspended)" + }, + "validFor": { + "description": "The period for which the balance in the bucket is valid", + "$ref": "../Common/TimePeriodType.schema.json#TimePeriodType" + } + }, + "required": [ + "id", + "href", + "bucketType", + "validFor", + "status", + "product" + ], + "type": "object" } - }, - "required": [ - "id", - "href", - "bucketType", - "validFor", - "status", - "product" - ], - "type": "object" } - } } \ No newline at end of file diff --git a/Customer/BucketBalanceRef.schema.json b/Customer/BucketBalanceRef.schema.json index d24ccb8a..3bbaf4cd 100644 --- a/Customer/BucketBalanceRef.schema.json +++ b/Customer/BucketBalanceRef.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BucketBalanceRef.schema.json", - "title": "BucketBalanceRef", - "definitions": { - "BucketBalanceRef": { - "$id": "#BucketBalanceRef", - "description": "link to the resource that holds bucket balance information", - "properties": { - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the balance information for a bucket" - }, - "id": { - "type": "string", - "description": "Unique identifier for the bucket entity" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BucketBalanceRef.schema.json", + "title": "BucketBalanceRef", + "definitions": { + "BucketBalanceRef": { + "$id": "#BucketBalanceRef", + "description": "link to the resource that holds bucket balance information", + "properties": { + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the balance information for a bucket" + }, + "id": { + "type": "string", + "description": "Unique identifier for the bucket entity" + } + }, + "required": [ + "id", + "href" + ], + "type": "object" } - }, - "required": [ - "id", - "href" - ], - "type": "object" } - } } \ No newline at end of file diff --git a/Customer/CartItem.schema.json b/Customer/CartItem.schema.json index 352e29c9..37fc74e0 100755 --- a/Customer/CartItem.schema.json +++ b/Customer/CartItem.schema.json @@ -1,77 +1,77 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartItem.schema.json", - "title": "CartItem", - "definitions": { - "CartItem": { - "$id": "#CartItem", - "description": "An identified part of the shopping cart. A shopping cart is decomposed into one or more shopping cart item. Cart item represents a product offering or bundled product offering that user wish to purchase, as well as the pricing of the product offering, reference to product in case of configured characteristic or installation address. Cart items can be related to other cart item to related bundled offerings or reference cart Items to a shipping options", - "type": "object", - "properties": { - "action": { - "$ref": "CartItemActionType.schema.json#CartItemActionType", - "description": "The action to be carried out on the Product. Can be: add, modify, delete, noChange" - }, - "id": { - "type": "string", - "description": "Identifier of the cart item (generally it is a sequence number 01, 02, 03, ...) in the shopping cart" - }, - "quantity": { - "type": "integer", - "description": "Quantity of cart items" - }, - "status": { - "$ref": "CartItemStatusType.schema.json#CartItemStatusType", - "description": "status of cart item. e.g \"active\" , \"savedForLater\"." - }, - "itemTerm": { - "type": "array", - "items": { - "$ref": "CartTerm.schema.json#CartTerm" - } - }, - "cartItem": { - "type": "array", - "items": { - "$ref": "CartItem.schema.json#CartItem" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "ItemTotalPrice": { - "type": "array", - "items": { - "$ref": "CartPrice.schema.json#CartPrice" - } - }, - "product": { - "$ref": "../Product/ProductRefOrValue.schema.json#ProductRefOrValue" - }, - "itemPrice": { - "type": "array", - "items": { - "$ref": "CartPrice.schema.json#CartPrice" - } - }, - "productOffering": { - "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "cartItemRelationship": { - "type": "array", - "items": { - "$ref": "CartItemRelationship.schema.json#CartItemRelationship" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartItem.schema.json", + "title": "CartItem", + "definitions": { + "CartItem": { + "$id": "#CartItem", + "description": "An identified part of the shopping cart. A shopping cart is decomposed into one or more shopping cart item. Cart item represents a product offering or bundled product offering that user wish to purchase, as well as the pricing of the product offering, reference to product in case of configured characteristic or installation address. Cart items can be related to other cart item to related bundled offerings or reference cart Items to a shipping options", + "type": "object", + "properties": { + "action": { + "$ref": "CartItemActionType.schema.json#CartItemActionType", + "description": "The action to be carried out on the Product. Can be: add, modify, delete, noChange" + }, + "id": { + "type": "string", + "description": "Identifier of the cart item (generally it is a sequence number 01, 02, 03, ...) in the shopping cart" + }, + "quantity": { + "type": "integer", + "description": "Quantity of cart items" + }, + "status": { + "$ref": "CartItemStatusType.schema.json#CartItemStatusType", + "description": "status of cart item. e.g \"active\" , \"savedForLater\"." + }, + "itemTerm": { + "type": "array", + "items": { + "$ref": "CartTerm.schema.json#CartTerm" + } + }, + "cartItem": { + "type": "array", + "items": { + "$ref": "CartItem.schema.json#CartItem" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "ItemTotalPrice": { + "type": "array", + "items": { + "$ref": "CartPrice.schema.json#CartPrice" + } + }, + "product": { + "$ref": "../Product/ProductRefOrValue.schema.json#ProductRefOrValue" + }, + "itemPrice": { + "type": "array", + "items": { + "$ref": "CartPrice.schema.json#CartPrice" + } + }, + "productOffering": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "cartItemRelationship": { + "type": "array", + "items": { + "$ref": "CartItemRelationship.schema.json#CartItemRelationship" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/CartItemActionType.schema.json b/Customer/CartItemActionType.schema.json index 1116b8e9..4da5e5da 100644 --- a/Customer/CartItemActionType.schema.json +++ b/Customer/CartItemActionType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartItemActionType.schema.json", - "title": "CartItemActionType", - "definitions": { - "CartItemActionType": { - "$id": "#CartItemActionType", - "description": "action to be performed on the product", - "type": "string", - "enum": [ - "add", - "modify", - "delete", - "noChange" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartItemActionType.schema.json", + "title": "CartItemActionType", + "definitions": { + "CartItemActionType": { + "$id": "#CartItemActionType", + "description": "action to be performed on the product", + "type": "string", + "enum": [ + "add", + "modify", + "delete", + "noChange" + ] + } } - } } \ No newline at end of file diff --git a/Customer/CartItemRef.schema.json b/Customer/CartItemRef.schema.json index 7d48e529..a538db9b 100644 --- a/Customer/CartItemRef.schema.json +++ b/Customer/CartItemRef.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartItemRef.schema.json", - "title": "CartItemRef", - "definitions": { - "CartItemRef": { - "$id": "#CartItemRef", - "description": "CartIIem reference. A CartItem is an identified part of the shopping cart.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the cart item" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartItemRef.schema.json", + "title": "CartItemRef", + "definitions": { + "CartItemRef": { + "$id": "#CartItemRef", + "description": "CartIIem reference. A CartItem is an identified part of the shopping cart.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the cart item" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/CartItemRelationship.schema.json b/Customer/CartItemRelationship.schema.json index 535a5b0e..463b2f4b 100644 --- a/Customer/CartItemRelationship.schema.json +++ b/Customer/CartItemRelationship.schema.json @@ -1,33 +1,33 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartItemRelationship.schema.json", - "title": "CartItemRelationship", - "definitions": { - "CartItemRelationship": { - "$id": "#CartItemRelationship", - "description": "Relationship among cart items mainly other than hierarchical relationships such as \"RelyOn\", \"DependentOn\", \"Shipping\" etc.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the referred cart item" - }, - "relationshipType": { - "type": "string", - "description": "Type of the cart item relationship" - }, - "cartItem": { - "type": "array", - "items": { - "$ref": "CartItemRef.schema.json#CartItemRef" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartItemRelationship.schema.json", + "title": "CartItemRelationship", + "definitions": { + "CartItemRelationship": { + "$id": "#CartItemRelationship", + "description": "Relationship among cart items mainly other than hierarchical relationships such as \"RelyOn\", \"DependentOn\", \"Shipping\" etc.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the referred cart item" + }, + "relationshipType": { + "type": "string", + "description": "Type of the cart item relationship" + }, + "cartItem": { + "type": "array", + "items": { + "$ref": "CartItemRef.schema.json#CartItemRef" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/CartItemStatusType.schema.json b/Customer/CartItemStatusType.schema.json index 982cc456..d13d7bdf 100644 --- a/Customer/CartItemStatusType.schema.json +++ b/Customer/CartItemStatusType.schema.json @@ -1,16 +1,16 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartItemStatusType.schema.json", - "title": "CartItemStatusType", - "definitions": { - "CartItemStatusType": { - "$id": "#CartItemStatusType", - "type": "string", - "description": "Possible values for the status of the cart item", - "enum": [ - "active", - "saveForLater" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartItemStatusType.schema.json", + "title": "CartItemStatusType", + "definitions": { + "CartItemStatusType": { + "$id": "#CartItemStatusType", + "type": "string", + "description": "Possible values for the status of the cart item", + "enum": [ + "active", + "saveForLater" + ] + } } - } } \ No newline at end of file diff --git a/Customer/CartPrice.schema.json b/Customer/CartPrice.schema.json index 0e4a6cd3..2e9b8373 100755 --- a/Customer/CartPrice.schema.json +++ b/Customer/CartPrice.schema.json @@ -1,52 +1,52 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartPrice.schema.json", - "title": "CartPrice", - "definitions": { - "CartPrice": { - "$id": "#CartPrice", - "description": "An amount, usually of money, that represents the actual price paid by the customer for this item. May represent the total price of the shopping cart or the total of the cart item depending on the relation", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail the semantics of this order item price." - }, - "name": { - "type": "string", - "description": "A short descriptive name such as \"Subscription price\"." - }, - "priceType": { - "type": "string", - "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth" - }, - "productOfferingPrice": { - "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef", - "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time." - }, - "recurringChargePeriod": { - "type": "string", - "description": "Could be month, week..." - }, - "unitOfMeasure": { - "type": "string", - "description": "Could be minutes, GB..." - }, - "price": { - "$ref": "Price.schema.json#Price" - }, - "priceAlteration": { - "type": "array", - "items": { - "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartPrice.schema.json", + "title": "CartPrice", + "definitions": { + "CartPrice": { + "$id": "#CartPrice", + "description": "An amount, usually of money, that represents the actual price paid by the customer for this item. May represent the total price of the shopping cart or the total of the cart item depending on the relation", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail the semantics of this order item price." + }, + "name": { + "type": "string", + "description": "A short descriptive name such as \"Subscription price\"." + }, + "priceType": { + "type": "string", + "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth" + }, + "productOfferingPrice": { + "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef", + "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time." + }, + "recurringChargePeriod": { + "type": "string", + "description": "Could be month, week..." + }, + "unitOfMeasure": { + "type": "string", + "description": "Could be minutes, GB..." + }, + "price": { + "$ref": "Price.schema.json#Price" + }, + "priceAlteration": { + "type": "array", + "items": { + "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/CartTerm.schema.json b/Customer/CartTerm.schema.json index 5cfb155c..e5ffe6b9 100644 --- a/Customer/CartTerm.schema.json +++ b/Customer/CartTerm.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartTerm.schema.json", - "title": "CartTerm", - "definitions": { - "CartTerm": { - "$id": "#CartTerm", - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "duration": { - "$ref": "../Common/Quantity.schema.json#Quantity" - }, - "name": { - "type": "string" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartTerm.schema.json", + "title": "CartTerm", + "definitions": { + "CartTerm": { + "$id": "#CartTerm", + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "duration": { + "$ref": "../Common/Quantity.schema.json#Quantity" + }, + "name": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/CashDetails.schema.json b/Customer/CashDetails.schema.json index 424e5ce4..2b8bec3a 100644 --- a/Customer/CashDetails.schema.json +++ b/Customer/CashDetails.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CashDetails.schema.json", - "title": "CashDetails", - "definitions": { - "CashDetails": { - "$id": "#CashDetails", - "description": "Cash has no additional data, but it could be extended to add information (e.g.: the cashier who took the payment, the person who paid, etc)", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CashDetails.schema.json", + "title": "CashDetails", + "definitions": { + "CashDetails": { + "$id": "#CashDetails", + "description": "Cash has no additional data, but it could be extended to add information (e.g.: the cashier who took the payment, the person who paid, etc)", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - ] } - } } \ No newline at end of file diff --git a/Customer/CashMethod.schema.json b/Customer/CashMethod.schema.json index 3abe7892..1b1a5e7d 100644 --- a/Customer/CashMethod.schema.json +++ b/Customer/CashMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CashMethod.schema.json", - "title": "CashMethod", - "definitions": { - "CashMethod": { - "$id": "#CashMethod", - "type": "object", - "properties": { - "details": { - "$ref": "CashDetails.schema.json#CashDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CashMethod.schema.json", + "title": "CashMethod", + "definitions": { + "CashMethod": { + "$id": "#CashMethod", + "type": "object", + "properties": { + "details": { + "$ref": "CashDetails.schema.json#CashDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/CheckDetails.schema.json b/Customer/CheckDetails.schema.json index c92071d1..926f9fd1 100644 --- a/Customer/CheckDetails.schema.json +++ b/Customer/CheckDetails.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CheckDetails.schema.json", - "title": "CheckDetails", - "definitions": { - "CheckDetails": { - "$id": "#CheckDetails", - "description": "Detailed information of a check", - "type": "object", - "properties": { - "bank": { - "type": "string", - "description": "Bank performing the payment of the check" - }, - "code": { - "type": "string", - "description": "Unique identifier of the check" - }, - "date": { - "type": "string", - "format": "date-time", - "description": "Date when the check was signed" - }, - "drawer": { - "type": "string", - "description": "Person or entity writing the check" - }, - "payee": { - "type": "string", - "description": "Person or entity the check is addressed to" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CheckDetails.schema.json", + "title": "CheckDetails", + "definitions": { + "CheckDetails": { + "$id": "#CheckDetails", + "description": "Detailed information of a check", + "type": "object", + "properties": { + "bank": { + "type": "string", + "description": "Bank performing the payment of the check" + }, + "code": { + "type": "string", + "description": "Unique identifier of the check" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "Date when the check was signed" + }, + "drawer": { + "type": "string", + "description": "Person or entity writing the check" + }, + "payee": { + "type": "string", + "description": "Person or entity the check is addressed to" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/CheckMethod.schema.json b/Customer/CheckMethod.schema.json index 876852cd..93285f55 100644 --- a/Customer/CheckMethod.schema.json +++ b/Customer/CheckMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CheckMethod.schema.json", - "title": "CheckMethod", - "definitions": { - "CheckMethod": { - "$id": "#CheckMethod", - "type": "object", - "properties": { - "details": { - "$ref": "CheckDetails.schema.json#CheckDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CheckMethod.schema.json", + "title": "CheckMethod", + "definitions": { + "CheckMethod": { + "$id": "#CheckMethod", + "type": "object", + "properties": { + "details": { + "$ref": "CheckDetails.schema.json#CheckDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/CreditProfile.schema.json b/Customer/CreditProfile.schema.json index 2bfb3724..572f9061 100644 --- a/Customer/CreditProfile.schema.json +++ b/Customer/CreditProfile.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CreditProfile.schema.json", - "title": "CreditProfile", - "definitions": { - "CreditProfile": { - "$id": "#CreditProfile", - "description": "Credit profile for the party (containing credit scoring, ...). By default only the current credit profile is retrieved. It can be used as a list to give the party credit profiles history, the first one in the list will be the current one.", - "type": "object", - "properties": { - "creditProfileDate": { - "type": "string", - "format": "date-time", - "description": "The date the profile was established" - }, - "creditRiskRating": { - "type": "integer", - "description": "This is an integer whose value is used to rate the risk" - }, - "creditScore": { - "type": "integer", - "description": "A measure of a person or organizations creditworthiness calculated on the basis of a combination of factors such as their income and credit history" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the profile is valid" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CreditProfile.schema.json", + "title": "CreditProfile", + "definitions": { + "CreditProfile": { + "$id": "#CreditProfile", + "description": "Credit profile for the party (containing credit scoring, ...). By default only the current credit profile is retrieved. It can be used as a list to give the party credit profiles history, the first one in the list will be the current one.", + "type": "object", + "properties": { + "creditProfileDate": { + "type": "string", + "format": "date-time", + "description": "The date the profile was established" + }, + "creditRiskRating": { + "type": "integer", + "description": "This is an integer whose value is used to rate the risk" + }, + "creditScore": { + "type": "integer", + "description": "A measure of a person or organizations creditworthiness calculated on the basis of a combination of factors such as their income and credit history" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the profile is valid" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/Customer.schema.json b/Customer/Customer.schema.json index 61c99d96..411c9994 100644 --- a/Customer/Customer.schema.json +++ b/Customer/Customer.schema.json @@ -1,91 +1,91 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Customer.schema.json", - "title": "Customer", - "definitions": { - "Customer": { - "$id": "#Customer", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Url used to reference the customer." - }, - "id": { - "type": "string", - "description": "Unique identifier for Customers" - }, - "name": { - "type": "string", - "description": "A word, term, or phrase by which the Customer is known and distinguished from other Customers." - }, - "status": { - "type": "string", - "description": "Used to track the lifecycle status of the customer." - }, - "statusReason": { - "type": "string", - "description": "A string providing an explanation on the value of the status lifecycle. For instance if the status is Rejected, statusReason will provide the reason for rejection." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The time period that the Customer is valid for." - }, - "engagedParty": { - "$ref": "../EngagedParty/PartyRef.schema.json#PartyRef" - }, - "roleType": { - "$ref": "../EngagedParty/RoleTypeRef.schema.json#RoleTypeRef" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } - }, - "paymentMethod": { - "type": "array", - "items": { - "$ref": "PaymentMethodRef.schema.json#PaymentMethodRef" - } - }, - "contactMedium": { - "type": "array", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - }, - "description": "Describes the characteristic of a customer." - }, - "creditProfile": { - "type": "array", - "items": { - "$ref": "CreditProfile.schema.json#CreditProfile" - } - }, - "agreement": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Customer.schema.json", + "title": "Customer", + "definitions": { + "Customer": { + "$id": "#Customer", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Url used to reference the customer." + }, + "id": { + "type": "string", + "description": "Unique identifier for Customers" + }, + "name": { + "type": "string", + "description": "A word, term, or phrase by which the Customer is known and distinguished from other Customers." + }, + "status": { + "type": "string", + "description": "Used to track the lifecycle status of the customer." + }, + "statusReason": { + "type": "string", + "description": "A string providing an explanation on the value of the status lifecycle. For instance if the status is Rejected, statusReason will provide the reason for rejection." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The time period that the Customer is valid for." + }, + "engagedParty": { + "$ref": "../EngagedParty/PartyRef.schema.json#PartyRef" + }, + "roleType": { + "$ref": "../EngagedParty/RoleTypeRef.schema.json#RoleTypeRef" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } + }, + "paymentMethod": { + "type": "array", + "items": { + "$ref": "PaymentMethodRef.schema.json#PaymentMethodRef" + } + }, + "contactMedium": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + }, + "description": "Describes the characteristic of a customer." + }, + "creditProfile": { + "type": "array", + "items": { + "$ref": "CreditProfile.schema.json#CreditProfile" + } + }, + "agreement": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/CustomerBill.schema.json b/Customer/CustomerBill.schema.json index 6558ebed..f641f252 100644 --- a/Customer/CustomerBill.schema.json +++ b/Customer/CustomerBill.schema.json @@ -1,117 +1,117 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CustomerBill.schema.json", - "title": "CustomerBill", - "definitions": { - "CustomerBill": { - "$id": "#CustomerBill", - "type": "object", - "properties": { - "amountDue": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Amount due for this bill expressed in the given currency" - }, - "billDate": { - "type": "string", - "format": "date-time", - "description": "Bill date" - }, - "billingPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Billing period of the bill (used for onCycle bill only)" - }, - "billNo": { - "type": "string", - "description": "Bill reference known by the customer or the party and displayed on the bill. Could be different from the id." - }, - "category": { - "type": "string", - "description": "Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note" - }, - "href": { - "type": "string", - "description": "Bill unique reference" - }, - "id": { - "type": "string", - "description": "Bill unique identifier" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date of bill last update" - }, - "nextBillDate": { - "type": "string", - "format": "date-time", - "description": "Approximate date of the next bill production given for information (only used for onCycle bill)" - }, - "paymentDueDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the amount due should have been paid" - }, - "remainingAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Remaining amount to be paid for this bill expressed in the given currency" - }, - "runType": { - "type": "string", - "description": "onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close)" - }, - "state": { - "type": "string", - "description": "State that a bill could take during its lifecycle : New, Validated, On Hold, Sent, Partially paid or Settled" - }, - "taxExcludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Total tax excluded amount expressed in the given currency" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Total tax included amount expressed in the given" - }, - "billDocument": { - "type": "array", - "items": { - "$ref": "../Common/FileDocument.schema.json#FileDocument" - }, - "description": "Document(s) associated to the bill" - }, - "paymentItem": { - "type": "array", - "items": { - "$ref": "PaymentItem.schema.json#PaymentItem" - }, - "description": "Payment items already lettered on this bill." - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef" - }, - "taxItem": { - "type": "array", - "items": { - "$ref": "TaxItem.schema.json#TaxItem" - } - }, - "paymentMethod": { - "$ref": "PaymentMethodRef.schema.json#PaymentMethodRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "financialAccount": { - "$ref": "../EngagedParty/FinancialAccountRef.schema.json#FinancialAccountRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CustomerBill.schema.json", + "title": "CustomerBill", + "definitions": { + "CustomerBill": { + "$id": "#CustomerBill", + "type": "object", + "properties": { + "amountDue": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Amount due for this bill expressed in the given currency" + }, + "billDate": { + "type": "string", + "format": "date-time", + "description": "Bill date" + }, + "billingPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Billing period of the bill (used for onCycle bill only)" + }, + "billNo": { + "type": "string", + "description": "Bill reference known by the customer or the party and displayed on the bill. Could be different from the id." + }, + "category": { + "type": "string", + "description": "Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note" + }, + "href": { + "type": "string", + "description": "Bill unique reference" + }, + "id": { + "type": "string", + "description": "Bill unique identifier" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date of bill last update" + }, + "nextBillDate": { + "type": "string", + "format": "date-time", + "description": "Approximate date of the next bill production given for information (only used for onCycle bill)" + }, + "paymentDueDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the amount due should have been paid" + }, + "remainingAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Remaining amount to be paid for this bill expressed in the given currency" + }, + "runType": { + "type": "string", + "description": "onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close)" + }, + "state": { + "type": "string", + "description": "State that a bill could take during its lifecycle : New, Validated, On Hold, Sent, Partially paid or Settled" + }, + "taxExcludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Total tax excluded amount expressed in the given currency" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Total tax included amount expressed in the given" + }, + "billDocument": { + "type": "array", + "items": { + "$ref": "../Common/FileDocument.schema.json#FileDocument" + }, + "description": "Document(s) associated to the bill" + }, + "paymentItem": { + "type": "array", + "items": { + "$ref": "PaymentItem.schema.json#PaymentItem" + }, + "description": "Payment items already lettered on this bill." + }, + "billingAccount": { + "$ref": "BillingAccountRef.schema.json#BillingAccountRef" + }, + "taxItem": { + "type": "array", + "items": { + "$ref": "TaxItem.schema.json#TaxItem" + } + }, + "paymentMethod": { + "$ref": "PaymentMethodRef.schema.json#PaymentMethodRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "financialAccount": { + "$ref": "../EngagedParty/FinancialAccountRef.schema.json#FinancialAccountRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/DigitalWalletDetails.schema.json b/Customer/DigitalWalletDetails.schema.json index 62de914d..8abe1eb4 100644 --- a/Customer/DigitalWalletDetails.schema.json +++ b/Customer/DigitalWalletDetails.schema.json @@ -1,32 +1,32 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DigitalWalletDetails.schema.json", - "title": "DigitalWalletDetails", - "definitions": { - "DigitalWalletDetails": { - "$id": "#DigitalWalletDetails", - "description": "Detailed information of a check", - "type": "object", - "properties": { - "service": { - "type": "string", - "description": "Organization, platform or currency backing the wallet (e.g.: PayPal, Yandex, BitCoin...)" - }, - "walletId": { - "type": "string", - "description": "account identifier in that service" - }, - "walletUrl": { - "type": "string", - "format": "uri", - "description": "URI pointing at the digital wallet (e.g.: https://paypal.me/johndoe)" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DigitalWalletDetails.schema.json", + "title": "DigitalWalletDetails", + "definitions": { + "DigitalWalletDetails": { + "$id": "#DigitalWalletDetails", + "description": "Detailed information of a check", + "type": "object", + "properties": { + "service": { + "type": "string", + "description": "Organization, platform or currency backing the wallet (e.g.: PayPal, Yandex, BitCoin...)" + }, + "walletId": { + "type": "string", + "description": "account identifier in that service" + }, + "walletUrl": { + "type": "string", + "format": "uri", + "description": "URI pointing at the digital wallet (e.g.: https://paypal.me/johndoe)" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/DigitalWalletMethod.schema.json b/Customer/DigitalWalletMethod.schema.json index 56be96d8..bfe5f6af 100644 --- a/Customer/DigitalWalletMethod.schema.json +++ b/Customer/DigitalWalletMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DigitalWalletMethod.schema.json", - "title": "DigitalWalletMethod", - "definitions": { - "DigitalWalletMethod": { - "$id": "#DigitalWalletMethod", - "type": "object", - "properties": { - "details": { - "$ref": "DigitalWalletDetails.schema.json#DigitalWalletDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DigitalWalletMethod.schema.json", + "title": "DigitalWalletMethod", + "definitions": { + "DigitalWalletMethod": { + "$id": "#DigitalWalletMethod", + "type": "object", + "properties": { + "details": { + "$ref": "DigitalWalletDetails.schema.json#DigitalWalletDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/Disability.schema.json b/Customer/Disability.schema.json index 08d65dc7..fdb6f269 100644 --- a/Customer/Disability.schema.json +++ b/Customer/Disability.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Disability.schema.json", - "title": "Disability", - "definitions": { - "Disability": { - "$id": "#Disability", - "type": "object", - "description": "Lack or inadequate strength or ability.", - "properties": { - "disabilityCode": { - "type": "string", - "description": "Code of the disability" - }, - "disabilityName": { - "type": "string", - "description": "Name of the disability" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Disability.schema.json", + "title": "Disability", + "definitions": { + "Disability": { + "$id": "#Disability", + "type": "object", + "description": "Lack or inadequate strength or ability.", + "properties": { + "disabilityCode": { + "type": "string", + "description": "Code of the disability" + }, + "disabilityName": { + "type": "string", + "description": "Name of the disability" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/OrderItem.schema.json b/Customer/OrderItem.schema.json index b6e26d2b..0544e252 100644 --- a/Customer/OrderItem.schema.json +++ b/Customer/OrderItem.schema.json @@ -1,89 +1,89 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderItem.schema.json", - "title": "OrderItem", - "definitions": { - "OrderItem": { - "$id": "#OrderItem", - "description": "An identified part of the order. A product order is decomposed into one or more order items.", - "type": "object", - "properties": { - "action": { - "type": "string", - "description": "Can be \"add\" / \"modify\" / \"no_change\"/ \"delete\"" - }, - "id": { - "type": "string", - "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" - }, - "quantity": { - "type": "integer", - "description": "Quantity ordered" - }, - "state": { - "type": "string", - "description": "State of the order item : described in the state machine diagram" - }, - "appointment": { - "$ref": "AppointmentRef.schema.json#AppointmentRef" - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef" - }, - "itemPrice": { - "type": "array", - "items": { - "$ref": "OrderPrice.schema.json#OrderPrice" - } - }, - "orderItem": { - "type": "array", - "items": { - "$ref": "OrderItem.schema.json#OrderItem" - } - }, - "orderItemRelationship": { - "type": "array", - "items": { - "$ref": "OrderItemRelationship.schema.json#OrderItemRelationship" - } - }, - "itemTotalPrice": { - "type": "array", - "items": { - "$ref": "OrderPrice.schema.json#OrderPrice" - } - }, - "payment": { - "type": "array", - "items": { - "$ref": "PaymentRef.schema.json#PaymentRef" - } - }, - "productOffering": { - "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "product": { - "$ref": "../Product/Product.schema.json#Product" - }, - "qualification": { - "type": "array", - "items": { - "$ref": "../Common/QualificationRef.schema.json#QualificationRef" - } - }, - "itemTerm": { - "type": "array", - "items": { - "$ref": "OrderTerm.schema.json#OrderTerm" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderItem.schema.json", + "title": "OrderItem", + "definitions": { + "OrderItem": { + "$id": "#OrderItem", + "description": "An identified part of the order. A product order is decomposed into one or more order items.", + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "Can be \"add\" / \"modify\" / \"no_change\"/ \"delete\"" + }, + "id": { + "type": "string", + "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" + }, + "quantity": { + "type": "integer", + "description": "Quantity ordered" + }, + "state": { + "type": "string", + "description": "State of the order item : described in the state machine diagram" + }, + "appointment": { + "$ref": "AppointmentRef.schema.json#AppointmentRef" + }, + "billingAccount": { + "$ref": "BillingAccountRef.schema.json#BillingAccountRef" + }, + "itemPrice": { + "type": "array", + "items": { + "$ref": "OrderPrice.schema.json#OrderPrice" + } + }, + "orderItem": { + "type": "array", + "items": { + "$ref": "OrderItem.schema.json#OrderItem" + } + }, + "orderItemRelationship": { + "type": "array", + "items": { + "$ref": "OrderItemRelationship.schema.json#OrderItemRelationship" + } + }, + "itemTotalPrice": { + "type": "array", + "items": { + "$ref": "OrderPrice.schema.json#OrderPrice" + } + }, + "payment": { + "type": "array", + "items": { + "$ref": "PaymentRef.schema.json#PaymentRef" + } + }, + "productOffering": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "product": { + "$ref": "../Product/Product.schema.json#Product" + }, + "qualification": { + "type": "array", + "items": { + "$ref": "../Common/QualificationRef.schema.json#QualificationRef" + } + }, + "itemTerm": { + "type": "array", + "items": { + "$ref": "OrderTerm.schema.json#OrderTerm" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/OrderItemActionType.schema.json b/Customer/OrderItemActionType.schema.json index 8c41997d..7a8cfd87 100644 --- a/Customer/OrderItemActionType.schema.json +++ b/Customer/OrderItemActionType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderItemActionType.schema.json", - "title": "OrderItemActionType", - "definitions": { - "OrderItemActionType": { - "$id": "#OrderItemActionType", - "description": "action to be performed on the product", - "type": "string", - "enum": [ - "add", - "modify", - "delete", - "noChange" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderItemActionType.schema.json", + "title": "OrderItemActionType", + "definitions": { + "OrderItemActionType": { + "$id": "#OrderItemActionType", + "description": "action to be performed on the product", + "type": "string", + "enum": [ + "add", + "modify", + "delete", + "noChange" + ] + } } - } } \ No newline at end of file diff --git a/Customer/OrderItemPrice.schema.json b/Customer/OrderItemPrice.schema.json index 0408bc16..7c0aaf0e 100644 --- a/Customer/OrderItemPrice.schema.json +++ b/Customer/OrderItemPrice.schema.json @@ -1,58 +1,58 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderItemPrice.schema.json", - "title": "OrderItemPrice", - "definitions": { - "OrderItemPrice": { - "$id": "#OrderItemPrice", - "description": "An amount, usually of money, that represents the actual price paid by the Customer for this item or this order", - "type": "object", - "required": [ - "priceType", - "price" - ], - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail the semantics of this order item price." - }, - "name": { - "type": "string", - "description": "Name of the order item price" - }, - "productOfferingPrice": { - "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" - }, - "priceType": { - "type": "string", - "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth" - }, - "recurringChargePeriod": { - "type": "string", - "description": "Could be month, week..." - }, - "unitOfMeasure": { - "type": "string", - "description": "Could be minutes, GB..." - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef" - }, - "price": { - "$ref": "Price.schema.json#Price" - }, - "priceAlteration": { - "type": "array", - "items": { - "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderItemPrice.schema.json", + "title": "OrderItemPrice", + "definitions": { + "OrderItemPrice": { + "$id": "#OrderItemPrice", + "description": "An amount, usually of money, that represents the actual price paid by the Customer for this item or this order", + "type": "object", + "required": [ + "priceType", + "price" + ], + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail the semantics of this order item price." + }, + "name": { + "type": "string", + "description": "Name of the order item price" + }, + "productOfferingPrice": { + "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" + }, + "priceType": { + "type": "string", + "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth" + }, + "recurringChargePeriod": { + "type": "string", + "description": "Could be month, week..." + }, + "unitOfMeasure": { + "type": "string", + "description": "Could be minutes, GB..." + }, + "billingAccount": { + "$ref": "BillingAccountRef.schema.json#BillingAccountRef" + }, + "price": { + "$ref": "Price.schema.json#Price" + }, + "priceAlteration": { + "type": "array", + "items": { + "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/OrderItemRelationship.schema.json b/Customer/OrderItemRelationship.schema.json index eef200bd..b9fcd508 100644 --- a/Customer/OrderItemRelationship.schema.json +++ b/Customer/OrderItemRelationship.schema.json @@ -1,25 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderItemRelationship.schema.json", - "title": "OrderItemRelationship", - "definitions": { - "OrderItemRelationship": { - "$id": "#OrderItemRelationship", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "relationshipType": { - "type": "string", - "description": "The type of order item relationship" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderItemRelationship.schema.json", + "title": "OrderItemRelationship", + "definitions": { + "OrderItemRelationship": { + "$id": "#OrderItemRelationship", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "relationshipType": { + "type": "string", + "description": "The type of order item relationship" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/OrderPrice.schema.json b/Customer/OrderPrice.schema.json index 374a3d68..e93b6b53 100644 --- a/Customer/OrderPrice.schema.json +++ b/Customer/OrderPrice.schema.json @@ -1,58 +1,58 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderPrice.schema.json", - "title": "OrderPrice", - "definitions": { - "OrderPrice": { - "$id": "#OrderPrice", - "description": "An amount, usually of money, that represents the actual price paid by the Customer for this item or this order", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail the semantics of this order item price." - }, - "name": { - "type": "string", - "description": "A short descriptive name such as \"Subscription price\"." - }, - "productOfferingPrice": { - "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef", - "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time." - }, - "priceType": { - "type": "string", - "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth" - }, - "recurringChargePeriod": { - "type": "string", - "description": "Could be month, week..." - }, - "unitOfMeasure": { - "type": "string", - "description": "Could be minutes, GB..." - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef", - "description": "A reference to a billing account used for paid the order price charge" - }, - "price": { - "$ref": "Price.schema.json#Price", - "description": "a structure used to define price amount" - }, - "priceAlteration": { - "type": "array", - "description": "a strucuture used to describe a price alteration", - "items": { - "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderPrice.schema.json", + "title": "OrderPrice", + "definitions": { + "OrderPrice": { + "$id": "#OrderPrice", + "description": "An amount, usually of money, that represents the actual price paid by the Customer for this item or this order", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail the semantics of this order item price." + }, + "name": { + "type": "string", + "description": "A short descriptive name such as \"Subscription price\"." + }, + "productOfferingPrice": { + "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef", + "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time." + }, + "priceType": { + "type": "string", + "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth" + }, + "recurringChargePeriod": { + "type": "string", + "description": "Could be month, week..." + }, + "unitOfMeasure": { + "type": "string", + "description": "Could be minutes, GB..." + }, + "billingAccount": { + "$ref": "BillingAccountRef.schema.json#BillingAccountRef", + "description": "A reference to a billing account used for paid the order price charge" + }, + "price": { + "$ref": "Price.schema.json#Price", + "description": "a structure used to define price amount" + }, + "priceAlteration": { + "type": "array", + "description": "a strucuture used to describe a price alteration", + "items": { + "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/OrderRelationship.schema.json b/Customer/OrderRelationship.schema.json index 190d8eec..a192c04d 100644 --- a/Customer/OrderRelationship.schema.json +++ b/Customer/OrderRelationship.schema.json @@ -1,28 +1,28 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderRelationship.schema.json", - "title": "OrderRelationship", - "definitions": { - "OrderRelationship": { - "$id": "#OrderRelationship", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "id": { - "type": "string" - }, - "relationshipType": { - "type": "string", - "description": "The type of order relationship" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderRelationship.schema.json", + "title": "OrderRelationship", + "definitions": { + "OrderRelationship": { + "$id": "#OrderRelationship", + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "id": { + "type": "string" + }, + "relationshipType": { + "type": "string", + "description": "The type of order relationship" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/OrderTerm.schema.json b/Customer/OrderTerm.schema.json index 31804b0f..d4a69ec9 100644 --- a/Customer/OrderTerm.schema.json +++ b/Customer/OrderTerm.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderTerm.schema.json", - "title": "OrderTerm", - "definitions": { - "OrderTerm": { - "$id": "#OrderTerm", - "description": "Description of a productTerm linked to this orderItem. This represent a commitment with a duration", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the productOrderTerm" - }, - "duration": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "Duration of the productOrderTerm" - }, - "name": { - "type": "string", - "description": "Name of the productOrderTerm" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderTerm.schema.json", + "title": "OrderTerm", + "definitions": { + "OrderTerm": { + "$id": "#OrderTerm", + "description": "Description of a productTerm linked to this orderItem. This represent a commitment with a duration", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the productOrderTerm" + }, + "duration": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "Duration of the productOrderTerm" + }, + "name": { + "type": "string", + "description": "Name of the productOrderTerm" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/PaymentItem.schema.json b/Customer/PaymentItem.schema.json index 1b6da182..b124d15c 100644 --- a/Customer/PaymentItem.schema.json +++ b/Customer/PaymentItem.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PaymentItem.schema.json", - "title": "PaymentItem", - "definitions": { - "PaymentItem": { - "$id": "#PaymentItem", - "description": "The paymentItem is the result of lettering process. It enables to assign automatically or manually part of incoming payment amount to a bill", - "type": "object", - "properties": { - "appliedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Part of a payment amount lettered to the customer bill" - }, - "payment": { - "$ref": "PaymentRef.schema.json#PaymentRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PaymentItem.schema.json", + "title": "PaymentItem", + "definitions": { + "PaymentItem": { + "$id": "#PaymentItem", + "description": "The paymentItem is the result of lettering process. It enables to assign automatically or manually part of incoming payment amount to a bill", + "type": "object", + "properties": { + "appliedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Part of a payment amount lettered to the customer bill" + }, + "payment": { + "$ref": "PaymentRef.schema.json#PaymentRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/PaymentMethod.schema.json b/Customer/PaymentMethod.schema.json index 18a21ad7..389cda97 100644 --- a/Customer/PaymentMethod.schema.json +++ b/Customer/PaymentMethod.schema.json @@ -1,59 +1,59 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PaymentMethod.schema.json", - "title": "PaymentMethod", - "definitions": { - "PaymentMethod": { - "$id": "#PaymentMethod", - "description": "Defines a specific method of payment (e.g. direct debit with all details associated)", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PaymentMethod.schema.json", + "title": "PaymentMethod", + "definitions": { + "PaymentMethod": { + "$id": "#PaymentMethod", + "description": "Defines a specific method of payment (e.g. direct debit with all details associated)", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/PaymentMethodRef.schema.json b/Customer/PaymentMethodRef.schema.json index 197aa98f..25ce15bd 100644 --- a/Customer/PaymentMethodRef.schema.json +++ b/Customer/PaymentMethodRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PaymentMethodRef.schema.json", - "title": "PaymentMethodRef", - "definitions": { - "PaymentMethodRef": { - "$id": "#PaymentMethodRef", - "description": "PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the payment mean" - }, - "id": { - "type": "string", - "description": "Unique identifier of the payment mean" - }, - "name": { - "type": "string", - "description": "Name of the payment mean" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PaymentMethodRef.schema.json", + "title": "PaymentMethodRef", + "definitions": { + "PaymentMethodRef": { + "$id": "#PaymentMethodRef", + "description": "PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the payment mean" + }, + "id": { + "type": "string", + "description": "Unique identifier of the payment mean" + }, + "name": { + "type": "string", + "description": "Name of the payment mean" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/PaymentMethodRefOrValue.schema.json b/Customer/PaymentMethodRefOrValue.schema.json index 26d0cd24..6d208a70 100644 --- a/Customer/PaymentMethodRefOrValue.schema.json +++ b/Customer/PaymentMethodRefOrValue.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PaymentMethodRefOrValue.schema.json", - "title": "PaymentMethodRefOrValue", - "definitions": { - "PaymentMethodRefOrValue": { - "$id": "#PaymentMethodRefOrValue", - "description": "link to the resource that holds information about the payment mean used to complete the operation", - "properties": { - "details": { - "description": "The list of parameters depends on the type of payment method", - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the channel information" - }, - "id": { - "type": "string", - "description": "Unique identifier for the channel entity" - }, - "name": { - "type": "string", - "description": "Name of the channel" - }, - "type": { - "type": "string", - "description": "Type of payment method (bankcard, voucher, �)" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PaymentMethodRefOrValue.schema.json", + "title": "PaymentMethodRefOrValue", + "definitions": { + "PaymentMethodRefOrValue": { + "$id": "#PaymentMethodRefOrValue", + "description": "link to the resource that holds information about the payment mean used to complete the operation", + "properties": { + "details": { + "description": "The list of parameters depends on the type of payment method", + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the channel information" + }, + "id": { + "type": "string", + "description": "Unique identifier for the channel entity" + }, + "name": { + "type": "string", + "description": "Name of the channel" + }, + "type": { + "type": "string", + "description": "Type of payment method (bankcard, voucher, �)" + } + }, + "required": [ + "id", + "href" + ], + "type": "object" } - }, - "required": [ - "id", - "href" - ], - "type": "object" } - } } \ No newline at end of file diff --git a/Customer/PaymentPlan.schema.json b/Customer/PaymentPlan.schema.json index 8dd1a313..afb8bff0 100644 --- a/Customer/PaymentPlan.schema.json +++ b/Customer/PaymentPlan.schema.json @@ -1,50 +1,50 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PaymentPlan.schema.json", - "title": "PaymentPlan", - "definitions": { - "PaymentPlan": { - "$id": "#PaymentPlan", - "description": "Defines a plan for payment (when a party wants to spread his payments)", - "type": "object", - "properties": { - "numberOfPayments": { - "type": "integer", - "description": "Number of payments used to spread the global payment" - }, - "paymentFrequency": { - "type": "string", - "description": "Frequency of the payments, such as monthly and bimonthly" - }, - "priority": { - "type": "integer", - "description": "Priority of the payment plan" - }, - "status": { - "type": "string", - "description": "Status of the payment plan (effective, ineffective)" - }, - "totalAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Amount paid" - }, - "planType": { - "type": "string", - "description": "Type of payment plan" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Validity period of the payment plan" - }, - "paymentMethod": { - "$ref": "PaymentMethodRef.schema.json#PaymentMethodRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PaymentPlan.schema.json", + "title": "PaymentPlan", + "definitions": { + "PaymentPlan": { + "$id": "#PaymentPlan", + "description": "Defines a plan for payment (when a party wants to spread his payments)", + "type": "object", + "properties": { + "numberOfPayments": { + "type": "integer", + "description": "Number of payments used to spread the global payment" + }, + "paymentFrequency": { + "type": "string", + "description": "Frequency of the payments, such as monthly and bimonthly" + }, + "priority": { + "type": "integer", + "description": "Priority of the payment plan" + }, + "status": { + "type": "string", + "description": "Status of the payment plan (effective, ineffective)" + }, + "totalAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Amount paid" + }, + "planType": { + "type": "string", + "description": "Type of payment plan" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Validity period of the payment plan" + }, + "paymentMethod": { + "$ref": "PaymentMethodRef.schema.json#PaymentMethodRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/PaymentRef.schema.json b/Customer/PaymentRef.schema.json index db37a1c4..fadbd825 100644 --- a/Customer/PaymentRef.schema.json +++ b/Customer/PaymentRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PaymentRef.schema.json", - "title": "PaymentRef", - "definitions": { - "PaymentRef": { - "$id": "#PaymentRef", - "type": "object", - "description": "If an immediate payment has been done at the product order submission, the payment information are captured and stored (as a reference) in the order.", - "properties": { - "name": { - "type": "string", - "description": "A name for the payment" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PaymentRef.schema.json", + "title": "PaymentRef", + "definitions": { + "PaymentRef": { + "$id": "#PaymentRef", + "type": "object", + "description": "If an immediate payment has been done at the product order submission, the payment information are captured and stored (as a reference) in the order.", + "properties": { + "name": { + "type": "string", + "description": "A name for the payment" + } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] } - } } \ No newline at end of file diff --git a/Customer/Price.schema.json b/Customer/Price.schema.json index a77c2312..bc7a301c 100644 --- a/Customer/Price.schema.json +++ b/Customer/Price.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Price.schema.json", - "title": "Price", - "definitions": { - "Price": { - "$id": "#Price", - "description": "Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.", - "type": "object", - "properties": { - "dutyFreeAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "All taxes excluded amount (expressed in the given currency)" - }, - "percentage": { - "type": "number", - "format": "float", - "description": "Percentage to apply for ProdOfferPriceAlteration" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "All taxes included amount (expressed in the given currency)" - }, - "taxRate": { - "type": "number", - "format": "float", - "description": "Tax rate" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Price.schema.json", + "title": "Price", + "definitions": { + "Price": { + "$id": "#Price", + "description": "Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.", + "type": "object", + "properties": { + "dutyFreeAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "All taxes excluded amount (expressed in the given currency)" + }, + "percentage": { + "type": "number", + "format": "float", + "description": "Percentage to apply for ProdOfferPriceAlteration" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "All taxes included amount (expressed in the given currency)" + }, + "taxRate": { + "type": "number", + "format": "float", + "description": "Tax rate" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/ProductOrder.schema.json b/Customer/ProductOrder.schema.json index eb556d7e..5b4e6031 100644 --- a/Customer/ProductOrder.schema.json +++ b/Customer/ProductOrder.schema.json @@ -1,147 +1,147 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOrder.schema.json", - "title": "ProductOrder", - "definitions": { - "ProductOrder": { - "$id": "#ProductOrder", - "type": "object", - "required": [ - "productOrderItem" - ], - "description": "A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa,", - "properties": { - "agreement": { - "type": "array", - "description": "A reference to an agreement defined in the context of the product order", - "items": { - "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" - } - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef" - }, - "cancellationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order is cancelled. This is used when order is cancelled. " - }, - "cancellationReason": { - "type": "string", - "description": "Reason why the order is cancelled. This is used when order is cancelled. " - }, - "category": { - "type": "string", - "description": "Used to categorize the order from a business perspective that can be useful for the OM system (e.g. \"enterprise\", \"residential\", ...)" - }, - "channel": { - "type": "array", - "items": { - "$ref": "../Common/RelatedChannel.schema.json#RelatedChannel" - } - }, - "completionDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order was completed" - }, - "description": { - "type": "string", - "description": "Description of the product order" - }, - "expectedCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Expected delivery date amended by the provider" - }, - "externalId": { - "type": "string", - "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the order" - }, - "id": { - "type": "string", - "description": "ID created on repository side (OM system)" - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "notificationContact": { - "type": "string", - "description": "Contact attached to the order to send back information regarding this order" - }, - "orderDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order was created" - }, - "orderTotalPrice": { - "type": "array", - "items": { - "$ref": "OrderPrice.schema.json#OrderPrice" - } - }, - "payment": { - "type": "array", - "items": { - "$ref": "PaymentRef.schema.json#PaymentRef" - } - }, - "priority": { - "type": "string", - "description": "A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)" - }, - "productOfferingQualification": { - "type": "array", - "items": { - "$ref": "../Product/ProductOfferingQualificationRef.schema.json#ProductOfferingQualificationRef" - } - }, - "quote": { - "type": "array", - "items": { - "$ref": "QuoteRef.schema.json#QuoteRef" - } - }, - "productOrderItem": { - "type": "array", - "items": { - "$ref": "ProductOrderItem.schema.json#ProductOrderItem" - }, - "minItems": 1 - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "requestedCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Requested delivery date from the requestor perspective" - }, - "requestedStartDate": { - "type": "string", - "format": "date-time", - "description": "Order fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow seller to begin to operationally begin the fulfillment before a date. " - }, - "state": { - "$ref": "ProductOrderStateType.schema.json#ProductOrderStateType", - "description": "Tracks the lifecycle status of the product order, such as Acknowledged, Rejected, InProgress, Pending and so on." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOrder.schema.json", + "title": "ProductOrder", + "definitions": { + "ProductOrder": { + "$id": "#ProductOrder", + "type": "object", + "required": [ + "productOrderItem" + ], + "description": "A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa,", + "properties": { + "agreement": { + "type": "array", + "description": "A reference to an agreement defined in the context of the product order", + "items": { + "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" + } + }, + "billingAccount": { + "$ref": "BillingAccountRef.schema.json#BillingAccountRef" + }, + "cancellationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order is cancelled. This is used when order is cancelled. " + }, + "cancellationReason": { + "type": "string", + "description": "Reason why the order is cancelled. This is used when order is cancelled. " + }, + "category": { + "type": "string", + "description": "Used to categorize the order from a business perspective that can be useful for the OM system (e.g. \"enterprise\", \"residential\", ...)" + }, + "channel": { + "type": "array", + "items": { + "$ref": "../Common/RelatedChannel.schema.json#RelatedChannel" + } + }, + "completionDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order was completed" + }, + "description": { + "type": "string", + "description": "Description of the product order" + }, + "expectedCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Expected delivery date amended by the provider" + }, + "externalId": { + "type": "string", + "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the order" + }, + "id": { + "type": "string", + "description": "ID created on repository side (OM system)" + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "notificationContact": { + "type": "string", + "description": "Contact attached to the order to send back information regarding this order" + }, + "orderDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order was created" + }, + "orderTotalPrice": { + "type": "array", + "items": { + "$ref": "OrderPrice.schema.json#OrderPrice" + } + }, + "payment": { + "type": "array", + "items": { + "$ref": "PaymentRef.schema.json#PaymentRef" + } + }, + "priority": { + "type": "string", + "description": "A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)" + }, + "productOfferingQualification": { + "type": "array", + "items": { + "$ref": "../Product/ProductOfferingQualificationRef.schema.json#ProductOfferingQualificationRef" + } + }, + "quote": { + "type": "array", + "items": { + "$ref": "QuoteRef.schema.json#QuoteRef" + } + }, + "productOrderItem": { + "type": "array", + "items": { + "$ref": "ProductOrderItem.schema.json#ProductOrderItem" + }, + "minItems": 1 + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "requestedCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Requested delivery date from the requestor perspective" + }, + "requestedStartDate": { + "type": "string", + "format": "date-time", + "description": "Order fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow seller to begin to operationally begin the fulfillment before a date. " + }, + "state": { + "$ref": "ProductOrderStateType.schema.json#ProductOrderStateType", + "description": "Tracks the lifecycle status of the product order, such as Acknowledged, Rejected, InProgress, Pending and so on." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/ProductOrderItem.schema.json b/Customer/ProductOrderItem.schema.json index 09492aa6..fd89697a 100644 --- a/Customer/ProductOrderItem.schema.json +++ b/Customer/ProductOrderItem.schema.json @@ -1,95 +1,95 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOrderItem.schema.json", - "title": "ProductOrderItem", - "definitions": { - "ProductOrderItem": { - "$id": "#ProductOrderItem", - "type": "object", - "description": "An identified part of the order. A product order is decomposed into one or more order items.", - "properties": { - "id": { - "type": "string", - "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" - }, - "quantity": { - "type": "integer", - "description": "Quantity ordered" - }, - "action": { - "$ref": "OrderItemActionType.schema.json#OrderItemActionType", - "description": "The action to be carried out on the Product. Can be: add, modify, delete, noChange" - }, - "appointment": { - "$ref": "AppointmentRef.schema.json#AppointmentRef" - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef" - }, - "itemPrice": { - "type": "array", - "items": { - "$ref": "OrderPrice.schema.json#OrderPrice" - } - }, - "itemTerm": { - "type": "array", - "items": { - "$ref": "OrderTerm.schema.json#OrderTerm" - } - }, - "itemTotalPrice": { - "type": "array", - "items": { - "$ref": "OrderPrice.schema.json#OrderPrice" - } - }, - "payment": { - "type": "array", - "items": { - "$ref": "PaymentRef.schema.json#PaymentRef" - } - }, - "product": { - "$ref": "../Product/ProductRefOrValue.schema.json#ProductRefOrValue" - }, - "productOffering": { - "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "productOfferingQualificationItem": { - "$ref": "../Product/ProductOfferingQualificationItemRef.schema.json#ProductOfferingQualificationItemRef" - }, - "quoteItem": { - "$ref": "QuoteItemRef.schema.json#QuoteItemRef" - }, - "productOrderItem": { - "type": "array", - "items": { - "$ref": "ProductOrderItem.schema.json#ProductOrderItem" - } - }, - "productOrderItemRelationship": { - "type": "array", - "items": { - "$ref": "OrderItemRelationship.schema.json#OrderItemRelationship" - } - }, - "qualification": { - "type": "array", - "items": { - "$ref": "../Product/ProductOfferingQualificationRef.schema.json#ProductOfferingQualificationRef" - } - }, - "state": { - "$ref": "ProductOrderItemStateType.schema.json#ProductOrderItemStateType", - "description": "State of the order item : described in the state machine diagram" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOrderItem.schema.json", + "title": "ProductOrderItem", + "definitions": { + "ProductOrderItem": { + "$id": "#ProductOrderItem", + "type": "object", + "description": "An identified part of the order. A product order is decomposed into one or more order items.", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" + }, + "quantity": { + "type": "integer", + "description": "Quantity ordered" + }, + "action": { + "$ref": "OrderItemActionType.schema.json#OrderItemActionType", + "description": "The action to be carried out on the Product. Can be: add, modify, delete, noChange" + }, + "appointment": { + "$ref": "AppointmentRef.schema.json#AppointmentRef" + }, + "billingAccount": { + "$ref": "BillingAccountRef.schema.json#BillingAccountRef" + }, + "itemPrice": { + "type": "array", + "items": { + "$ref": "OrderPrice.schema.json#OrderPrice" + } + }, + "itemTerm": { + "type": "array", + "items": { + "$ref": "OrderTerm.schema.json#OrderTerm" + } + }, + "itemTotalPrice": { + "type": "array", + "items": { + "$ref": "OrderPrice.schema.json#OrderPrice" + } + }, + "payment": { + "type": "array", + "items": { + "$ref": "PaymentRef.schema.json#PaymentRef" + } + }, + "product": { + "$ref": "../Product/ProductRefOrValue.schema.json#ProductRefOrValue" + }, + "productOffering": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "productOfferingQualificationItem": { + "$ref": "../Product/ProductOfferingQualificationItemRef.schema.json#ProductOfferingQualificationItemRef" + }, + "quoteItem": { + "$ref": "QuoteItemRef.schema.json#QuoteItemRef" + }, + "productOrderItem": { + "type": "array", + "items": { + "$ref": "ProductOrderItem.schema.json#ProductOrderItem" + } + }, + "productOrderItemRelationship": { + "type": "array", + "items": { + "$ref": "OrderItemRelationship.schema.json#OrderItemRelationship" + } + }, + "qualification": { + "type": "array", + "items": { + "$ref": "../Product/ProductOfferingQualificationRef.schema.json#ProductOfferingQualificationRef" + } + }, + "state": { + "$ref": "ProductOrderItemStateType.schema.json#ProductOrderItemStateType", + "description": "State of the order item : described in the state machine diagram" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/ProductOrderItemStateType.schema.json b/Customer/ProductOrderItemStateType.schema.json index 87da3c97..e8c07a40 100644 --- a/Customer/ProductOrderItemStateType.schema.json +++ b/Customer/ProductOrderItemStateType.schema.json @@ -1,24 +1,24 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOrderItemStateType.schema.json", - "title": "ProductOrderItemStateType", - "definitions": { - "ProductOrderItemStateType": { - "$id": "#ProductOrderItemStateType", - "type": "string", - "description": "Possible values for the state of the product order item", - "enum": [ - "acknowledged", - "rejected", - "pending", - "held", - "inProgress", - "cancelled", - "completed", - "failed", - "assessingCancellation", - "pendingCancellation" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOrderItemStateType.schema.json", + "title": "ProductOrderItemStateType", + "definitions": { + "ProductOrderItemStateType": { + "$id": "#ProductOrderItemStateType", + "type": "string", + "description": "Possible values for the state of the product order item", + "enum": [ + "acknowledged", + "rejected", + "pending", + "held", + "inProgress", + "cancelled", + "completed", + "failed", + "assessingCancellation", + "pendingCancellation" + ] + } } - } } \ No newline at end of file diff --git a/Customer/ProductOrderRef.schema.json b/Customer/ProductOrderRef.schema.json index 6cecbbc5..b88c3ae7 100644 --- a/Customer/ProductOrderRef.schema.json +++ b/Customer/ProductOrderRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOrderRef.schema.json", - "title": "ProductOrderRef", - "definitions": { - "ProductOrderRef": { - "$id": "#ProductOrderRef", - "description": "ProductOrder (ProductOrder) .The product order which the recommendation is related with.", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOrderRef.schema.json", + "title": "ProductOrderRef", + "definitions": { + "ProductOrderRef": { + "$id": "#ProductOrderRef", + "description": "ProductOrder (ProductOrder) .The product order which the recommendation is related with.", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - ] } - } } \ No newline at end of file diff --git a/Customer/ProductOrderStateType.schema.json b/Customer/ProductOrderStateType.schema.json index 857fed13..4a5dd9cd 100644 --- a/Customer/ProductOrderStateType.schema.json +++ b/Customer/ProductOrderStateType.schema.json @@ -1,25 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOrderStateType.schema.json", - "title": "ProductOrderStateType", - "definitions": { - "ProductOrderStateType": { - "$id": "#ProductOrderStateType", - "type": "string", - "description": "Possible values for the state of the order", - "enum": [ - "acknowledged", - "rejected", - "pending", - "held", - "inProgress", - "cancelled", - "completed", - "failed", - "partial", - "assessingCancellation", - "pendingCancellation" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOrderStateType.schema.json", + "title": "ProductOrderStateType", + "definitions": { + "ProductOrderStateType": { + "$id": "#ProductOrderStateType", + "type": "string", + "description": "Possible values for the state of the order", + "enum": [ + "acknowledged", + "rejected", + "pending", + "held", + "inProgress", + "cancelled", + "completed", + "failed", + "partial", + "assessingCancellation", + "pendingCancellation" + ] + } } - } } \ No newline at end of file diff --git a/Customer/Quote.schema.json b/Customer/Quote.schema.json index 9f45b0a3..96c130f6 100644 --- a/Customer/Quote.schema.json +++ b/Customer/Quote.schema.json @@ -1,147 +1,147 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Quote.schema.json", - "title": "Quote", - "definitions": { - "Quote": { - "$id": "#Quote", - "type": "object", - "required": [ - "quoteItem" - ], - "description": "Quote can be used to negotiate service and product acquisition or modification between a customer and a service provider. Quote contain list of quote items, a reference to customer (partyRole), a list of productOffering and attached prices and conditions.", - "properties": { - "agreement": { - "type": "array", - "description": "A reference to an agreement defining the context of the quote", - "items": { - "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" - } - }, - "billingAccount": { - "type": "array", - "description": "A reference to a billing account to provide quote context information ", - "items": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef" - } - }, - "category": { - "type": "string", - "description": "Used to categorize the quote from a business perspective that can be useful for the CRM system (e.g. \"enterprise\", \"residential\", ...)" - }, - "contactMedium": { - "type": "array", - "description": "Information contact related to the quote requester", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - }, - "description": { - "type": "string", - "description": "Description of the quote" - }, - "effectiveQuoteCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Date when the quote has been completed" - }, - "expectedFulfillmentStartDate": { - "type": "string", - "format": "date-time", - "description": "this is the date wished by the requester to have the requested quote item delivered" - }, - "expectedQuoteCompletionDate": { - "type": "string", - "format": "date-time", - "description": "This is expected date - from quote supplier - to be able to send back a response for this quote" - }, - "externalId": { - "type": "string", - "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the quote" - }, - "id": { - "type": "string", - "description": "Unique identifier - attributed by quoting system" - }, - "instantSyncQuote": { - "type": "boolean", - "description": "An indicator which when the value is \"true\" means that requester expects to get quoting result immediately in the response. If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201. " - }, - "note": { - "type": "array", - "description": "Free form text associated with the quote", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "authorization": { - "type": "array", - "description": "An authorization provided for the quote", - "items": { - "$ref": "Authorization.schema.json#Authorization" - } - }, - "quoteDate": { - "type": "string", - "format": "date-time", - "description": "Date and time when the quote was created" - }, - "quoteItem": { - "type": "array", - "description": "An item of the quote - it is used to descirbe an operation on a product to be quoted", - "items": { - "$ref": "QuoteItem.schema.json#QuoteItem" - }, - "minItems": 1 - }, - "quoteTotalPrice": { - "type": "array", - "description": "Quote total price", - "items": { - "$ref": "QuotePrice.schema.json#QuotePrice" - } - }, - "relatedParty": { - "type": "array", - "description": "A reference to a party playing a role in this quote (customer, seller, requester, etc.)", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "productOfferingQualification": { - "type": "array", - "description": "A reference to a previously done product offering qualification", - "items": { - "$ref": "../Product/ProductOfferingQualificationRef.schema.json#ProductOfferingQualificationRef" - } - }, - "requestedQuoteCompletionDate": { - "type": "string", - "format": "date-time", - "description": "This is requested date - from quote requester - to get a complete response for this quote" - }, - "state": { - "$ref": "../Product/QuoteStateType.schema.json#QuoteStateType", - "description": "State of the quote : described in the state-machine diagram" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Quote validity period" - }, - "version": { - "type": "string", - "description": "Quote version - if the customer rejected the quote but negotiations still open a new version of the quote is managed" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Quote.schema.json", + "title": "Quote", + "definitions": { + "Quote": { + "$id": "#Quote", + "type": "object", + "required": [ + "quoteItem" + ], + "description": "Quote can be used to negotiate service and product acquisition or modification between a customer and a service provider. Quote contain list of quote items, a reference to customer (partyRole), a list of productOffering and attached prices and conditions.", + "properties": { + "agreement": { + "type": "array", + "description": "A reference to an agreement defining the context of the quote", + "items": { + "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" + } + }, + "billingAccount": { + "type": "array", + "description": "A reference to a billing account to provide quote context information ", + "items": { + "$ref": "BillingAccountRef.schema.json#BillingAccountRef" + } + }, + "category": { + "type": "string", + "description": "Used to categorize the quote from a business perspective that can be useful for the CRM system (e.g. \"enterprise\", \"residential\", ...)" + }, + "contactMedium": { + "type": "array", + "description": "Information contact related to the quote requester", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "description": { + "type": "string", + "description": "Description of the quote" + }, + "effectiveQuoteCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Date when the quote has been completed" + }, + "expectedFulfillmentStartDate": { + "type": "string", + "format": "date-time", + "description": "this is the date wished by the requester to have the requested quote item delivered" + }, + "expectedQuoteCompletionDate": { + "type": "string", + "format": "date-time", + "description": "This is expected date - from quote supplier - to be able to send back a response for this quote" + }, + "externalId": { + "type": "string", + "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the quote" + }, + "id": { + "type": "string", + "description": "Unique identifier - attributed by quoting system" + }, + "instantSyncQuote": { + "type": "boolean", + "description": "An indicator which when the value is \"true\" means that requester expects to get quoting result immediately in the response. If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201. " + }, + "note": { + "type": "array", + "description": "Free form text associated with the quote", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "authorization": { + "type": "array", + "description": "An authorization provided for the quote", + "items": { + "$ref": "Authorization.schema.json#Authorization" + } + }, + "quoteDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the quote was created" + }, + "quoteItem": { + "type": "array", + "description": "An item of the quote - it is used to descirbe an operation on a product to be quoted", + "items": { + "$ref": "QuoteItem.schema.json#QuoteItem" + }, + "minItems": 1 + }, + "quoteTotalPrice": { + "type": "array", + "description": "Quote total price", + "items": { + "$ref": "QuotePrice.schema.json#QuotePrice" + } + }, + "relatedParty": { + "type": "array", + "description": "A reference to a party playing a role in this quote (customer, seller, requester, etc.)", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "productOfferingQualification": { + "type": "array", + "description": "A reference to a previously done product offering qualification", + "items": { + "$ref": "../Product/ProductOfferingQualificationRef.schema.json#ProductOfferingQualificationRef" + } + }, + "requestedQuoteCompletionDate": { + "type": "string", + "format": "date-time", + "description": "This is requested date - from quote requester - to get a complete response for this quote" + }, + "state": { + "$ref": "../Product/QuoteStateType.schema.json#QuoteStateType", + "description": "State of the quote : described in the state-machine diagram" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Quote validity period" + }, + "version": { + "type": "string", + "description": "Quote version - if the customer rejected the quote but negotiations still open a new version of the quote is managed" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/QuoteItem.schema.json b/Customer/QuoteItem.schema.json index 0ba71951..404cd736 100644 --- a/Customer/QuoteItem.schema.json +++ b/Customer/QuoteItem.schema.json @@ -1,101 +1,101 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteItem.schema.json", - "title": "QuoteItem", - "definitions": { - "QuoteItem": { - "$id": "#QuoteItem", - "type": "object", - "description": "A quote items describe an action to be performed on a productOffering or a product in order to get pricing elements and condition.", - "properties": { - "action": { - "type": "string", - "description": "Action to be performed on this quote item (add, modify, remove, etc.)" - }, - "appointment": { - "type": "array", - "description": "A reference to appointment(s) associated with this quote item", - "items": { - "$ref": "AppointmentRef.schema.json#AppointmentRef" - } - }, - "attachment": { - "type": "array", - "description": "A reference to attachment(s) associated with this quote item", - "items": { - "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" - } - }, - "id": { - "type": "string", - "description": "Identifier of the quote item (generally it is a sequence number 01, 02, 03, ...)" - }, - "note": { - "type": "array", - "description": "Free form text associated with the quote item", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "product": { - "$ref": "../Product/ProductRefOrValue.schema.json#ProductRefOrValue" - }, - "productOffering": { - "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "quantity": { - "type": "integer", - "description": "Quantity asked for this quote item" - }, - "quoteItem": { - "type": "array", - "description": "A structure to embedded quote item within quote item", - "items": { - "$ref": "QuoteItem.schema.json#QuoteItem" - } - }, - "quoteItemAuthorization": { - "type": "array", - "description": "Authorization related to this quote item", - "items": { - "$ref": "Authorization.schema.json#Authorization" - } - }, - "quoteItemPrice": { - "type": "array", - "description": "Price for this quote item", - "items": { - "$ref": "QuotePrice.schema.json#QuotePrice" - } - }, - "quoteItemRelationship": { - "type": "array", - "description": "A relationship from item within a quote", - "items": { - "$ref": "QuoteItemRelationship.schema.json#QuoteItemRelationship" - } - }, - "productOfferingQualificationItem": { - "description": "A reference to a previously done POQ with item specified", - "$ref": "../Product/ProductOfferingQualificationItemRef.schema.json#ProductOfferingQualificationItemRef" - }, - "relatedParty": { - "type": "array", - "description": "A reference to a party playing a role in this quote item", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "state": { - "type": "string", - "description": "State of the quote item : described in the state machine diagram" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteItem.schema.json", + "title": "QuoteItem", + "definitions": { + "QuoteItem": { + "$id": "#QuoteItem", + "type": "object", + "description": "A quote items describe an action to be performed on a productOffering or a product in order to get pricing elements and condition.", + "properties": { + "action": { + "type": "string", + "description": "Action to be performed on this quote item (add, modify, remove, etc.)" + }, + "appointment": { + "type": "array", + "description": "A reference to appointment(s) associated with this quote item", + "items": { + "$ref": "AppointmentRef.schema.json#AppointmentRef" + } + }, + "attachment": { + "type": "array", + "description": "A reference to attachment(s) associated with this quote item", + "items": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + } + }, + "id": { + "type": "string", + "description": "Identifier of the quote item (generally it is a sequence number 01, 02, 03, ...)" + }, + "note": { + "type": "array", + "description": "Free form text associated with the quote item", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "product": { + "$ref": "../Product/ProductRefOrValue.schema.json#ProductRefOrValue" + }, + "productOffering": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "quantity": { + "type": "integer", + "description": "Quantity asked for this quote item" + }, + "quoteItem": { + "type": "array", + "description": "A structure to embedded quote item within quote item", + "items": { + "$ref": "QuoteItem.schema.json#QuoteItem" + } + }, + "quoteItemAuthorization": { + "type": "array", + "description": "Authorization related to this quote item", + "items": { + "$ref": "Authorization.schema.json#Authorization" + } + }, + "quoteItemPrice": { + "type": "array", + "description": "Price for this quote item", + "items": { + "$ref": "QuotePrice.schema.json#QuotePrice" + } + }, + "quoteItemRelationship": { + "type": "array", + "description": "A relationship from item within a quote", + "items": { + "$ref": "QuoteItemRelationship.schema.json#QuoteItemRelationship" + } + }, + "productOfferingQualificationItem": { + "description": "A reference to a previously done POQ with item specified", + "$ref": "../Product/ProductOfferingQualificationItemRef.schema.json#ProductOfferingQualificationItemRef" + }, + "relatedParty": { + "type": "array", + "description": "A reference to a party playing a role in this quote item", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "state": { + "type": "string", + "description": "State of the quote item : described in the state machine diagram" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/QuoteItemRef.schema.json b/Customer/QuoteItemRef.schema.json index b39c4222..3b8208e5 100644 --- a/Customer/QuoteItemRef.schema.json +++ b/Customer/QuoteItemRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteItemRef.schema.json", - "title": "QuoteItemRef", - "definitions": { - "QuoteItemRef": { - "$id": "#QuoteItemRef", - "type": "object", - "description": "It's a Quote item that has been executed previously.", - "required": [ - "id", - "quoteId" - ], - "properties": { - "quoteHref": { - "type": "string", - "description": "Reference of the related entity." - }, - "quoteId": { - "type": "string", - "description": "Unique identifier of a related entity." - }, - "quoteName": { - "type": "string", - "description": "Name of the related entity." - }, - "id": { - "type": "string", - "description": "Id of an item of a quote" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteItemRef.schema.json", + "title": "QuoteItemRef", + "definitions": { + "QuoteItemRef": { + "$id": "#QuoteItemRef", + "type": "object", + "description": "It's a Quote item that has been executed previously.", + "required": [ + "id", + "quoteId" + ], + "properties": { + "quoteHref": { + "type": "string", + "description": "Reference of the related entity." + }, + "quoteId": { + "type": "string", + "description": "Unique identifier of a related entity." + }, + "quoteName": { + "type": "string", + "description": "Name of the related entity." + }, + "id": { + "type": "string", + "description": "Id of an item of a quote" + } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] } - } } \ No newline at end of file diff --git a/Customer/QuoteItemRelationship.schema.json b/Customer/QuoteItemRelationship.schema.json index 956dd6da..66ef513e 100644 --- a/Customer/QuoteItemRelationship.schema.json +++ b/Customer/QuoteItemRelationship.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteItemRelationship.schema.json", - "title": "QuoteItemRelationship", - "definitions": { - "QuoteItemRelationship": { - "$id": "#QuoteItemRelationship", - "description": "Used to describe relationship between quote item. These relationship could have an impact on pricing and conditions", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "ID of the related order item (must be in the same quote)" - }, - "relationshipType": { - "type": "string", - "description": "Relationship type as relies on, bundles, etc..." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteItemRelationship.schema.json", + "title": "QuoteItemRelationship", + "definitions": { + "QuoteItemRelationship": { + "$id": "#QuoteItemRelationship", + "description": "Used to describe relationship between quote item. These relationship could have an impact on pricing and conditions", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the related order item (must be in the same quote)" + }, + "relationshipType": { + "type": "string", + "description": "Relationship type as relies on, bundles, etc..." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/QuotePrice.schema.json b/Customer/QuotePrice.schema.json index ccc7ec6a..beb9d8ec 100644 --- a/Customer/QuotePrice.schema.json +++ b/Customer/QuotePrice.schema.json @@ -1,52 +1,52 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuotePrice.schema.json", - "title": "QuotePrice", - "definitions": { - "QuotePrice": { - "$id": "#QuotePrice", - "description": "Description of price and discount awarded", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the quote/quote item price" - }, - "name": { - "type": "string", - "description": "Name of the quote /quote item price" - }, - "productOfferingPrice": { - "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef", - "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time." - }, - "priceType": { - "type": "string", - "description": "indicate if the price is for recurrent or no-recurrent charge" - }, - "recurringChargePeriod": { - "type": "string", - "description": "Used for recurring charge to indicate period (month, week, etc..)" - }, - "unitOfMeasure": { - "type": "string", - "description": "Unit of Measure if price depending on it (Gb, SMS volume, etc..)" - }, - "priceAlteration": { - "type": "array", - "items": { - "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" - } - }, - "price": { - "$ref": "Price.schema.json#Price" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuotePrice.schema.json", + "title": "QuotePrice", + "definitions": { + "QuotePrice": { + "$id": "#QuotePrice", + "description": "Description of price and discount awarded", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the quote/quote item price" + }, + "name": { + "type": "string", + "description": "Name of the quote /quote item price" + }, + "productOfferingPrice": { + "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef", + "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time." + }, + "priceType": { + "type": "string", + "description": "indicate if the price is for recurrent or no-recurrent charge" + }, + "recurringChargePeriod": { + "type": "string", + "description": "Used for recurring charge to indicate period (month, week, etc..)" + }, + "unitOfMeasure": { + "type": "string", + "description": "Unit of Measure if price depending on it (Gb, SMS volume, etc..)" + }, + "priceAlteration": { + "type": "array", + "items": { + "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" + } + }, + "price": { + "$ref": "Price.schema.json#Price" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/QuoteRef.schema.json b/Customer/QuoteRef.schema.json index 980bbd5f..6237cc66 100644 --- a/Customer/QuoteRef.schema.json +++ b/Customer/QuoteRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteRef.schema.json", - "title": "QuoteRef", - "definitions": { - "QuoteRef": { - "$id": "#QuoteRef", - "type": "object", - "description": "It's a Quote that has been executed previously", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteRef.schema.json", + "title": "QuoteRef", + "definitions": { + "QuoteRef": { + "$id": "#QuoteRef", + "type": "object", + "description": "It's a Quote that has been executed previously", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - ] } - } } \ No newline at end of file diff --git a/Customer/SearchTimeSlot.schema.json b/Customer/SearchTimeSlot.schema.json index 848fcd39..14e50c23 100644 --- a/Customer/SearchTimeSlot.schema.json +++ b/Customer/SearchTimeSlot.schema.json @@ -1,66 +1,66 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SearchTimeSlot.schema.json", - "title": "SearchTimeSlot", - "definitions": { - "SearchTimeSlot": { - "$id": "#SearchTimeSlot", - "type": "object", - "description": "This task resource is used to retrieve available time slots. One of this available time slot is after used to create or reschedule an appointment", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the search time slot request" - }, - "href": { - "type": "string", - "description": "Reference to access the search time slot resource" - }, - "status": { - "type": "string", - "description": "Status of the search time slot (rejected, inProgress, done or terminatedWithError)" - }, - "searchDate": { - "type": "string", - "format": "date-time", - "description": "Date when the search time slot is performed" - }, - "searchResult": { - "type": "string", - "description": "Result of the search time slot (success or fail for example)" - }, - "requestedTimeSlot": { - "type": "array", - "items": { - "$ref": "TimeSlot.schema.json#TimeSlot" - } - }, - "availableTimeSlot": { - "type": "array", - "items": { - "$ref": "TimeSlot.schema.json#TimeSlot" - } - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty", - "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity." - }, - "relatedEntity": { - "type": "array", - "items": { - "$ref": "../Common/RelatedEntity.schema.json#RelatedEntity" - } - }, - "relatedPlace": { - "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue", - "description": "Related place defines (by reference or value) the place where the appointment will take place." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SearchTimeSlot.schema.json", + "title": "SearchTimeSlot", + "definitions": { + "SearchTimeSlot": { + "$id": "#SearchTimeSlot", + "type": "object", + "description": "This task resource is used to retrieve available time slots. One of this available time slot is after used to create or reschedule an appointment", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the search time slot request" + }, + "href": { + "type": "string", + "description": "Reference to access the search time slot resource" + }, + "status": { + "type": "string", + "description": "Status of the search time slot (rejected, inProgress, done or terminatedWithError)" + }, + "searchDate": { + "type": "string", + "format": "date-time", + "description": "Date when the search time slot is performed" + }, + "searchResult": { + "type": "string", + "description": "Result of the search time slot (success or fail for example)" + }, + "requestedTimeSlot": { + "type": "array", + "items": { + "$ref": "TimeSlot.schema.json#TimeSlot" + } + }, + "availableTimeSlot": { + "type": "array", + "items": { + "$ref": "TimeSlot.schema.json#TimeSlot" + } + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty", + "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity." + }, + "relatedEntity": { + "type": "array", + "items": { + "$ref": "../Common/RelatedEntity.schema.json#RelatedEntity" + } + }, + "relatedPlace": { + "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue", + "description": "Related place defines (by reference or value) the place where the appointment will take place." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/SettlementMethod.schema.json b/Customer/SettlementMethod.schema.json index 1386ed37..787fdc75 100644 --- a/Customer/SettlementMethod.schema.json +++ b/Customer/SettlementMethod.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SettlementMethod.schema.json", - "title": "SettlementMethod", - "definitions": { - "SettlementMethod": { - "$id": "#SettlementMethod", - "description": "Is the way in which the CSP provides the payment", - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Code of the settlement method" - }, - "label": { - "type": "string", - "description": "A word, term or phrase by which a settlement method is known and distinguished from other settlement method" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SettlementMethod.schema.json", + "title": "SettlementMethod", + "definitions": { + "SettlementMethod": { + "$id": "#SettlementMethod", + "description": "Is the way in which the CSP provides the payment", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Code of the settlement method" + }, + "label": { + "type": "string", + "description": "A word, term or phrase by which a settlement method is known and distinguished from other settlement method" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/SettlementNoteAdvice.schema.json b/Customer/SettlementNoteAdvice.schema.json index 2365301b..11538ede 100644 --- a/Customer/SettlementNoteAdvice.schema.json +++ b/Customer/SettlementNoteAdvice.schema.json @@ -1,92 +1,92 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SettlementNoteAdvice.schema.json", - "title": "SettlementNoteAdvice", - "definitions": { - "SettlementNoteAdvice": { - "$id": "#SettlementNoteAdvice", - "description": "The settlement is about transferring money receiving by a CSP to a partner. The settlement is notified to the partner with a settlement note advice containing details in settlement lines.", - "type": "object", - "properties": { - "currencyCode": { - "type": "string", - "description": "A string used as a code for specifying the currency associated to the given amounts. The ISO4217 norm uses 3 letters to define the currency (for example USD for US dollar or EUR for Euro)." - }, - "date": { - "type": "string", - "format": "date-time", - "description": "Creation date of the settlement note advice" - }, - "description": { - "type": "string", - "description": "A free description text" - }, - "href": { - "type": "string", - "description": "Reference of the settlement note advice" - }, - "id": { - "type": "string", - "description": "A unique identifier for the settlement note advice" - }, - "issuerTaxRegistration": { - "type": "string", - "description": "Tax registration number of the issuer" - }, - "paymentDueDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the due amount should have been paid to the partner" - }, - "receiverTaxRegistration": { - "type": "string", - "description": "Tax registration number of the receiver" - }, - "taxDate": { - "type": "string", - "format": "date-time", - "description": "Date of the tax" - }, - "taxExcludedAmount": { - "type": "number", - "format": "float", - "description": "All taxes excluded amount (expressed in the given currency)" - }, - "taxIncludedAmount": { - "type": "number", - "format": "float", - "description": "All taxes included amount (expressed in the given currency)" - }, - "settlementMethod": { - "$ref": "SettlementMethod.schema.json#SettlementMethod" - }, - "settlementNoteImage": { - "$ref": "SettlementNoteImage.schema.json#SettlementNoteImage" - }, - "receiver": { - "$ref": "../EngagedParty/PartyRef.schema.json#PartyRef" - }, - "taxItem": { - "type": "array", - "items": { - "$ref": "TaxItem.schema.json#TaxItem" - } - }, - "issuer": { - "$ref": "../EngagedParty/PartyRef.schema.json#PartyRef" - }, - "settlementNoteItem": { - "type": "array", - "items": { - "$ref": "SettlementNoteItem.schema.json#SettlementNoteItem" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SettlementNoteAdvice.schema.json", + "title": "SettlementNoteAdvice", + "definitions": { + "SettlementNoteAdvice": { + "$id": "#SettlementNoteAdvice", + "description": "The settlement is about transferring money receiving by a CSP to a partner. The settlement is notified to the partner with a settlement note advice containing details in settlement lines.", + "type": "object", + "properties": { + "currencyCode": { + "type": "string", + "description": "A string used as a code for specifying the currency associated to the given amounts. The ISO4217 norm uses 3 letters to define the currency (for example USD for US dollar or EUR for Euro)." + }, + "date": { + "type": "string", + "format": "date-time", + "description": "Creation date of the settlement note advice" + }, + "description": { + "type": "string", + "description": "A free description text" + }, + "href": { + "type": "string", + "description": "Reference of the settlement note advice" + }, + "id": { + "type": "string", + "description": "A unique identifier for the settlement note advice" + }, + "issuerTaxRegistration": { + "type": "string", + "description": "Tax registration number of the issuer" + }, + "paymentDueDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the due amount should have been paid to the partner" + }, + "receiverTaxRegistration": { + "type": "string", + "description": "Tax registration number of the receiver" + }, + "taxDate": { + "type": "string", + "format": "date-time", + "description": "Date of the tax" + }, + "taxExcludedAmount": { + "type": "number", + "format": "float", + "description": "All taxes excluded amount (expressed in the given currency)" + }, + "taxIncludedAmount": { + "type": "number", + "format": "float", + "description": "All taxes included amount (expressed in the given currency)" + }, + "settlementMethod": { + "$ref": "SettlementMethod.schema.json#SettlementMethod" + }, + "settlementNoteImage": { + "$ref": "SettlementNoteImage.schema.json#SettlementNoteImage" + }, + "receiver": { + "$ref": "../EngagedParty/PartyRef.schema.json#PartyRef" + }, + "taxItem": { + "type": "array", + "items": { + "$ref": "TaxItem.schema.json#TaxItem" + } + }, + "issuer": { + "$ref": "../EngagedParty/PartyRef.schema.json#PartyRef" + }, + "settlementNoteItem": { + "type": "array", + "items": { + "$ref": "SettlementNoteItem.schema.json#SettlementNoteItem" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/SettlementNoteImage.schema.json b/Customer/SettlementNoteImage.schema.json index dc7db03b..5eb0481d 100644 --- a/Customer/SettlementNoteImage.schema.json +++ b/Customer/SettlementNoteImage.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SettlementNoteImage.schema.json", - "title": "SettlementNoteImage", - "definitions": { - "SettlementNoteImage": { - "$id": "#SettlementNoteImage", - "description": "Is the image of the settlement note", - "type": "object", - "properties": { - "imageFileName": { - "type": "string", - "description": "The name of the file in which the settlement note image is saved." - }, - "imageFileURL": { - "type": "string", - "description": "The URL of the settlement note image" - }, - "imageFormat": { - "type": "string", - "description": "The format of the settlement note image (csv, pdf, xls, txt...)" - }, - "imageSize": { - "type": "integer", - "description": "The size of the settlement note image (in bytes)" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SettlementNoteImage.schema.json", + "title": "SettlementNoteImage", + "definitions": { + "SettlementNoteImage": { + "$id": "#SettlementNoteImage", + "description": "Is the image of the settlement note", + "type": "object", + "properties": { + "imageFileName": { + "type": "string", + "description": "The name of the file in which the settlement note image is saved." + }, + "imageFileURL": { + "type": "string", + "description": "The URL of the settlement note image" + }, + "imageFormat": { + "type": "string", + "description": "The format of the settlement note image (csv, pdf, xls, txt...)" + }, + "imageSize": { + "type": "integer", + "description": "The size of the settlement note image (in bytes)" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/SettlementNoteItem.schema.json b/Customer/SettlementNoteItem.schema.json index 10cce5f6..a186a1f9 100644 --- a/Customer/SettlementNoteItem.schema.json +++ b/Customer/SettlementNoteItem.schema.json @@ -1,59 +1,59 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SettlementNoteItem.schema.json", - "title": "SettlementNoteItem", - "definitions": { - "SettlementNoteItem": { - "$id": "#SettlementNoteItem", - "description": "Concerns a product identified by its catalogue reference. It could also follow a period delimited by a start and an end date.", - "type": "object", - "properties": { - "itemId": { - "type": "string", - "description": "Unique identifier of the settlement note item" - }, - "itemLabel": { - "type": "string", - "description": "A free description text for the settlement note item" - }, - "itemNumber": { - "type": "string", - "description": "Unique number assigned to the settlement note item" - }, - "period": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - }, - "quantity": { - "type": "integer", - "description": "Quantity" - }, - "taxExcludedAmount": { - "type": "number", - "format": "float", - "description": "Tax excluded amount equal to quantity * taxExcludedUnitPrice" - }, - "taxExcludedUnitPrice": { - "type": "number", - "format": "float", - "description": "Tax excluded unit price to be applied on the given quantity" - }, - "taxIncludedAmount": { - "type": "number", - "format": "float", - "description": "All taxes included amount equal to taxExcludedAmount + taxAmount" - }, - "taxItem": { - "type": "array", - "items": { - "$ref": "TaxItem.schema.json#TaxItem" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SettlementNoteItem.schema.json", + "title": "SettlementNoteItem", + "definitions": { + "SettlementNoteItem": { + "$id": "#SettlementNoteItem", + "description": "Concerns a product identified by its catalogue reference. It could also follow a period delimited by a start and an end date.", + "type": "object", + "properties": { + "itemId": { + "type": "string", + "description": "Unique identifier of the settlement note item" + }, + "itemLabel": { + "type": "string", + "description": "A free description text for the settlement note item" + }, + "itemNumber": { + "type": "string", + "description": "Unique number assigned to the settlement note item" + }, + "period": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + }, + "quantity": { + "type": "integer", + "description": "Quantity" + }, + "taxExcludedAmount": { + "type": "number", + "format": "float", + "description": "Tax excluded amount equal to quantity * taxExcludedUnitPrice" + }, + "taxExcludedUnitPrice": { + "type": "number", + "format": "float", + "description": "Tax excluded unit price to be applied on the given quantity" + }, + "taxIncludedAmount": { + "type": "number", + "format": "float", + "description": "All taxes included amount equal to taxExcludedAmount + taxAmount" + }, + "taxItem": { + "type": "array", + "items": { + "$ref": "TaxItem.schema.json#TaxItem" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/ShoppingCart.schema.json b/Customer/ShoppingCart.schema.json index 4cf8dda2..be4a61fe 100644 --- a/Customer/ShoppingCart.schema.json +++ b/Customer/ShoppingCart.schema.json @@ -1,56 +1,56 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ShoppingCart.schema.json", - "title": "ShoppingCart", - "definitions": { - "ShoppingCart": { - "$id": "#ShoppingCart", - "description": "Shopping Cart resource is used for the temporarily selection and reservation of product offerings in e-commerce, call center and retail purchase. Shopping cart supports purchase of both physical and digital goods and service (e.g. handset, telecom network service). Shopping Cart contain list of cart items, a reference to customer (partyRole) or contact medium in case customer not exist, and the total items price including promotions", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink to access the shopping cart" - }, - "id": { - "type": "string", - "description": "Unique identifier created on provider side (e.g. Order Capture system)" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the shopping cart is valid (e.g. 90 if no activity or 7 days if cart is empty)" - }, - "contactMedium": { - "type": "array", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - }, - "cartTotalPrice": { - "type": "array", - "items": { - "$ref": "CartPrice.schema.json#CartPrice" - }, - "description": "Total amount of the shopping cart, usually of money, that represents the actual price paid by the Customer for cart (considering only \"Active\" cart items)" - }, - "cartItem": { - "type": "array", - "items": { - "$ref": "CartItem.schema.json#CartItem" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ShoppingCart.schema.json", + "title": "ShoppingCart", + "definitions": { + "ShoppingCart": { + "$id": "#ShoppingCart", + "description": "Shopping Cart resource is used for the temporarily selection and reservation of product offerings in e-commerce, call center and retail purchase. Shopping cart supports purchase of both physical and digital goods and service (e.g. handset, telecom network service). Shopping Cart contain list of cart items, a reference to customer (partyRole) or contact medium in case customer not exist, and the total items price including promotions", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink to access the shopping cart" + }, + "id": { + "type": "string", + "description": "Unique identifier created on provider side (e.g. Order Capture system)" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the shopping cart is valid (e.g. 90 if no activity or 7 days if cart is empty)" + }, + "contactMedium": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "cartTotalPrice": { + "type": "array", + "items": { + "$ref": "CartPrice.schema.json#CartPrice" + }, + "description": "Total amount of the shopping cart, usually of money, that represents the actual price paid by the Customer for cart (considering only \"Active\" cart items)" + }, + "cartItem": { + "type": "array", + "items": { + "$ref": "CartItem.schema.json#CartItem" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/ShoppingCartRef.schema.json b/Customer/ShoppingCartRef.schema.json index 26c0230e..ae0cb31c 100644 --- a/Customer/ShoppingCartRef.schema.json +++ b/Customer/ShoppingCartRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ShoppingCartRef.schema.json", - "title": "ShoppingCartRef", - "definitions": { - "ShoppingCartRef": { - "$id": "#ShoppingCartRef", - "description": "ShoppingCart (ShoppingCartRef) . The shopping cart which the recommendation is related with.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hypertext Reference of the shopping cart." - }, - "id": { - "type": "string", - "description": "Unique identifier of shopping cart" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ShoppingCartRef.schema.json", + "title": "ShoppingCartRef", + "definitions": { + "ShoppingCartRef": { + "$id": "#ShoppingCartRef", + "description": "ShoppingCart (ShoppingCartRef) . The shopping cart which the recommendation is related with.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hypertext Reference of the shopping cart." + }, + "id": { + "type": "string", + "description": "Unique identifier of shopping cart" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/TaxItem.schema.json b/Customer/TaxItem.schema.json index f35e98b2..9746c152 100644 --- a/Customer/TaxItem.schema.json +++ b/Customer/TaxItem.schema.json @@ -1,32 +1,32 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaxItem.schema.json", - "title": "TaxItem", - "definitions": { - "TaxItem": { - "$id": "#TaxItem", - "description": "A tax item is created for each tax rate and tax type used in the bill.", - "type": "object", - "properties": { - "taxAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Amount of tax expressed in the given currency" - }, - "taxCategory": { - "type": "string", - "description": "Tax category" - }, - "taxRate": { - "type": "number", - "format": "float", - "description": "Applied rate of the tax" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaxItem.schema.json", + "title": "TaxItem", + "definitions": { + "TaxItem": { + "$id": "#TaxItem", + "description": "A tax item is created for each tax rate and tax type used in the bill.", + "type": "object", + "properties": { + "taxAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Amount of tax expressed in the given currency" + }, + "taxCategory": { + "type": "string", + "description": "Tax category" + }, + "taxRate": { + "type": "number", + "format": "float", + "description": "Applied rate of the tax" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/TimeSlot.schema.json b/Customer/TimeSlot.schema.json index ae8d5967..3f3882c9 100644 --- a/Customer/TimeSlot.schema.json +++ b/Customer/TimeSlot.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TimeSlot.schema.json", - "title": "TimeSlot", - "definitions": { - "TimeSlot": { - "$id": "#TimeSlot", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the TimeSlot" - }, - "id": { - "type": "string", - "description": "Unique identifier of the TimeSlot" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty", - "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Start date and end date of the timeSlot" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TimeSlot.schema.json", + "title": "TimeSlot", + "definitions": { + "TimeSlot": { + "$id": "#TimeSlot", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the TimeSlot" + }, + "id": { + "type": "string", + "description": "Unique identifier of the TimeSlot" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty", + "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Start date and end date of the timeSlot" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/TokenizedCardDetails.schema.json b/Customer/TokenizedCardDetails.schema.json index 2c314fe4..d0fd9176 100644 --- a/Customer/TokenizedCardDetails.schema.json +++ b/Customer/TokenizedCardDetails.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TokenizedCardDetails.schema.json", - "title": "TokenizedCardDetails", - "definitions": { - "TokenizedCardDetails": { - "$id": "#TokenizedCardDetails", - "description": "Detailed information for a stored tokenized card", - "type": "object", - "properties": { - "brand": { - "type": "string", - "description": "Card brand. Might be used for display purposes" - }, - "issuer": { - "type": "string", - "description": "Whoever issued the token" - }, - "lastFourDigits": { - "type": "string", - "description": "Last four digits of the credit card. Might be used for display purposes" - }, - "token": { - "type": "string", - "description": "The token itself" - }, - "tokenType": { - "type": "string", - "description": "Token type (e.g.: emv)" - }, - "cardType": { - "type": "string", - "description": "Card type. Might be used for display purposes" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TokenizedCardDetails.schema.json", + "title": "TokenizedCardDetails", + "definitions": { + "TokenizedCardDetails": { + "$id": "#TokenizedCardDetails", + "description": "Detailed information for a stored tokenized card", + "type": "object", + "properties": { + "brand": { + "type": "string", + "description": "Card brand. Might be used for display purposes" + }, + "issuer": { + "type": "string", + "description": "Whoever issued the token" + }, + "lastFourDigits": { + "type": "string", + "description": "Last four digits of the credit card. Might be used for display purposes" + }, + "token": { + "type": "string", + "description": "The token itself" + }, + "tokenType": { + "type": "string", + "description": "Token type (e.g.: emv)" + }, + "cardType": { + "type": "string", + "description": "Card type. Might be used for display purposes" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/TokenizedCardMethod.schema.json b/Customer/TokenizedCardMethod.schema.json index e680d994..44a99bbb 100644 --- a/Customer/TokenizedCardMethod.schema.json +++ b/Customer/TokenizedCardMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TokenizedCardMethod.schema.json", - "title": "TokenizedCardMethod", - "definitions": { - "TokenizedCardMethod": { - "$id": "#TokenizedCardMethod", - "type": "object", - "properties": { - "details": { - "$ref": "TokenizedCardDetails.schema.json#TokenizedCardDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TokenizedCardMethod.schema.json", + "title": "TokenizedCardMethod", + "definitions": { + "TokenizedCardMethod": { + "$id": "#TokenizedCardMethod", + "type": "object", + "properties": { + "details": { + "$ref": "TokenizedCardDetails.schema.json#TokenizedCardDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/VoucherDetails.schema.json b/Customer/VoucherDetails.schema.json index bf0bc289..35d239bd 100644 --- a/Customer/VoucherDetails.schema.json +++ b/Customer/VoucherDetails.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "VoucherDetails.schema.json", - "title": "VoucherDetails", - "definitions": { - "VoucherDetails": { - "$id": "#VoucherDetails", - "description": "Detailed information of a voucher", - "type": "object", - "properties": { - "campaign": { - "type": "string", - "description": "Campaign this voucher belongs to" - }, - "code": { - "type": "string", - "description": "Code that identifies the voucher" - }, - "expirationDate": { - "type": "string", - "format": "date-time", - "description": "The vouchers expiration date" - }, - "value": { - "type": "number", - "format": "float", - "description": "Discount that the voucher applies when it is a discount" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "VoucherDetails.schema.json", + "title": "VoucherDetails", + "definitions": { + "VoucherDetails": { + "$id": "#VoucherDetails", + "description": "Detailed information of a voucher", + "type": "object", + "properties": { + "campaign": { + "type": "string", + "description": "Campaign this voucher belongs to" + }, + "code": { + "type": "string", + "description": "Code that identifies the voucher" + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "The vouchers expiration date" + }, + "value": { + "type": "number", + "format": "float", + "description": "Discount that the voucher applies when it is a discount" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Customer/VoucherMethod.schema.json b/Customer/VoucherMethod.schema.json index c9a6c996..8ca3fce0 100644 --- a/Customer/VoucherMethod.schema.json +++ b/Customer/VoucherMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "VoucherMethod.schema.json", - "title": "VoucherMethod", - "definitions": { - "VoucherMethod": { - "$id": "#VoucherMethod", - "type": "object", - "properties": { - "details": { - "$ref": "VoucherDetails.schema.json#VoucherDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "VoucherMethod.schema.json", + "title": "VoucherMethod", + "definitions": { + "VoucherMethod": { + "$id": "#VoucherMethod", + "type": "object", + "properties": { + "details": { + "$ref": "VoucherDetails.schema.json#VoucherDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/Account.schema.json b/EngagedParty/Account.schema.json index 8db480bf..76024c2e 100644 --- a/EngagedParty/Account.schema.json +++ b/EngagedParty/Account.schema.json @@ -1,85 +1,85 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Account.schema.json", - "title": "Account", - "definitions": { - "Account": { - "$id": "#Account", - "description": "Generic Account structure used to define commonalities between sub concepts of PartyAccount and Financial Account.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "creditLimit": { - "$ref": "../Common/Money.schema.json#Money", - "description": "The maximum amount of money that may be charged on an account" - }, - "description": { - "type": "string", - "description": "Detailed description of the party account" - }, - "href": { - "type": "string", - "description": "Unique reference of the account" - }, - "id": { - "type": "string", - "description": "Unique identifier of the account" - }, - "lastModified": { - "type": "string", - "format": "date-time", - "description": "Date of last modification of the account" - }, - "name": { - "type": "string", - "description": "Name of the account" - }, - "state": { - "type": "string", - "description": "Contains the lifecycle state such as: Active, Closed, Suspended and so on." - }, - "accountType": { - "type": "string", - "description": "A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values." - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "taxExemption": { - "type": "array", - "items": { - "$ref": "AccountTaxExemption.schema.json#AccountTaxExemption" - } - }, - "contact": { - "type": "array", - "items": { - "$ref": "Contact.schema.json#Contact" - } - }, - "accountBalance": { - "type": "array", - "items": { - "$ref": "AccountBalance.schema.json#AccountBalance" - } - }, - "accountRelationship": { - "type": "array", - "items": { - "$ref": "AccountRelationship.schema.json#AccountRelationship" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Account.schema.json", + "title": "Account", + "definitions": { + "Account": { + "$id": "#Account", + "description": "Generic Account structure used to define commonalities between sub concepts of PartyAccount and Financial Account.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "creditLimit": { + "$ref": "../Common/Money.schema.json#Money", + "description": "The maximum amount of money that may be charged on an account" + }, + "description": { + "type": "string", + "description": "Detailed description of the party account" + }, + "href": { + "type": "string", + "description": "Unique reference of the account" + }, + "id": { + "type": "string", + "description": "Unique identifier of the account" + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "Date of last modification of the account" + }, + "name": { + "type": "string", + "description": "Name of the account" + }, + "state": { + "type": "string", + "description": "Contains the lifecycle state such as: Active, Closed, Suspended and so on." + }, + "accountType": { + "type": "string", + "description": "A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values." + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "RelatedParty.schema.json#RelatedParty" + } + }, + "taxExemption": { + "type": "array", + "items": { + "$ref": "AccountTaxExemption.schema.json#AccountTaxExemption" + } + }, + "contact": { + "type": "array", + "items": { + "$ref": "Contact.schema.json#Contact" + } + }, + "accountBalance": { + "type": "array", + "items": { + "$ref": "AccountBalance.schema.json#AccountBalance" + } + }, + "accountRelationship": { + "type": "array", + "items": { + "$ref": "AccountRelationship.schema.json#AccountRelationship" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/AccountBalance.schema.json b/EngagedParty/AccountBalance.schema.json index d60a9551..44e9e2ff 100644 --- a/EngagedParty/AccountBalance.schema.json +++ b/EngagedParty/AccountBalance.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountBalance.schema.json", - "title": "AccountBalance", - "definitions": { - "AccountBalance": { - "$id": "#AccountBalance", - "description": "Balances linked to the account", - "type": "object", - "required": [ - "amount", - "balanceType", - "validFor" - ], - "properties": { - "amount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Balance amount" - }, - "balanceType": { - "type": "string", - "description": "Type of the balance : deposit balance, disputed balance, loyalty balance, receivable balance..." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Balance validity period" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountBalance.schema.json", + "title": "AccountBalance", + "definitions": { + "AccountBalance": { + "$id": "#AccountBalance", + "description": "Balances linked to the account", + "type": "object", + "required": [ + "amount", + "balanceType", + "validFor" + ], + "properties": { + "amount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Balance amount" + }, + "balanceType": { + "type": "string", + "description": "Type of the balance : deposit balance, disputed balance, loyalty balance, receivable balance..." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Balance validity period" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/AccountBalanceRef.schema.json b/EngagedParty/AccountBalanceRef.schema.json index aa3fa050..0cb4bab3 100644 --- a/EngagedParty/AccountBalanceRef.schema.json +++ b/EngagedParty/AccountBalanceRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountBalanceRef.schema.json", - "title": "AccountBalanceRef", - "definitions": { - "AccountBalanceRef": { - "$id": "#AccountBalanceRef", - "description": "Balances linked to the account", - "type": "object", - "properties": { - "amount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Balance amount" - }, - "status": { - "type": "string", - "description": "The condition of the account balance, such as due, paid, in arrears." - }, - "balanceType": { - "type": "string", - "description": "Type of the balance : deposit balance, disputed balance, loyalty balance, receivable balance..." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountBalanceRef.schema.json", + "title": "AccountBalanceRef", + "definitions": { + "AccountBalanceRef": { + "$id": "#AccountBalanceRef", + "description": "Balances linked to the account", + "type": "object", + "properties": { + "amount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Balance amount" + }, + "status": { + "type": "string", + "description": "The condition of the account balance, such as due, paid, in arrears." + }, + "balanceType": { + "type": "string", + "description": "Type of the balance : deposit balance, disputed balance, loyalty balance, receivable balance..." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/AccountDirectDetails.schema.json b/EngagedParty/AccountDirectDetails.schema.json index 03f76f7d..084a6152 100644 --- a/EngagedParty/AccountDirectDetails.schema.json +++ b/EngagedParty/AccountDirectDetails.schema.json @@ -1,21 +1,21 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountDirectDetails.schema.json", - "title": "AccountDirectDetails", - "definitions": { - "AccountDirectDetails": { - "$id": "#AccountDirectDetails", - "type": "object", - "properties": { - "account": { - "$ref": "AccountRef.schema.json#AccountRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountDirectDetails.schema.json", + "title": "AccountDirectDetails", + "definitions": { + "AccountDirectDetails": { + "$id": "#AccountDirectDetails", + "type": "object", + "properties": { + "account": { + "$ref": "AccountRef.schema.json#AccountRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/AccountDirectMethod.schema.json b/EngagedParty/AccountDirectMethod.schema.json index 56a4f83c..95760bb8 100644 --- a/EngagedParty/AccountDirectMethod.schema.json +++ b/EngagedParty/AccountDirectMethod.schema.json @@ -1,62 +1,62 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountDirectMethod.schema.json", - "title": "AccountDirectMethod", - "definitions": { - "AccountDirectMethod": { - "$id": "#AccountDirectMethod", - "description": "A payment method using an internal account that could be billed directly to perform the payment", - "type": "object", - "properties": { - "details": { - "$ref": "AccountRef.schema.json#AccountRef" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "AccountRef.schema.json#AccountRef" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountDirectMethod.schema.json", + "title": "AccountDirectMethod", + "definitions": { + "AccountDirectMethod": { + "$id": "#AccountDirectMethod", + "description": "A payment method using an internal account that could be billed directly to perform the payment", + "type": "object", + "properties": { + "details": { + "$ref": "AccountRef.schema.json#AccountRef" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "AccountRef.schema.json#AccountRef" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/AccountRef.schema.json b/EngagedParty/AccountRef.schema.json index 226a60d7..43a5255f 100644 --- a/EngagedParty/AccountRef.schema.json +++ b/EngagedParty/AccountRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountRef.schema.json", - "title": "AccountRef", - "definitions": { - "AccountRef": { - "$id": "#AccountRef", - "description": "Account reference. A account may be a party account or a financial account.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Detailed description of the account" - }, - "href": { - "type": "string", - "description": "Reference of the account" - }, - "id": { - "type": "string", - "description": "Unique identifier of the account" - }, - "name": { - "type": "string", - "description": "Name of the account" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountRef.schema.json", + "title": "AccountRef", + "definitions": { + "AccountRef": { + "$id": "#AccountRef", + "description": "Account reference. A account may be a party account or a financial account.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Detailed description of the account" + }, + "href": { + "type": "string", + "description": "Reference of the account" + }, + "id": { + "type": "string", + "description": "Unique identifier of the account" + }, + "name": { + "type": "string", + "description": "Name of the account" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/AccountRelationship.schema.json b/EngagedParty/AccountRelationship.schema.json index 71f81f23..ce677a9d 100644 --- a/EngagedParty/AccountRelationship.schema.json +++ b/EngagedParty/AccountRelationship.schema.json @@ -1,33 +1,33 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountRelationship.schema.json", - "title": "AccountRelationship", - "definitions": { - "AccountRelationship": { - "$id": "#AccountRelationship", - "description": "Significant connection between accounts. For instance an aggregating account for a list of shop branches each having its own billing account.", - "type": "object", - "required": [ - "relationshipType" - ], - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of relationship" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Validity period of that relationship" - }, - "account": { - "$ref": "AccountRef.schema.json#AccountRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountRelationship.schema.json", + "title": "AccountRelationship", + "definitions": { + "AccountRelationship": { + "$id": "#AccountRelationship", + "description": "Significant connection between accounts. For instance an aggregating account for a list of shop branches each having its own billing account.", + "type": "object", + "required": [ + "relationshipType" + ], + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of relationship" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Validity period of that relationship" + }, + "account": { + "$ref": "AccountRef.schema.json#AccountRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/AccountTaxExemption.schema.json b/EngagedParty/AccountTaxExemption.schema.json index 1d74fe39..0fff03bb 100644 --- a/EngagedParty/AccountTaxExemption.schema.json +++ b/EngagedParty/AccountTaxExemption.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountTaxExemption.schema.json", - "title": "AccountTaxExemption", - "definitions": { - "AccountTaxExemption": { - "$id": "#AccountTaxExemption", - "description": "Proof of freedom from taxes imposed by a taxing jurisdiction", - "type": "object", - "required": [ - "issuingJurisdiction", - "validFor" - ], - "properties": { - "certificateNumber": { - "type": "string", - "description": "Identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction" - }, - "issuingJurisdiction": { - "type": "string", - "description": "Name of the taxing jurisdiction for which taxes are exempt" - }, - "reason": { - "type": "string", - "description": "Reason of the tax exemption" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Period for which the exemption is valid" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountTaxExemption.schema.json", + "title": "AccountTaxExemption", + "definitions": { + "AccountTaxExemption": { + "$id": "#AccountTaxExemption", + "description": "Proof of freedom from taxes imposed by a taxing jurisdiction", + "type": "object", + "required": [ + "issuingJurisdiction", + "validFor" + ], + "properties": { + "certificateNumber": { + "type": "string", + "description": "Identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction" + }, + "issuingJurisdiction": { + "type": "string", + "description": "Name of the taxing jurisdiction for which taxes are exempt" + }, + "reason": { + "type": "string", + "description": "Reason of the tax exemption" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Period for which the exemption is valid" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/Agreement.schema.json b/EngagedParty/Agreement.schema.json index 95dd38b2..f5562f6e 100644 --- a/EngagedParty/Agreement.schema.json +++ b/EngagedParty/Agreement.schema.json @@ -1,108 +1,108 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Agreement.schema.json", - "title": "Agreement", - "definitions": { - "Agreement": { - "$id": "#Agreement", - "description": "An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", - "type": "object", - "required": [ - "name", - "agreementType", - "engagedPartyRole", - "agreementItem" - ], - "properties": { - "agreementPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The time period during which the Agreement is in effect." - }, - "completionDate": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date at which the agreement is completed" - }, - "description": { - "type": "string", - "description": "Narrative that explains the agreement and details about the it , such as why the agreement is taking place." - }, - "documentNumber": { - "type": "integer", - "description": "A reference number assigned to an Agreement that follows a prescribed numbering system." - }, - "href": { - "type": "string", - "description": "Unique url identifying the agreement as a resource" - }, - "id": { - "type": "string", - "description": "Unique identifier for the agreement" - }, - "initialDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the agreement was initialized" - }, - "name": { - "type": "string", - "description": "A human-readable name for the agreement" - }, - "statementOfIntent": { - "type": "string", - "description": "An overview and goals of the Agreement" - }, - "status": { - "type": "string", - "description": "The current status of the agreement. Typical values are: in process, approved and rejected" - }, - "agreementType": { - "type": "string", - "description": "The type of the agreement. For example commercial" - }, - "version": { - "type": "string", - "description": "A string identifying the version of the agreement" - }, - "agreementSpecification": { - "$ref": "AgreementSpecificationRef.schema.json#AgreementSpecificationRef" - }, - "agreementItem": { - "type": "array", - "items": { - "$ref": "AgreementItem.schema.json#AgreementItem" - }, - "minItems": 1 - }, - "engagedPartyRole": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "agreementAuthorization": { - "type": "array", - "items": { - "$ref": "AgreementAuthorization.schema.json#AgreementAuthorization" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - } - }, - "associatedAgreement": { - "type": "array", - "items": { - "$ref": "AgreementRef.schema.json#AgreementRef" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Agreement.schema.json", + "title": "Agreement", + "definitions": { + "Agreement": { + "$id": "#Agreement", + "description": "An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", + "type": "object", + "required": [ + "name", + "agreementType", + "engagedPartyRole", + "agreementItem" + ], + "properties": { + "agreementPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The time period during which the Agreement is in effect." + }, + "completionDate": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date at which the agreement is completed" + }, + "description": { + "type": "string", + "description": "Narrative that explains the agreement and details about the it , such as why the agreement is taking place." + }, + "documentNumber": { + "type": "integer", + "description": "A reference number assigned to an Agreement that follows a prescribed numbering system." + }, + "href": { + "type": "string", + "description": "Unique url identifying the agreement as a resource" + }, + "id": { + "type": "string", + "description": "Unique identifier for the agreement" + }, + "initialDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the agreement was initialized" + }, + "name": { + "type": "string", + "description": "A human-readable name for the agreement" + }, + "statementOfIntent": { + "type": "string", + "description": "An overview and goals of the Agreement" + }, + "status": { + "type": "string", + "description": "The current status of the agreement. Typical values are: in process, approved and rejected" + }, + "agreementType": { + "type": "string", + "description": "The type of the agreement. For example commercial" + }, + "version": { + "type": "string", + "description": "A string identifying the version of the agreement" + }, + "agreementSpecification": { + "$ref": "AgreementSpecificationRef.schema.json#AgreementSpecificationRef" + }, + "agreementItem": { + "type": "array", + "items": { + "$ref": "AgreementItem.schema.json#AgreementItem" + }, + "minItems": 1 + }, + "engagedPartyRole": { + "type": "array", + "items": { + "$ref": "RelatedParty.schema.json#RelatedParty" + } + }, + "agreementAuthorization": { + "type": "array", + "items": { + "$ref": "AgreementAuthorization.schema.json#AgreementAuthorization" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "associatedAgreement": { + "type": "array", + "items": { + "$ref": "AgreementRef.schema.json#AgreementRef" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/AgreementAttachment.schema.json b/EngagedParty/AgreementAttachment.schema.json index be3554c3..5de6ee64 100644 --- a/EngagedParty/AgreementAttachment.schema.json +++ b/EngagedParty/AgreementAttachment.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementAttachment.schema.json", - "title": "AgreementAttachment", - "definitions": { - "AgreementAttachment": { - "$id": "#AgreementAttachment", - "description": "Represents a complementary piece of information to describe the agreement. Could be a document, picture, a video or any kind of multimedia content.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the attachment" - }, - "id": { - "type": "string", - "description": "Unique identifier of the attachment" - }, - "attachmentType": { - "type": "string", - "description": "The type of attachment, such as video, picture" - }, - "url": { - "type": "string", - "format": "uri", - "description": "Uniform Resource Locator, is a web page address (a subset of URI)" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementAttachment.schema.json", + "title": "AgreementAttachment", + "definitions": { + "AgreementAttachment": { + "$id": "#AgreementAttachment", + "description": "Represents a complementary piece of information to describe the agreement. Could be a document, picture, a video or any kind of multimedia content.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the attachment" + }, + "id": { + "type": "string", + "description": "Unique identifier of the attachment" + }, + "attachmentType": { + "type": "string", + "description": "The type of attachment, such as video, picture" + }, + "url": { + "type": "string", + "format": "uri", + "description": "Uniform Resource Locator, is a web page address (a subset of URI)" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/AgreementAuthorization.schema.json b/EngagedParty/AgreementAuthorization.schema.json index feca623c..4e54b742 100644 --- a/EngagedParty/AgreementAuthorization.schema.json +++ b/EngagedParty/AgreementAuthorization.schema.json @@ -1,32 +1,32 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementAuthorization.schema.json", - "title": "AgreementAuthorization", - "definitions": { - "AgreementAuthorization": { - "$id": "#AgreementAuthorization", - "description": "A business participant that is responsible for approving the agreement.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time", - "description": "The date associated with the authorization state." - }, - "signatureRepresentation": { - "type": "string", - "description": "Indication that represents whether the signature is a physical paper signature or a digital signature." - }, - "state": { - "type": "string", - "description": "Current status of the authorization, for example in process, approved, rejected." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementAuthorization.schema.json", + "title": "AgreementAuthorization", + "definitions": { + "AgreementAuthorization": { + "$id": "#AgreementAuthorization", + "description": "A business participant that is responsible for approving the agreement.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "The date associated with the authorization state." + }, + "signatureRepresentation": { + "type": "string", + "description": "Indication that represents whether the signature is a physical paper signature or a digital signature." + }, + "state": { + "type": "string", + "description": "Current status of the authorization, for example in process, approved, rejected." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/AgreementItem.schema.json b/EngagedParty/AgreementItem.schema.json index 29959505..510ac476 100644 --- a/EngagedParty/AgreementItem.schema.json +++ b/EngagedParty/AgreementItem.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementItem.schema.json", - "title": "AgreementItem", - "definitions": { - "AgreementItem": { - "$id": "#AgreementItem", - "description": "A part of the agreement expressed in terms of a product offering and possibly including specific terms and conditions.", - "type": "object", - "properties": { - "productOffering": { - "type": "array", - "items": { - "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" - } - }, - "termOrCondition": { - "type": "array", - "items": { - "$ref": "AgreementTermOrCondition.schema.json#AgreementTermOrCondition" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementItem.schema.json", + "title": "AgreementItem", + "definitions": { + "AgreementItem": { + "$id": "#AgreementItem", + "description": "A part of the agreement expressed in terms of a product offering and possibly including specific terms and conditions.", + "type": "object", + "properties": { + "productOffering": { + "type": "array", + "items": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + } + }, + "termOrCondition": { + "type": "array", + "items": { + "$ref": "AgreementTermOrCondition.schema.json#AgreementTermOrCondition" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/AgreementItemRef.schema.json b/EngagedParty/AgreementItemRef.schema.json index 9c719156..c9c378fd 100644 --- a/EngagedParty/AgreementItemRef.schema.json +++ b/EngagedParty/AgreementItemRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementItemRef.schema.json", - "title": "AgreementItemRef", - "definitions": { - "AgreementItemRef": { - "$id": "#AgreementItemRef", - "description": "Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", - "type": "object", - "properties": { - "agreementItemId": { - "type": "string", - "description": "Identifier of the agreement" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementItemRef.schema.json", + "title": "AgreementItemRef", + "definitions": { + "AgreementItemRef": { + "$id": "#AgreementItemRef", + "description": "Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", + "type": "object", + "properties": { + "agreementItemId": { + "type": "string", + "description": "Identifier of the agreement" + } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/AgreementRef.schema.json b/EngagedParty/AgreementRef.schema.json index ba52468b..b819cd45 100644 --- a/EngagedParty/AgreementRef.schema.json +++ b/EngagedParty/AgreementRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementRef.schema.json", - "title": "AgreementRef", - "definitions": { - "AgreementRef": { - "$id": "#AgreementRef", - "description": "Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the agreement" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementRef.schema.json", + "title": "AgreementRef", + "definitions": { + "AgreementRef": { + "$id": "#AgreementRef", + "description": "Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the agreement" + } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/AgreementSpecCharacteristic.schema.json b/EngagedParty/AgreementSpecCharacteristic.schema.json index 239abf1d..2c3a664c 100644 --- a/EngagedParty/AgreementSpecCharacteristic.schema.json +++ b/EngagedParty/AgreementSpecCharacteristic.schema.json @@ -1,45 +1,45 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementSpecCharacteristic.schema.json", - "title": "AgreementSpecCharacteristic", - "definitions": { - "AgreementSpecCharacteristic": { - "$id": "#AgreementSpecCharacteristic", - "description": "A characteristic quality or distinctive feature of an agreement.", - "type": "object", - "properties": { - "configurable": { - "type": "boolean", - "description": "If true, the Boolean indicates that the characteristic is configurable" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the characteristic is" - }, - "name": { - "type": "string", - "description": "Name of the characteristic being specified." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the specification characteristic is valid" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" - }, - "specCharacteristicValue": { - "type": "array", - "items": { - "$ref": "AgreementSpecCharacteristicValue.schema.json#AgreementSpecCharacteristicValue" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementSpecCharacteristic.schema.json", + "title": "AgreementSpecCharacteristic", + "definitions": { + "AgreementSpecCharacteristic": { + "$id": "#AgreementSpecCharacteristic", + "description": "A characteristic quality or distinctive feature of an agreement.", + "type": "object", + "properties": { + "configurable": { + "type": "boolean", + "description": "If true, the Boolean indicates that the characteristic is configurable" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the characteristic is" + }, + "name": { + "type": "string", + "description": "Name of the characteristic being specified." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the specification characteristic is valid" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" + }, + "specCharacteristicValue": { + "type": "array", + "items": { + "$ref": "AgreementSpecCharacteristicValue.schema.json#AgreementSpecCharacteristicValue" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/AgreementSpecCharacteristicValue.schema.json b/EngagedParty/AgreementSpecCharacteristicValue.schema.json index bb076f0b..79d48cb5 100644 --- a/EngagedParty/AgreementSpecCharacteristicValue.schema.json +++ b/EngagedParty/AgreementSpecCharacteristicValue.schema.json @@ -1,47 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementSpecCharacteristicValue.schema.json", - "title": "AgreementSpecCharacteristicValue", - "definitions": { - "AgreementSpecCharacteristicValue": { - "$id": "#AgreementSpecCharacteristicValue", - "description": "A number or text that can be assigned to an agreement specification characteristic.", - "type": "object", - "properties": { - "default": { - "type": "boolean", - "description": "Indicates if the value is the default value for a characteristic" - }, - "unitOfMeasure": { - "type": "string", - "description": "Unit of measure for the characteristic, such as minutes, gigabytes (GB) and so on." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period of time for which a value is applicable" - }, - "value": { - "$ref": "../Common/Any.schema.json#Any", - "description": "A discrete value that the characteristic can take on" - }, - "valueFrom": { - "type": "string", - "description": "The low range value that a characteristic can take on" - }, - "valueTo": { - "type": "string", - "description": "The upper range value that a characteristic can take on" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementSpecCharacteristicValue.schema.json", + "title": "AgreementSpecCharacteristicValue", + "definitions": { + "AgreementSpecCharacteristicValue": { + "$id": "#AgreementSpecCharacteristicValue", + "description": "A number or text that can be assigned to an agreement specification characteristic.", + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Indicates if the value is the default value for a characteristic" + }, + "unitOfMeasure": { + "type": "string", + "description": "Unit of measure for the characteristic, such as minutes, gigabytes (GB) and so on." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period of time for which a value is applicable" + }, + "value": { + "$ref": "../Common/Any.schema.json#Any", + "description": "A discrete value that the characteristic can take on" + }, + "valueFrom": { + "type": "string", + "description": "The low range value that a characteristic can take on" + }, + "valueTo": { + "type": "string", + "description": "The upper range value that a characteristic can take on" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/AgreementSpecification.schema.json b/EngagedParty/AgreementSpecification.schema.json index 26d878b1..e3115422 100644 --- a/EngagedParty/AgreementSpecification.schema.json +++ b/EngagedParty/AgreementSpecification.schema.json @@ -1,87 +1,87 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementSpecification.schema.json", - "title": "AgreementSpecification", - "definitions": { - "AgreementSpecification": { - "$id": "#AgreementSpecification", - "description": "A template of an agreement that can be used when establishing partnerships", - "type": "object", - "required": [ - "name", - "attachment" - ], - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail what the agreement specification is about" - }, - "href": { - "type": "string", - "description": "Reference of the agreement specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the agreement specification" - }, - "isBundle": { - "type": "boolean", - "description": "If true, this agreement specification is a grouping of other agreement specifications. The list of bundled agreement specifications is provided by the specificationRelationship property" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Indicates the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the agreement specification" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the agreement specification is valid" - }, - "version": { - "type": "string", - "description": "Agreement specification version" - }, - "serviceCategory": { - "$ref": "../Product/CategoryRef.schema.json#CategoryRef" - }, - "specificationCharacteristic": { - "type": "array", - "items": { - "$ref": "AgreementSpecCharacteristic.schema.json#AgreementSpecCharacteristic" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "attachment": { - "type": "array", - "items": { - "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" - } - }, - "specificationRelationship": { - "type": "array", - "items": { - "$ref": "AgreementSpecificationRelationship.schema.json#AgreementSpecificationRelationship" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementSpecification.schema.json", + "title": "AgreementSpecification", + "definitions": { + "AgreementSpecification": { + "$id": "#AgreementSpecification", + "description": "A template of an agreement that can be used when establishing partnerships", + "type": "object", + "required": [ + "name", + "attachment" + ], + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail what the agreement specification is about" + }, + "href": { + "type": "string", + "description": "Reference of the agreement specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the agreement specification" + }, + "isBundle": { + "type": "boolean", + "description": "If true, this agreement specification is a grouping of other agreement specifications. The list of bundled agreement specifications is provided by the specificationRelationship property" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Indicates the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the agreement specification" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the agreement specification is valid" + }, + "version": { + "type": "string", + "description": "Agreement specification version" + }, + "serviceCategory": { + "$ref": "../Product/CategoryRef.schema.json#CategoryRef" + }, + "specificationCharacteristic": { + "type": "array", + "items": { + "$ref": "AgreementSpecCharacteristic.schema.json#AgreementSpecCharacteristic" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "RelatedParty.schema.json#RelatedParty" + } + }, + "attachment": { + "type": "array", + "items": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + } + }, + "specificationRelationship": { + "type": "array", + "items": { + "$ref": "AgreementSpecificationRelationship.schema.json#AgreementSpecificationRelationship" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/AgreementSpecificationRef.schema.json b/EngagedParty/AgreementSpecificationRef.schema.json index 391bc37e..7f329440 100644 --- a/EngagedParty/AgreementSpecificationRef.schema.json +++ b/EngagedParty/AgreementSpecificationRef.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementSpecificationRef.schema.json", - "title": "AgreementSpecificationRef", - "definitions": { - "AgreementSpecificationRef": { - "$id": "#AgreementSpecificationRef", - "description": "AgreementSpecification reference. An AgreementSpecification represents a template of an agreement that can be used when establishing partnerships.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail what the agreement specification is about." - }, - "name": { - "type": "string", - "description": "Name of the agreement specification" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementSpecificationRef.schema.json", + "title": "AgreementSpecificationRef", + "definitions": { + "AgreementSpecificationRef": { + "$id": "#AgreementSpecificationRef", + "description": "AgreementSpecification reference. An AgreementSpecification represents a template of an agreement that can be used when establishing partnerships.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail what the agreement specification is about." + }, + "name": { + "type": "string", + "description": "Name of the agreement specification" + } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/AgreementSpecificationRelationship.schema.json b/EngagedParty/AgreementSpecificationRelationship.schema.json index 21ae1786..0b286ef5 100644 --- a/EngagedParty/AgreementSpecificationRelationship.schema.json +++ b/EngagedParty/AgreementSpecificationRelationship.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementSpecificationRelationship.schema.json", - "title": "AgreementSpecificationRelationship", - "definitions": { - "AgreementSpecificationRelationship": { - "$id": "#AgreementSpecificationRelationship", - "description": "A relationship between agreement specifications. Typical relationships are substitution and dependency.", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of relationship such as, substitution or dependency." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the relationship is valid" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementSpecificationRelationship.schema.json", + "title": "AgreementSpecificationRelationship", + "definitions": { + "AgreementSpecificationRelationship": { + "$id": "#AgreementSpecificationRelationship", + "description": "A relationship between agreement specifications. Typical relationships are substitution and dependency.", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of relationship such as, substitution or dependency." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the relationship is valid" + } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/AgreementTermOrCondition.schema.json b/EngagedParty/AgreementTermOrCondition.schema.json index 2e68c723..827763b9 100644 --- a/EngagedParty/AgreementTermOrCondition.schema.json +++ b/EngagedParty/AgreementTermOrCondition.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementTermOrCondition.schema.json", - "title": "AgreementTermOrCondition", - "definitions": { - "AgreementTermOrCondition": { - "$id": "#AgreementTermOrCondition", - "description": "Aspects of the agreement not formally specified elsewhere in the agreement and that cannot be captured elsewhere in a formal notation, or automatically monitored and require a more human level of management.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Text that explains the term or condition of the agreement." - }, - "id": { - "type": "string", - "description": "Unique number assigned for reference." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period of time during which the term or condition of the agreement applies." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementTermOrCondition.schema.json", + "title": "AgreementTermOrCondition", + "definitions": { + "AgreementTermOrCondition": { + "$id": "#AgreementTermOrCondition", + "description": "Aspects of the agreement not formally specified elsewhere in the agreement and that cannot be captured elsewhere in a formal notation, or automatically monitored and require a more human level of management.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Text that explains the term or condition of the agreement." + }, + "id": { + "type": "string", + "description": "Unique number assigned for reference." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period of time during which the term or condition of the agreement applies." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/BankAccount.schema.json b/EngagedParty/BankAccount.schema.json index 5ccb5c49..7cde1683 100644 --- a/EngagedParty/BankAccount.schema.json +++ b/EngagedParty/BankAccount.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankAccount.schema.json", - "title": "BankAccount", - "definitions": { - "BankAccount": { - "$id": "#BankAccount", - "description": "Describes the information of a bank account", - "type": "object", - "properties": { - "accountHolder": { - "type": "string", - "description": "Name of the holder of the bank account" - }, - "BIC": { - "type": "string", - "description": "Identifier of the bank according to its international code" - }, - "domiciliation": { - "type": "string", - "description": "Address of the bank agency which manages the bank account" - }, - "IBAN": { - "type": "string", - "description": "International Bank Account Number" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankAccount.schema.json", + "title": "BankAccount", + "definitions": { + "BankAccount": { + "$id": "#BankAccount", + "description": "Describes the information of a bank account", + "type": "object", + "properties": { + "accountHolder": { + "type": "string", + "description": "Name of the holder of the bank account" + }, + "BIC": { + "type": "string", + "description": "Identifier of the bank according to its international code" + }, + "domiciliation": { + "type": "string", + "description": "Address of the bank agency which manages the bank account" + }, + "IBAN": { + "type": "string", + "description": "International Bank Account Number" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/BankAccountDebitDetails.schema.json b/EngagedParty/BankAccountDebitDetails.schema.json index 8bc2840e..ec7a991f 100644 --- a/EngagedParty/BankAccountDebitDetails.schema.json +++ b/EngagedParty/BankAccountDebitDetails.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankAccountDebitDetails.schema.json", - "title": "BankAccountDebitDetails", - "definitions": { - "BankAccountDebitDetails": { - "$id": "#BankAccountDebitDetails", - "description": "Detailed information for a bank account debit. Bear in mind that this could be extended to add any required authorization fields to allow recurring payments", - "type": "object", - "properties": { - "accountNumber": { - "type": "integer", - "description": "Bank Account Number (this could refer to the IBAN or SWIFT number)" - }, - "accountNumberType": { - "type": "string", - "description": "Type of account number (e.g.: IBAN, SWIFT, ...)" - }, - "BIC": { - "type": "string", - "description": "Business Identifier Code/Swift code of the financial institution where the account is located" - }, - "blank": { - "type": "string", - "description": "Display name of the bank" - }, - "owner": { - "type": "string", - "description": "Owner of the bank account" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankAccountDebitDetails.schema.json", + "title": "BankAccountDebitDetails", + "definitions": { + "BankAccountDebitDetails": { + "$id": "#BankAccountDebitDetails", + "description": "Detailed information for a bank account debit. Bear in mind that this could be extended to add any required authorization fields to allow recurring payments", + "type": "object", + "properties": { + "accountNumber": { + "type": "integer", + "description": "Bank Account Number (this could refer to the IBAN or SWIFT number)" + }, + "accountNumberType": { + "type": "string", + "description": "Type of account number (e.g.: IBAN, SWIFT, ...)" + }, + "BIC": { + "type": "string", + "description": "Business Identifier Code/Swift code of the financial institution where the account is located" + }, + "blank": { + "type": "string", + "description": "Display name of the bank" + }, + "owner": { + "type": "string", + "description": "Owner of the bank account" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/BankAccountDebitMethod.schema.json b/EngagedParty/BankAccountDebitMethod.schema.json index 6cef1707..eae7632b 100644 --- a/EngagedParty/BankAccountDebitMethod.schema.json +++ b/EngagedParty/BankAccountDebitMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankAccountDebitMethod.schema.json", - "title": "BankAccountDebitMethod", - "definitions": { - "BankAccountDebitMethod": { - "$id": "#BankAccountDebitMethod", - "type": "object", - "properties": { - "details": { - "$ref": "BankAccountDebitDetails.schema.json#BankAccountDebitDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "AccountRef.schema.json#AccountRef" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankAccountDebitMethod.schema.json", + "title": "BankAccountDebitMethod", + "definitions": { + "BankAccountDebitMethod": { + "$id": "#BankAccountDebitMethod", + "type": "object", + "properties": { + "details": { + "$ref": "BankAccountDebitDetails.schema.json#BankAccountDebitDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "AccountRef.schema.json#AccountRef" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/BankAccountTransferDetails.schema.json b/EngagedParty/BankAccountTransferDetails.schema.json index 78772bdd..6e46e0f9 100644 --- a/EngagedParty/BankAccountTransferDetails.schema.json +++ b/EngagedParty/BankAccountTransferDetails.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankAccountTransferDetails.schema.json", - "title": "BankAccountTransferDetails", - "definitions": { - "BankAccountTransferDetails": { - "$id": "#BankAccountTransferDetails", - "description": "Detailed information for a bank account debit. Bear in mind that this could be extended to add any required authorization fields to allow recurring payments", - "type": "object", - "properties": { - "accountNumber": { - "type": "integer", - "description": "Bank Account Number (this could refer to the IBAN or SWIFT number)" - }, - "accountNumberType": { - "type": "string", - "description": "Type of account number (e.g.: IBAN, SWIFT, ...)" - }, - "BIC": { - "type": "string", - "description": "Business Identifier Code/Swift code of the financial institution where the account is located" - }, - "blank": { - "type": "string", - "description": "Display name of the bank" - }, - "owner": { - "type": "string", - "description": "Owner of the bank account" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankAccountTransferDetails.schema.json", + "title": "BankAccountTransferDetails", + "definitions": { + "BankAccountTransferDetails": { + "$id": "#BankAccountTransferDetails", + "description": "Detailed information for a bank account debit. Bear in mind that this could be extended to add any required authorization fields to allow recurring payments", + "type": "object", + "properties": { + "accountNumber": { + "type": "integer", + "description": "Bank Account Number (this could refer to the IBAN or SWIFT number)" + }, + "accountNumberType": { + "type": "string", + "description": "Type of account number (e.g.: IBAN, SWIFT, ...)" + }, + "BIC": { + "type": "string", + "description": "Business Identifier Code/Swift code of the financial institution where the account is located" + }, + "blank": { + "type": "string", + "description": "Display name of the bank" + }, + "owner": { + "type": "string", + "description": "Owner of the bank account" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/BankAccountTransferMethod.schema.json b/EngagedParty/BankAccountTransferMethod.schema.json index f9a698e7..4f68f549 100644 --- a/EngagedParty/BankAccountTransferMethod.schema.json +++ b/EngagedParty/BankAccountTransferMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankAccountTransferMethod.schema.json", - "title": "BankAccountTransferMethod", - "definitions": { - "BankAccountTransferMethod": { - "$id": "#BankAccountTransferMethod", - "type": "object", - "properties": { - "details": { - "$ref": "BankAccountTransferDetails.schema.json#BankAccountTransferDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "AccountRef.schema.json#AccountRef" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankAccountTransferMethod.schema.json", + "title": "BankAccountTransferMethod", + "definitions": { + "BankAccountTransferMethod": { + "$id": "#BankAccountTransferMethod", + "type": "object", + "properties": { + "details": { + "$ref": "BankAccountTransferDetails.schema.json#BankAccountTransferDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "AccountRef.schema.json#AccountRef" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/Contact.schema.json b/EngagedParty/Contact.schema.json index d03e8840..783ee2d0 100644 --- a/EngagedParty/Contact.schema.json +++ b/EngagedParty/Contact.schema.json @@ -1,47 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Contact.schema.json", - "title": "Contact", - "definitions": { - "Contact": { - "$id": "#Contact", - "description": "An individual or an organization used as a contact point for a given account and accessed via some contact medium.", - "type": "object", - "required": [ - "contactType" - ], - "properties": { - "contactName": { - "type": "string", - "description": "A displayable name for that contact" - }, - "contactType": { - "type": "string", - "description": "Type of contact (primary, secondary...)" - }, - "partyRoleType": { - "type": "string", - "description": "Identifies what kind of party role type is linked to the contact (a account manager...)" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Validity period of that contact" - }, - "contactMedium": { - "type": "array", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - }, - "relatedParty": { - "$ref": "RelatedParty.schema.json#RelatedParty" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Contact.schema.json", + "title": "Contact", + "definitions": { + "Contact": { + "$id": "#Contact", + "description": "An individual or an organization used as a contact point for a given account and accessed via some contact medium.", + "type": "object", + "required": [ + "contactType" + ], + "properties": { + "contactName": { + "type": "string", + "description": "A displayable name for that contact" + }, + "contactType": { + "type": "string", + "description": "Type of contact (primary, secondary...)" + }, + "partyRoleType": { + "type": "string", + "description": "Identifies what kind of party role type is linked to the contact (a account manager...)" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Validity period of that contact" + }, + "contactMedium": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "relatedParty": { + "$ref": "RelatedParty.schema.json#RelatedParty" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/FinancialAccount.schema.json b/EngagedParty/FinancialAccount.schema.json index 8bb7954e..93079d26 100644 --- a/EngagedParty/FinancialAccount.schema.json +++ b/EngagedParty/FinancialAccount.schema.json @@ -1,21 +1,21 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "FinancialAccount.schema.json", - "title": "FinancialAccount", - "definitions": { - "FinancialAccount": { - "$id": "#FinancialAccount", - "description": "An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. A financial (account receivable account/account payable) aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party. It is a specialization of entity Account.", - "type": "object", - "required": [ - "name" - ], - "properties": {}, - "allOf": [ - { - "$ref": "Account.schema.json#Account" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "FinancialAccount.schema.json", + "title": "FinancialAccount", + "definitions": { + "FinancialAccount": { + "$id": "#FinancialAccount", + "description": "An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. A financial (account receivable account/account payable) aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party. It is a specialization of entity Account.", + "type": "object", + "required": [ + "name" + ], + "properties": {}, + "allOf": [ + { + "$ref": "Account.schema.json#Account" + } + ] } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/FinancialAccountRef.schema.json b/EngagedParty/FinancialAccountRef.schema.json index 2fc552d2..6fc41c90 100644 --- a/EngagedParty/FinancialAccountRef.schema.json +++ b/EngagedParty/FinancialAccountRef.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "FinancialAccountRef.schema.json", - "title": "FinancialAccountRef", - "definitions": { - "FinancialAccountRef": { - "$id": "#FinancialAccountRef", - "description": "AccountReceivable reference. An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. An account receivable aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Unique reference of the account" - }, - "id": { - "type": "string", - "description": "Unique identifier of the account" - }, - "name": { - "type": "string", - "description": "Name of the account" - }, - "accountBalance": { - "$ref": "AccountBalance.schema.json#AccountBalance" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "FinancialAccountRef.schema.json", + "title": "FinancialAccountRef", + "definitions": { + "FinancialAccountRef": { + "$id": "#FinancialAccountRef", + "description": "AccountReceivable reference. An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. An account receivable aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Unique reference of the account" + }, + "id": { + "type": "string", + "description": "Unique identifier of the account" + }, + "name": { + "type": "string", + "description": "Name of the account" + }, + "accountBalance": { + "$ref": "AccountBalance.schema.json#AccountBalance" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/Individual.schema.json b/EngagedParty/Individual.schema.json index 5ce5026c..85fd324b 100644 --- a/EngagedParty/Individual.schema.json +++ b/EngagedParty/Individual.schema.json @@ -1,137 +1,137 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Individual.schema.json", - "title": "Individual", - "definitions": { - "Individual": { - "$id": "#Individual", - "type": "object", - "description": "Individual represents a single human being (a man, woman or child). The individual can be a customer, an employee or any other person that the organization needs to store information about.", - "properties": { - "gender": { - "type": "string", - "description": "Gender" - }, - "placeOfBirth": { - "type": "string", - "description": "Reference to the place where the individual was born" - }, - "countryOfBirth": { - "type": "string", - "description": "Country where the individual was born" - }, - "nationality": { - "type": "string", - "description": "Nationality" - }, - "maritalStatus": { - "type": "string", - "description": "Marital status (married, divorced, widow ...)" - }, - "birthDate": { - "type": "string", - "format": "date-time", - "description": "Birth date" - }, - "deathDate": { - "type": "string", - "format": "date-time", - "description": "Date of death" - }, - "title": { - "type": "string", - "description": "Useful for titles (aristocratic, social,...) Pr, Dr, Sir, ..." - }, - "aristocraticTitle": { - "type": "string", - "description": "e.g. Baron, Graf, Earl,…" - }, - "generation": { - "type": "string", - "description": "e.g.. Sr, Jr, III (the third),…" - }, - "givenName": { - "type": "string", - "description": "First name of the individual" - }, - "preferredGivenName": { - "type": "string", - "description": "Contains the chosen name by which the individual prefers to be addressed. Note: This name may be a name other than a given name, such as a nickname" - }, - "familyNamePrefix": { - "type": "string", - "description": "Family name prefix" - }, - "familyName": { - "type": "string", - "description": "Contains the non-chosen or inherited name. Also known as last name in the Western context" - }, - "legalName": { - "type": "string", - "description": "Legal name or birth name (name one has for official purposes)" - }, - "middleName": { - "type": "string", - "description": "Middles name or initial" - }, - "fullName": { - "type": "string", - "description": "Full name flatten (first, middle, and last names)" - }, - "formattedName": { - "type": "string", - "description": "A fully formatted name in one string with all of its pieces in their proper place and all of the necessary punctuation. Useful for specific contexts (Chinese, Japanese, Korean,…)" - }, - "location": { - "type": "string", - "description": "Temporary current location od the individual (may be used if the individual has approved its sharing)" - }, - "status": { - "description": "Status of the individual", - "$ref": "IndividualStateType.schema.json#IndividualStateType" - }, - "otherName": { - "type": "array", - "items": { - "$ref": "OtherNameIndividual.schema.json#OtherNameIndividual" - } - }, - "individualIdentification": { - "type": "array", - "items": { - "$ref": "IndividualIdentification.schema.json#IndividualIdentification" - } - }, - "disability": { - "type": "array", - "items": { - "$ref": "../Customer/Disability.schema.json#Disability" - } - }, - "languageAbility": { - "type": "array", - "items": { - "$ref": "LanguageAbility.schema.json#LanguageAbility" - } - }, - "skill": { - "type": "array", - "items": { - "$ref": "Skill.schema.json#Skill" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Individual.schema.json", + "title": "Individual", + "definitions": { + "Individual": { + "$id": "#Individual", + "type": "object", + "description": "Individual represents a single human being (a man, woman or child). The individual can be a customer, an employee or any other person that the organization needs to store information about.", + "properties": { + "gender": { + "type": "string", + "description": "Gender" + }, + "placeOfBirth": { + "type": "string", + "description": "Reference to the place where the individual was born" + }, + "countryOfBirth": { + "type": "string", + "description": "Country where the individual was born" + }, + "nationality": { + "type": "string", + "description": "Nationality" + }, + "maritalStatus": { + "type": "string", + "description": "Marital status (married, divorced, widow ...)" + }, + "birthDate": { + "type": "string", + "format": "date-time", + "description": "Birth date" + }, + "deathDate": { + "type": "string", + "format": "date-time", + "description": "Date of death" + }, + "title": { + "type": "string", + "description": "Useful for titles (aristocratic, social,...) Pr, Dr, Sir, ..." + }, + "aristocraticTitle": { + "type": "string", + "description": "e.g. Baron, Graf, Earl,…" + }, + "generation": { + "type": "string", + "description": "e.g.. Sr, Jr, III (the third),…" + }, + "givenName": { + "type": "string", + "description": "First name of the individual" + }, + "preferredGivenName": { + "type": "string", + "description": "Contains the chosen name by which the individual prefers to be addressed. Note: This name may be a name other than a given name, such as a nickname" + }, + "familyNamePrefix": { + "type": "string", + "description": "Family name prefix" + }, + "familyName": { + "type": "string", + "description": "Contains the non-chosen or inherited name. Also known as last name in the Western context" + }, + "legalName": { + "type": "string", + "description": "Legal name or birth name (name one has for official purposes)" + }, + "middleName": { + "type": "string", + "description": "Middles name or initial" + }, + "fullName": { + "type": "string", + "description": "Full name flatten (first, middle, and last names)" + }, + "formattedName": { + "type": "string", + "description": "A fully formatted name in one string with all of its pieces in their proper place and all of the necessary punctuation. Useful for specific contexts (Chinese, Japanese, Korean,…)" + }, + "location": { + "type": "string", + "description": "Temporary current location od the individual (may be used if the individual has approved its sharing)" + }, + "status": { + "description": "Status of the individual", + "$ref": "IndividualStateType.schema.json#IndividualStateType" + }, + "otherName": { + "type": "array", + "items": { + "$ref": "OtherNameIndividual.schema.json#OtherNameIndividual" + } + }, + "individualIdentification": { + "type": "array", + "items": { + "$ref": "IndividualIdentification.schema.json#IndividualIdentification" + } + }, + "disability": { + "type": "array", + "items": { + "$ref": "../Customer/Disability.schema.json#Disability" + } + }, + "languageAbility": { + "type": "array", + "items": { + "$ref": "LanguageAbility.schema.json#LanguageAbility" + } + }, + "skill": { + "type": "array", + "items": { + "$ref": "Skill.schema.json#Skill" + } + } + }, + "required": [ + "id" + ], + "allOf": [ + { + "$ref": "Party.schema.json#Party" + }, + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "required": [ - "id" - ], - "allOf": [ - { - "$ref": "Party.schema.json#Party" - }, - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/IndividualIdentification.schema.json b/EngagedParty/IndividualIdentification.schema.json index 1ce115d2..19a61ca3 100644 --- a/EngagedParty/IndividualIdentification.schema.json +++ b/EngagedParty/IndividualIdentification.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "IndividualIdentification.schema.json", - "title": "IndividualIdentification", - "definitions": { - "IndividualIdentification": { - "$id": "#IndividualIdentification", - "description": "Represents our registration of information used as proof of identity by an individual (passport, national identity card, drivers license, social security number, birth certificate)", - "type": "object", - "properties": { - "identificationId": { - "type": "string", - "description": "Identifier" - }, - "issuingAuthority": { - "type": "string", - "description": "Authority which has issued the identifier, such as: social security, town hall" - }, - "issuingDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the identifier was issued" - }, - "identificationType": { - "type": "string", - "description": "Identification type (passport, national identity card, drivers license, social security number, birth certificate)" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the identification information is valid." - }, - "attachment": { - "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "IndividualIdentification.schema.json", + "title": "IndividualIdentification", + "definitions": { + "IndividualIdentification": { + "$id": "#IndividualIdentification", + "description": "Represents our registration of information used as proof of identity by an individual (passport, national identity card, drivers license, social security number, birth certificate)", + "type": "object", + "properties": { + "identificationId": { + "type": "string", + "description": "Identifier" + }, + "issuingAuthority": { + "type": "string", + "description": "Authority which has issued the identifier, such as: social security, town hall" + }, + "issuingDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the identifier was issued" + }, + "identificationType": { + "type": "string", + "description": "Identification type (passport, national identity card, drivers license, social security number, birth certificate)" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the identification information is valid." + }, + "attachment": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/IndividualStateType.schema.json b/EngagedParty/IndividualStateType.schema.json index 7c77ff83..159e98c8 100644 --- a/EngagedParty/IndividualStateType.schema.json +++ b/EngagedParty/IndividualStateType.schema.json @@ -1,17 +1,17 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "IndividualStateType.schema.json", - "title": "IndividualStateType", - "definitions": { - "IndividualStateType": { - "$id": "#IndividualStateType", - "type": "string", - "description": "Valid values for the lifecycle state of the individual", - "enum": [ - "initialized", - "validated", - "deceaded" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "IndividualStateType.schema.json", + "title": "IndividualStateType", + "definitions": { + "IndividualStateType": { + "$id": "#IndividualStateType", + "type": "string", + "description": "Valid values for the lifecycle state of the individual", + "enum": [ + "initialized", + "validated", + "deceaded" + ] + } } - } } \ No newline at end of file diff --git a/EngagedParty/IssuerRef.schema.json b/EngagedParty/IssuerRef.schema.json index 87b7e2e1..afde1be9 100644 --- a/EngagedParty/IssuerRef.schema.json +++ b/EngagedParty/IssuerRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "IssuerRef.schema.json", - "title": "IssuerRef", - "definitions": { - "IssuerRef": { - "$id": "#IssuerRef", - "description": "Issuer reference. The issuer is the party role who will issue the settlement note.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the issuer" - }, - "id": { - "type": "string", - "description": "Identifier of the issuer" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "IssuerRef.schema.json", + "title": "IssuerRef", + "definitions": { + "IssuerRef": { + "$id": "#IssuerRef", + "description": "Issuer reference. The issuer is the party role who will issue the settlement note.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the issuer" + }, + "id": { + "type": "string", + "description": "Identifier of the issuer" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/LanguageAbility.schema.json b/EngagedParty/LanguageAbility.schema.json index 39fcfe20..430c7aee 100644 --- a/EngagedParty/LanguageAbility.schema.json +++ b/EngagedParty/LanguageAbility.schema.json @@ -1,50 +1,50 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LanguageAbility.schema.json", - "title": "LanguageAbility", - "definitions": { - "LanguageAbility": { - "$id": "#LanguageAbility", - "type": "object", - "description": "Ability of an individual to understand or converse in a language.", - "properties": { - "languageCode": { - "type": "string", - "description": "Language code (RFC 5646)" - }, - "languageName": { - "type": "string", - "description": "Language name" - }, - "isFavouriteLanguage": { - "type": "boolean", - "description": "A “true” value specifies whether the language is considered by the individual as his favourite one" - }, - "writingProficiency": { - "type": "string", - "description": "Writing proficiency evaluated for this language" - }, - "readingProficiency": { - "type": "string", - "description": "Reading proficiency evaluated for this language" - }, - "speakingProficiency": { - "type": "string", - "description": "Speaking proficiency evaluated for this language" - }, - "listeningProficiency": { - "type": "string", - "description": "Listening proficiency evaluated for this language" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LanguageAbility.schema.json", + "title": "LanguageAbility", + "definitions": { + "LanguageAbility": { + "$id": "#LanguageAbility", + "type": "object", + "description": "Ability of an individual to understand or converse in a language.", + "properties": { + "languageCode": { + "type": "string", + "description": "Language code (RFC 5646)" + }, + "languageName": { + "type": "string", + "description": "Language name" + }, + "isFavouriteLanguage": { + "type": "boolean", + "description": "A “true” value specifies whether the language is considered by the individual as his favourite one" + }, + "writingProficiency": { + "type": "string", + "description": "Writing proficiency evaluated for this language" + }, + "readingProficiency": { + "type": "string", + "description": "Reading proficiency evaluated for this language" + }, + "speakingProficiency": { + "type": "string", + "description": "Speaking proficiency evaluated for this language" + }, + "listeningProficiency": { + "type": "string", + "description": "Listening proficiency evaluated for this language" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/Organization.schema.json b/EngagedParty/Organization.schema.json index d633a326..14c6776d 100644 --- a/EngagedParty/Organization.schema.json +++ b/EngagedParty/Organization.schema.json @@ -1,77 +1,77 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Organization.schema.json", - "title": "Organization", - "definitions": { - "Organization": { - "$id": "#Organization", - "type": "object", - "description": "Organization represents a group of people identified by shared interests or purpose. Examples include business, department and enterprise. Because of the complex nature of many businesses, both organizations and organization units are represented by the same data.", - "properties": { - "isLegalEntity": { - "type": "boolean", - "description": "If value is true, the organization is a legal entity known by a national referential." - }, - "isHeadOffice": { - "type": "boolean", - "description": "If value is true, the organization is the head office" - }, - "organizationType": { - "type": "string", - "description": "Type of Organization (company, department...)" - }, - "tradingName": { - "type": "string", - "description": "Name that the organization (unit) trades under" - }, - "existsDuring": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - }, - "name": { - "type": "string", - "description": "Organization name (department name for example)" - }, - "nameType": { - "type": "string", - "description": "Type of the name : Co, Inc, Ltd,…" - }, - "status": { - "description": "Status of the organization", - "$ref": "OrganizationStateType.schema.json#OrganizationStateType" - }, - "otherName": { - "type": "array", - "items": { - "$ref": "OtherNameOrganization.schema.json#OtherNameOrganization" - } - }, - "organizationIdentification": { - "type": "array", - "items": { - "$ref": "OrganizationIdentification.schema.json#OrganizationIdentification" - } - }, - "organizationChildRelationship": { - "type": "array", - "items": { - "$ref": "OrganizationChildRelationship.schema.json#OrganizationChildRelationship" - } - }, - "organizationParentRelationship": { - "$ref": "OrganizationParentRelationship.schema.json#OrganizationParentRelationship" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Organization.schema.json", + "title": "Organization", + "definitions": { + "Organization": { + "$id": "#Organization", + "type": "object", + "description": "Organization represents a group of people identified by shared interests or purpose. Examples include business, department and enterprise. Because of the complex nature of many businesses, both organizations and organization units are represented by the same data.", + "properties": { + "isLegalEntity": { + "type": "boolean", + "description": "If value is true, the organization is a legal entity known by a national referential." + }, + "isHeadOffice": { + "type": "boolean", + "description": "If value is true, the organization is the head office" + }, + "organizationType": { + "type": "string", + "description": "Type of Organization (company, department...)" + }, + "tradingName": { + "type": "string", + "description": "Name that the organization (unit) trades under" + }, + "existsDuring": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + }, + "name": { + "type": "string", + "description": "Organization name (department name for example)" + }, + "nameType": { + "type": "string", + "description": "Type of the name : Co, Inc, Ltd,…" + }, + "status": { + "description": "Status of the organization", + "$ref": "OrganizationStateType.schema.json#OrganizationStateType" + }, + "otherName": { + "type": "array", + "items": { + "$ref": "OtherNameOrganization.schema.json#OtherNameOrganization" + } + }, + "organizationIdentification": { + "type": "array", + "items": { + "$ref": "OrganizationIdentification.schema.json#OrganizationIdentification" + } + }, + "organizationChildRelationship": { + "type": "array", + "items": { + "$ref": "OrganizationChildRelationship.schema.json#OrganizationChildRelationship" + } + }, + "organizationParentRelationship": { + "$ref": "OrganizationParentRelationship.schema.json#OrganizationParentRelationship" + } + }, + "allOf": [ + { + "$ref": "Party.schema.json#Party" + }, + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ], + "required": [ + "id" + ] } - }, - "allOf": [ - { - "$ref": "Party.schema.json#Party" - }, - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ], - "required": [ - "id" - ] } - } } \ No newline at end of file diff --git a/EngagedParty/OrganizationChildRelationship.schema.json b/EngagedParty/OrganizationChildRelationship.schema.json index a1c80af7..6f8da17a 100644 --- a/EngagedParty/OrganizationChildRelationship.schema.json +++ b/EngagedParty/OrganizationChildRelationship.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrganizationChildRelationship.schema.json", - "title": "OrganizationChildRelationship", - "definitions": { - "OrganizationChildRelationship": { - "$id": "#OrganizationChildRelationship", - "type": "object", - "description": "Child references of an organization in a structure of organizations.", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of the relationship. Could be juridical, hierarchical, geographical, functional for example." - }, - "organization": { - "$ref": "OrganizationRef.schema.json#OrganizationRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrganizationChildRelationship.schema.json", + "title": "OrganizationChildRelationship", + "definitions": { + "OrganizationChildRelationship": { + "$id": "#OrganizationChildRelationship", + "type": "object", + "description": "Child references of an organization in a structure of organizations.", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of the relationship. Could be juridical, hierarchical, geographical, functional for example." + }, + "organization": { + "$ref": "OrganizationRef.schema.json#OrganizationRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/OrganizationIdentification.schema.json b/EngagedParty/OrganizationIdentification.schema.json index a71a064d..f363456c 100644 --- a/EngagedParty/OrganizationIdentification.schema.json +++ b/EngagedParty/OrganizationIdentification.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrganizationIdentification.schema.json", - "title": "OrganizationIdentification", - "definitions": { - "OrganizationIdentification": { - "$id": "#OrganizationIdentification", - "description": "Represents our registration of information used as proof of identity by an organization", - "type": "object", - "properties": { - "identificationId": { - "type": "string", - "description": "Identifier" - }, - "issuingAuthority": { - "type": "string", - "description": "Authority which has issued the identifier (chamber of commerce...)" - }, - "issuingDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the identifier was issued" - }, - "identificationType": { - "type": "string", - "description": "Type of identification information used to identify the company in a country or internationally" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the identification information is valid." - }, - "attachment": { - "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrganizationIdentification.schema.json", + "title": "OrganizationIdentification", + "definitions": { + "OrganizationIdentification": { + "$id": "#OrganizationIdentification", + "description": "Represents our registration of information used as proof of identity by an organization", + "type": "object", + "properties": { + "identificationId": { + "type": "string", + "description": "Identifier" + }, + "issuingAuthority": { + "type": "string", + "description": "Authority which has issued the identifier (chamber of commerce...)" + }, + "issuingDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the identifier was issued" + }, + "identificationType": { + "type": "string", + "description": "Type of identification information used to identify the company in a country or internationally" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the identification information is valid." + }, + "attachment": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/OrganizationParentRelationship.schema.json b/EngagedParty/OrganizationParentRelationship.schema.json index babb4b1f..540c0ee7 100644 --- a/EngagedParty/OrganizationParentRelationship.schema.json +++ b/EngagedParty/OrganizationParentRelationship.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrganizationParentRelationship.schema.json", - "title": "OrganizationParentRelationship", - "definitions": { - "OrganizationParentRelationship": { - "$id": "#OrganizationParentRelationship", - "type": "object", - "description": "Parent references of an organization in a structure of organizations.", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of the relationship. Could be juridical, hierarchical, geographical, functional for example." - }, - "organization": { - "$ref": "OrganizationRef.schema.json#OrganizationRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrganizationParentRelationship.schema.json", + "title": "OrganizationParentRelationship", + "definitions": { + "OrganizationParentRelationship": { + "$id": "#OrganizationParentRelationship", + "type": "object", + "description": "Parent references of an organization in a structure of organizations.", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of the relationship. Could be juridical, hierarchical, geographical, functional for example." + }, + "organization": { + "$ref": "OrganizationRef.schema.json#OrganizationRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/OrganizationRef.schema.json b/EngagedParty/OrganizationRef.schema.json index 656d342a..55288cc3 100644 --- a/EngagedParty/OrganizationRef.schema.json +++ b/EngagedParty/OrganizationRef.schema.json @@ -1,17 +1,17 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrganizationRef.schema.json", - "title": "OrganizationRef", - "definitions": { - "OrganizationRef": { - "$id": "#OrganizationRef", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrganizationRef.schema.json", + "title": "OrganizationRef", + "definitions": { + "OrganizationRef": { + "$id": "#OrganizationRef", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/OrganizationStateType.schema.json b/EngagedParty/OrganizationStateType.schema.json index 8178009b..45c46147 100644 --- a/EngagedParty/OrganizationStateType.schema.json +++ b/EngagedParty/OrganizationStateType.schema.json @@ -1,17 +1,17 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrganizationStateType.schema.json", - "title": "OrganizationStateType", - "definitions": { - "OrganizationStateType": { - "$id": "#OrganizationStateType", - "type": "string", - "description": "Valid values for the lifecycle state of the organization", - "enum": [ - "initialized", - "validated", - "closed" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrganizationStateType.schema.json", + "title": "OrganizationStateType", + "definitions": { + "OrganizationStateType": { + "$id": "#OrganizationStateType", + "type": "string", + "description": "Valid values for the lifecycle state of the organization", + "enum": [ + "initialized", + "validated", + "closed" + ] + } } - } } \ No newline at end of file diff --git a/EngagedParty/OtherName.schema.json b/EngagedParty/OtherName.schema.json index abbbb33a..ad3d632b 100644 --- a/EngagedParty/OtherName.schema.json +++ b/EngagedParty/OtherName.schema.json @@ -1,55 +1,55 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OtherName.schema.json", - "title": "OtherName", - "definitions": { - "OtherName": { - "$id": "#OtherName", - "description": "To keep track of other names (for example the old name of a woman before marriage or an artist name)", - "type": "object", - "properties": { - "familyName": { - "type": "string", - "description": "Last name" - }, - "formattedName": { - "type": "string", - "description": "A formatted name useful for specific contexts (chinese, japanese, korean...)" - }, - "fullName": { - "type": "string", - "description": "Full name flatten (first, middle, and last name)" - }, - "givenName": { - "type": "string", - "description": "First name" - }, - "middleName": { - "type": "string", - "description": "Middle name" - }, - "nameType": { - "type": "string", - "description": "Co., Inc., Ltd., Plc., Gmbh." - }, - "title": { - "type": "string", - "description": "useful for titles (aristocratic, social...) Dr, Pr, Sir..." - }, - "tradingName": { - "type": "string", - "description": "The name that the organization trades under" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the other name is valid" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OtherName.schema.json", + "title": "OtherName", + "definitions": { + "OtherName": { + "$id": "#OtherName", + "description": "To keep track of other names (for example the old name of a woman before marriage or an artist name)", + "type": "object", + "properties": { + "familyName": { + "type": "string", + "description": "Last name" + }, + "formattedName": { + "type": "string", + "description": "A formatted name useful for specific contexts (chinese, japanese, korean...)" + }, + "fullName": { + "type": "string", + "description": "Full name flatten (first, middle, and last name)" + }, + "givenName": { + "type": "string", + "description": "First name" + }, + "middleName": { + "type": "string", + "description": "Middle name" + }, + "nameType": { + "type": "string", + "description": "Co., Inc., Ltd., Plc., Gmbh." + }, + "title": { + "type": "string", + "description": "useful for titles (aristocratic, social...) Dr, Pr, Sir..." + }, + "tradingName": { + "type": "string", + "description": "The name that the organization trades under" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the other name is valid" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/OtherNameIndividual.schema.json b/EngagedParty/OtherNameIndividual.schema.json index 408fdb9e..84d2e806 100644 --- a/EngagedParty/OtherNameIndividual.schema.json +++ b/EngagedParty/OtherNameIndividual.schema.json @@ -1,66 +1,66 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OtherNameIndividual.schema.json", - "title": "OtherNameIndividual", - "definitions": { - "OtherNameIndividual": { - "$id": "#OtherNameIndividual", - "type": "object", - "description": "Keeps track of other names, for example the old name of a woman before marriage or an artist name.", - "properties": { - "title": { - "type": "string", - "description": "Use for titles (aristrocatic, social, ...): Pr, Dr, Sir,...." - }, - "aristocraticTitle": { - "type": "string", - "description": "e.g. Baron, Graf, Earl,…" - }, - "generation": { - "type": "string", - "description": "e.g. Sr, Jr…" - }, - "givenName": { - "type": "string", - "description": "First name" - }, - "preferredGivenName": { - "type": "string", - "description": "Contains the chosen name by which the person prefers to be addressed. Note: This name may be a name other than a given name, such as a nickname" - }, - "familyNamePrefix": { - "type": "string", - "description": "Family name prefix" - }, - "familyName": { - "type": "string", - "description": "Contains the non-chosen or inherited name. Also known as last name in the Western context" - }, - "legalName": { - "type": "string", - "description": "Legal name or birth name (name one has for official purposes)" - }, - "middleName": { - "type": "string", - "description": "Middle name or initial" - }, - "fullName": { - "type": "string", - "description": "Full name flatten (first, middle, and last names)" - }, - "formattedName": { - "type": "string", - "description": ". A fully formatted name in one string with all of its pieces in their proper place and all of the necessary punctuation. Useful for specific contexts (Chinese, Japanese, Korean,…)" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OtherNameIndividual.schema.json", + "title": "OtherNameIndividual", + "definitions": { + "OtherNameIndividual": { + "$id": "#OtherNameIndividual", + "type": "object", + "description": "Keeps track of other names, for example the old name of a woman before marriage or an artist name.", + "properties": { + "title": { + "type": "string", + "description": "Use for titles (aristrocatic, social, ...): Pr, Dr, Sir,...." + }, + "aristocraticTitle": { + "type": "string", + "description": "e.g. Baron, Graf, Earl,…" + }, + "generation": { + "type": "string", + "description": "e.g. Sr, Jr…" + }, + "givenName": { + "type": "string", + "description": "First name" + }, + "preferredGivenName": { + "type": "string", + "description": "Contains the chosen name by which the person prefers to be addressed. Note: This name may be a name other than a given name, such as a nickname" + }, + "familyNamePrefix": { + "type": "string", + "description": "Family name prefix" + }, + "familyName": { + "type": "string", + "description": "Contains the non-chosen or inherited name. Also known as last name in the Western context" + }, + "legalName": { + "type": "string", + "description": "Legal name or birth name (name one has for official purposes)" + }, + "middleName": { + "type": "string", + "description": "Middle name or initial" + }, + "fullName": { + "type": "string", + "description": "Full name flatten (first, middle, and last names)" + }, + "formattedName": { + "type": "string", + "description": ". A fully formatted name in one string with all of its pieces in their proper place and all of the necessary punctuation. Useful for specific contexts (Chinese, Japanese, Korean,…)" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/OtherNameOrganization.schema.json b/EngagedParty/OtherNameOrganization.schema.json index eea9579f..ff5cc089 100644 --- a/EngagedParty/OtherNameOrganization.schema.json +++ b/EngagedParty/OtherNameOrganization.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OtherNameOrganization.schema.json", - "title": "OtherNameOrganization", - "definitions": { - "OtherNameOrganization": { - "$id": "#OtherNameOrganization", - "type": "object", - "description": "Keeps track of other names, for example the old name of an organization.", - "properties": { - "tradingName": { - "type": "string", - "description": "The name that the organization trades under" - }, - "nameType": { - "type": "string", - "description": "Co. , Inc. , Ltd. , Pty Ltd. , Plc; , Gmbh" - }, - "name": { - "type": "string", - "description": "Organization name (department name for example)" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OtherNameOrganization.schema.json", + "title": "OtherNameOrganization", + "definitions": { + "OtherNameOrganization": { + "$id": "#OtherNameOrganization", + "type": "object", + "description": "Keeps track of other names, for example the old name of an organization.", + "properties": { + "tradingName": { + "type": "string", + "description": "The name that the organization trades under" + }, + "nameType": { + "type": "string", + "description": "Co. , Inc. , Ltd. , Pty Ltd. , Plc; , Gmbh" + }, + "name": { + "type": "string", + "description": "Organization name (department name for example)" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/PartnershipType.schema.json b/EngagedParty/PartnershipType.schema.json index 07bf6bfc..6af57030 100644 --- a/EngagedParty/PartnershipType.schema.json +++ b/EngagedParty/PartnershipType.schema.json @@ -1,44 +1,44 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartnershipType.schema.json", - "title": "PartnershipType", - "definitions": { - "PartnershipType": { - "$id": "#PartnershipType", - "description": "A partnership type contains all the information for the setup of a partnership of a given kind. This includes the list of identified role types for the partnership with the corresponding agreement specifications.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "description": { - "type": "string", - "description": "An explanatory text regarding this partnership type" - }, - "href": { - "type": "string", - "description": "The reference url for this partnership type" - }, - "id": { - "type": "string", - "description": "The identifier of the partnership type" - }, - "name": { - "type": "string", - "description": "An identifying name for the partnership type." - }, - "roleType": { - "type": "array", - "items": { - "$ref": "RoleType.schema.json#RoleType" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartnershipType.schema.json", + "title": "PartnershipType", + "definitions": { + "PartnershipType": { + "$id": "#PartnershipType", + "description": "A partnership type contains all the information for the setup of a partnership of a given kind. This includes the list of identified role types for the partnership with the corresponding agreement specifications.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "description": { + "type": "string", + "description": "An explanatory text regarding this partnership type" + }, + "href": { + "type": "string", + "description": "The reference url for this partnership type" + }, + "id": { + "type": "string", + "description": "The identifier of the partnership type" + }, + "name": { + "type": "string", + "description": "An identifying name for the partnership type." + }, + "roleType": { + "type": "array", + "items": { + "$ref": "RoleType.schema.json#RoleType" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/PartnershipTypeRef.schema.json b/EngagedParty/PartnershipTypeRef.schema.json index 3b01ddb6..47fbc746 100644 --- a/EngagedParty/PartnershipTypeRef.schema.json +++ b/EngagedParty/PartnershipTypeRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartnershipTypeRef.schema.json", - "title": "PartnershipTypeRef", - "definitions": { - "PartnershipTypeRef": { - "$id": "#PartnershipTypeRef", - "description": "PartnershipType reference. A partnership type contains all the information for the setup of a partnership of a given kind. This includes the list of identified role types for the partnership with the corresponding agreement specifications.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference url for the partnership type" - }, - "id": { - "type": "string", - "description": "Identifier of the partnership" - }, - "name": { - "type": "string", - "description": "Name of the partnership type" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartnershipTypeRef.schema.json", + "title": "PartnershipTypeRef", + "definitions": { + "PartnershipTypeRef": { + "$id": "#PartnershipTypeRef", + "description": "PartnershipType reference. A partnership type contains all the information for the setup of a partnership of a given kind. This includes the list of identified role types for the partnership with the corresponding agreement specifications.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference url for the partnership type" + }, + "id": { + "type": "string", + "description": "Identifier of the partnership" + }, + "name": { + "type": "string", + "description": "Name of the partnership type" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/Party.schema.json b/EngagedParty/Party.schema.json index 44d570bd..8d6a3f45 100644 --- a/EngagedParty/Party.schema.json +++ b/EngagedParty/Party.schema.json @@ -1,63 +1,63 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Party.schema.json", - "title": "Party", - "definitions": { - "Party": { - "$id": "#Party", - "type": "object", - "description": "Generic Party structure used to define commonalities between sub concepts of Individual and Organization.", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the organization" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the organization" - }, - "externalReference": { - "type": "array", - "items": { - "$ref": "../Common/ExternalReference.schema.json#ExternalReference" - } - }, - "partyCharacteristic": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - } - }, - "taxExemptionCertificate": { - "type": "array", - "items": { - "$ref": "TaxExemptionCertificate.schema.json#TaxExemptionCertificate" - } - }, - "creditRating": { - "type": "array", - "items": { - "$ref": "PartyCreditProfile.schema.json#PartyCreditProfile" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "contactMedium": { - "type": "array", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Party.schema.json", + "title": "Party", + "definitions": { + "Party": { + "$id": "#Party", + "type": "object", + "description": "Generic Party structure used to define commonalities between sub concepts of Individual and Organization.", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the organization" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the organization" + }, + "externalReference": { + "type": "array", + "items": { + "$ref": "../Common/ExternalReference.schema.json#ExternalReference" + } + }, + "partyCharacteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "taxExemptionCertificate": { + "type": "array", + "items": { + "$ref": "TaxExemptionCertificate.schema.json#TaxExemptionCertificate" + } + }, + "creditRating": { + "type": "array", + "items": { + "$ref": "PartyCreditProfile.schema.json#PartyCreditProfile" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "RelatedParty.schema.json#RelatedParty" + } + }, + "contactMedium": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/PartyAccount.schema.json b/EngagedParty/PartyAccount.schema.json index bd3d25f2..e38089ea 100644 --- a/EngagedParty/PartyAccount.schema.json +++ b/EngagedParty/PartyAccount.schema.json @@ -1,42 +1,42 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyAccount.schema.json", - "title": "PartyAccount", - "definitions": { - "PartyAccount": { - "$id": "#PartyAccount", - "description": "Account used for billing or for settlement purposes concerning a given party (an organization or an individual). It is a specialization of entity Account.", - "type": "object", - "required": [ - "name", - "relatedParty" - ], - "properties": { - "paymentStatus": { - "type": "string", - "description": "The condition of the account, such as due, paid, in arrears." - }, - "billStructure": { - "$ref": "../Customer/BillStructure.schema.json#BillStructure" - }, - "paymentPlan": { - "type": "array", - "items": { - "$ref": "../Customer/PaymentPlan.schema.json#PaymentPlan" - } - }, - "financialAccount": { - "$ref": "FinancialAccountRef.schema.json#FinancialAccountRef" - }, - "defaultPaymentMethod": { - "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyAccount.schema.json", + "title": "PartyAccount", + "definitions": { + "PartyAccount": { + "$id": "#PartyAccount", + "description": "Account used for billing or for settlement purposes concerning a given party (an organization or an individual). It is a specialization of entity Account.", + "type": "object", + "required": [ + "name", + "relatedParty" + ], + "properties": { + "paymentStatus": { + "type": "string", + "description": "The condition of the account, such as due, paid, in arrears." + }, + "billStructure": { + "$ref": "../Customer/BillStructure.schema.json#BillStructure" + }, + "paymentPlan": { + "type": "array", + "items": { + "$ref": "../Customer/PaymentPlan.schema.json#PaymentPlan" + } + }, + "financialAccount": { + "$ref": "FinancialAccountRef.schema.json#FinancialAccountRef" + }, + "defaultPaymentMethod": { + "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" + } + }, + "allOf": [ + { + "$ref": "Account.schema.json#Account" + } + ] } - }, - "allOf": [ - { - "$ref": "Account.schema.json#Account" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/PartyAccountRef.schema.json b/EngagedParty/PartyAccountRef.schema.json index 2d5140d5..b36791ff 100644 --- a/EngagedParty/PartyAccountRef.schema.json +++ b/EngagedParty/PartyAccountRef.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyAccountRef.schema.json", - "title": "PartyAccountRef", - "definitions": { - "PartyAccountRef": { - "$id": "#PartyAccountRef", - "description": "PartyAccount reference. A party account is an arrangement that a party has with an enterprise that provides products to the party.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Detailed description of the party account" - }, - "href": { - "type": "string", - "description": "Reference of the party account" - }, - "id": { - "type": "string", - "description": "Unique identifier of the party account" - }, - "name": { - "type": "string", - "description": "Name of the party account" - }, - "status": { - "type": "string", - "description": "The condition of the account, such as due, paid, in arrears." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyAccountRef.schema.json", + "title": "PartyAccountRef", + "definitions": { + "PartyAccountRef": { + "$id": "#PartyAccountRef", + "description": "PartyAccount reference. A party account is an arrangement that a party has with an enterprise that provides products to the party.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Detailed description of the party account" + }, + "href": { + "type": "string", + "description": "Reference of the party account" + }, + "id": { + "type": "string", + "description": "Unique identifier of the party account" + }, + "name": { + "type": "string", + "description": "Name of the party account" + }, + "status": { + "type": "string", + "description": "The condition of the account, such as due, paid, in arrears." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/PartyBill.schema.json b/EngagedParty/PartyBill.schema.json index f94d47d9..bb952f68 100644 --- a/EngagedParty/PartyBill.schema.json +++ b/EngagedParty/PartyBill.schema.json @@ -1,117 +1,117 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyBill.schema.json", - "title": "PartyBill", - "definitions": { - "PartyBill": { - "$id": "#PartyBill", - "type": "object", - "properties": { - "amountDue": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Amount due for this bill expressed in the given currency" - }, - "billDate": { - "type": "string", - "format": "date-time", - "description": "Bill date" - }, - "billingPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Billing period of the bill (used for onCycle bill only)" - }, - "billNo": { - "type": "string", - "description": "Bill reference known by the customer or the party and displayed on the bill. Could be different from the id." - }, - "category": { - "type": "string", - "description": "Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note" - }, - "href": { - "type": "string", - "description": "Bill unique reference" - }, - "id": { - "type": "string", - "description": "Bill unique identifier" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date of bill last update" - }, - "nextBillDate": { - "type": "string", - "format": "date-time", - "description": "Approximate date of the next bill production given for information (only used for onCycle bill)" - }, - "paymentDueDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the amount due should have been paid" - }, - "remainingAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Remaining amount to be paid for this bill expressed in the given currency" - }, - "runType": { - "type": "string", - "description": "onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close)" - }, - "state": { - "type": "string", - "description": "State that a bill could take during its lifecycle : New, Validated, On Hold, Sent, Partially paid or Settled" - }, - "taxExcludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Total tax excluded amount expressed in the given currency" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Total tax included amount expressed in the given" - }, - "billDocument": { - "type": "array", - "items": { - "$ref": "../Common/FileDocument.schema.json#FileDocument" - }, - "description": "Document(s) associated to the bill" - }, - "paymentItem": { - "type": "array", - "items": { - "$ref": "../Customer/PaymentItem.schema.json#PaymentItem" - }, - "description": "Payment items already lettered on this bill." - }, - "billingAccount": { - "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" - }, - "taxItem": { - "type": "array", - "items": { - "$ref": "../Customer/TaxItem.schema.json#TaxItem" - } - }, - "paymentMethod": { - "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "financialAccount": { - "$ref": "FinancialAccountRef.schema.json#FinancialAccountRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyBill.schema.json", + "title": "PartyBill", + "definitions": { + "PartyBill": { + "$id": "#PartyBill", + "type": "object", + "properties": { + "amountDue": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Amount due for this bill expressed in the given currency" + }, + "billDate": { + "type": "string", + "format": "date-time", + "description": "Bill date" + }, + "billingPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Billing period of the bill (used for onCycle bill only)" + }, + "billNo": { + "type": "string", + "description": "Bill reference known by the customer or the party and displayed on the bill. Could be different from the id." + }, + "category": { + "type": "string", + "description": "Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note" + }, + "href": { + "type": "string", + "description": "Bill unique reference" + }, + "id": { + "type": "string", + "description": "Bill unique identifier" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date of bill last update" + }, + "nextBillDate": { + "type": "string", + "format": "date-time", + "description": "Approximate date of the next bill production given for information (only used for onCycle bill)" + }, + "paymentDueDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the amount due should have been paid" + }, + "remainingAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Remaining amount to be paid for this bill expressed in the given currency" + }, + "runType": { + "type": "string", + "description": "onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close)" + }, + "state": { + "type": "string", + "description": "State that a bill could take during its lifecycle : New, Validated, On Hold, Sent, Partially paid or Settled" + }, + "taxExcludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Total tax excluded amount expressed in the given currency" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Total tax included amount expressed in the given" + }, + "billDocument": { + "type": "array", + "items": { + "$ref": "../Common/FileDocument.schema.json#FileDocument" + }, + "description": "Document(s) associated to the bill" + }, + "paymentItem": { + "type": "array", + "items": { + "$ref": "../Customer/PaymentItem.schema.json#PaymentItem" + }, + "description": "Payment items already lettered on this bill." + }, + "billingAccount": { + "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" + }, + "taxItem": { + "type": "array", + "items": { + "$ref": "../Customer/TaxItem.schema.json#TaxItem" + } + }, + "paymentMethod": { + "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "RelatedParty.schema.json#RelatedParty" + } + }, + "financialAccount": { + "$ref": "FinancialAccountRef.schema.json#FinancialAccountRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/PartyCreditProfile.schema.json b/EngagedParty/PartyCreditProfile.schema.json index 0f96bc1f..7cbdf54b 100644 --- a/EngagedParty/PartyCreditProfile.schema.json +++ b/EngagedParty/PartyCreditProfile.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyCreditProfile.schema.json", - "title": "PartyCreditProfile", - "definitions": { - "PartyCreditProfile": { - "$id": "#PartyCreditProfile", - "type": "object", - "description": "An individual might be evaluated for its worthiness and this evaluation might be based on a credit rating given by a credit agency.", - "properties": { - "creditAgencyName": { - "type": "string", - "description": "Name of the credit agency giving the score" - }, - "creditAgencyType": { - "type": "string", - "description": "Type of the credit agency giving the score" - }, - "ratingReference": { - "type": "string", - "description": "Reference corresponding to the credit rating" - }, - "ratingScore": { - "type": "integer", - "format": "int32", - "description": "A measure of a party’s creditworthiness calculated on the basis of a combination of factors such as their income and credit history" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyCreditProfile.schema.json", + "title": "PartyCreditProfile", + "definitions": { + "PartyCreditProfile": { + "$id": "#PartyCreditProfile", + "type": "object", + "description": "An individual might be evaluated for its worthiness and this evaluation might be based on a credit rating given by a credit agency.", + "properties": { + "creditAgencyName": { + "type": "string", + "description": "Name of the credit agency giving the score" + }, + "creditAgencyType": { + "type": "string", + "description": "Type of the credit agency giving the score" + }, + "ratingReference": { + "type": "string", + "description": "Reference corresponding to the credit rating" + }, + "ratingScore": { + "type": "integer", + "format": "int32", + "description": "A measure of a party’s creditworthiness calculated on the basis of a combination of factors such as their income and credit history" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/PartyOrPartyRoleRef.schema.json b/EngagedParty/PartyOrPartyRoleRef.schema.json index bbdcbfc2..cbb1f557 100644 --- a/EngagedParty/PartyOrPartyRoleRef.schema.json +++ b/EngagedParty/PartyOrPartyRoleRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyOrPartyRoleRef.schema.json", - "title": "PartyOrPartyRoleRef", - "definitions": { - "PartyOrPartyRoleRef": { - "$id": "#PartyOrPartyRoleRef", - "description": "Party reference. A party represents an organization or an individual.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Text describing the referred party" - }, - "href": { - "type": "string", - "description": "Reference of the referred party (such as a partner or any other party role)." - }, - "id": { - "type": "string", - "description": "Unique identifier of the referred party" - }, - "name": { - "type": "string", - "description": "Name of the referred party (such as a partner or any other party role)" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyOrPartyRoleRef.schema.json", + "title": "PartyOrPartyRoleRef", + "definitions": { + "PartyOrPartyRoleRef": { + "$id": "#PartyOrPartyRoleRef", + "description": "Party reference. A party represents an organization or an individual.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Text describing the referred party" + }, + "href": { + "type": "string", + "description": "Reference of the referred party (such as a partner or any other party role)." + }, + "id": { + "type": "string", + "description": "Unique identifier of the referred party" + }, + "name": { + "type": "string", + "description": "Name of the referred party (such as a partner or any other party role)" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/PartyRef.schema.json b/EngagedParty/PartyRef.schema.json index 1f4d8412..048a8cab 100644 --- a/EngagedParty/PartyRef.schema.json +++ b/EngagedParty/PartyRef.schema.json @@ -1,20 +1,20 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyRef.schema.json", - "title": "PartyRef", - "definitions": { - "PartyRef": { - "$id": "#PartyRef", - "type": "object", - "required": [ - "@referredType" - ], - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyRef.schema.json", + "title": "PartyRef", + "definitions": { + "PartyRef": { + "$id": "#PartyRef", + "type": "object", + "required": [ + "@referredType" + ], + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/PartyRole.schema.json b/EngagedParty/PartyRole.schema.json index ed2373a6..e667941d 100644 --- a/EngagedParty/PartyRole.schema.json +++ b/EngagedParty/PartyRole.schema.json @@ -1,98 +1,98 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyRole.schema.json", - "title": "PartyRole", - "definitions": { - "required": { - "0": "name", - "1": "roleType", - "$id": "#required", - "type": "object" - }, - "PartyRole": { - "$id": "#PartyRole", - "description": "The part played by a party in a given context.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Url used to reference the party role." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyRole.schema.json", + "title": "PartyRole", + "definitions": { + "required": { + "0": "name", + "1": "roleType", + "$id": "#required", + "type": "object" }, - "id": { - "type": "string", - "description": "Unique identifier for PartyRoles" - }, - "name": { - "type": "string", - "description": "A word, term, or phrase by which the PartyRole is known and distinguished from other PartyRoles." - }, - "status": { - "type": "string", - "description": "Used to track the lifecycle status of the party role." - }, - "statusReason": { - "type": "string", - "description": "A string providing an explanation on the value of the status lifecycle. For instance if the status is Rejected, statusReason will provide the reason for rejection." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The time period that the PartyRole is valid for." - }, - "engagedParty": { - "$ref": "PartyRef.schema.json#PartyRef" - }, - "roleType": { - "$ref": "RoleTypeRef.schema.json#RoleTypeRef" - }, - "account": { - "type": "array", - "items": { - "$ref": "AccountRef.schema.json#AccountRef" - } - }, - "paymentMethod": { - "type": "array", - "items": { - "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" - } - }, - "contactMedium": { - "type": "array", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - }, - "description": "Describes the characteristic of a party role." - }, - "creditProfile": { - "type": "array", - "items": { - "$ref": "../Customer/CreditProfile.schema.json#CreditProfile" - } - }, - "agreement": { - "type": "array", - "items": { - "$ref": "AgreementRef.schema.json#AgreementRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" + "PartyRole": { + "$id": "#PartyRole", + "description": "The part played by a party in a given context.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Url used to reference the party role." + }, + "id": { + "type": "string", + "description": "Unique identifier for PartyRoles" + }, + "name": { + "type": "string", + "description": "A word, term, or phrase by which the PartyRole is known and distinguished from other PartyRoles." + }, + "status": { + "type": "string", + "description": "Used to track the lifecycle status of the party role." + }, + "statusReason": { + "type": "string", + "description": "A string providing an explanation on the value of the status lifecycle. For instance if the status is Rejected, statusReason will provide the reason for rejection." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The time period that the PartyRole is valid for." + }, + "engagedParty": { + "$ref": "PartyRef.schema.json#PartyRef" + }, + "roleType": { + "$ref": "RoleTypeRef.schema.json#RoleTypeRef" + }, + "account": { + "type": "array", + "items": { + "$ref": "AccountRef.schema.json#AccountRef" + } + }, + "paymentMethod": { + "type": "array", + "items": { + "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" + } + }, + "contactMedium": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + }, + "description": "Describes the characteristic of a party role." + }, + "creditProfile": { + "type": "array", + "items": { + "$ref": "../Customer/CreditProfile.schema.json#CreditProfile" + } + }, + "agreement": { + "type": "array", + "items": { + "$ref": "AgreementRef.schema.json#AgreementRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "RelatedParty.schema.json#RelatedParty" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/PartyRoleRef.schema.json b/EngagedParty/PartyRoleRef.schema.json index 573918af..02225e14 100644 --- a/EngagedParty/PartyRoleRef.schema.json +++ b/EngagedParty/PartyRoleRef.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyRoleRef.schema.json", - "title": "PartyRoleRef", - "definitions": { - "PartyRoleRef": { - "$id": "#PartyRoleRef", - "description": "Party role reference. A party role represents the part played by a party in a given context.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product" - }, - "name": { - "type": "string", - "description": "The name of the referred party role." - }, - "partyId": { - "type": "string", - "description": "The identifier of the engaged party that is linked to the PartyRole object." - }, - "partyName": { - "type": "string", - "description": "The name of the engaged party that is linked to the PartyRole object." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyRoleRef.schema.json", + "title": "PartyRoleRef", + "definitions": { + "PartyRoleRef": { + "$id": "#PartyRoleRef", + "description": "Party role reference. A party role represents the part played by a party in a given context.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product" + }, + "name": { + "type": "string", + "description": "The name of the referred party role." + }, + "partyId": { + "type": "string", + "description": "The identifier of the engaged party that is linked to the PartyRole object." + }, + "partyName": { + "type": "string", + "description": "The name of the engaged party that is linked to the PartyRole object." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/RelatedParty.schema.json b/EngagedParty/RelatedParty.schema.json index 3bd75162..f9da6484 100644 --- a/EngagedParty/RelatedParty.schema.json +++ b/EngagedParty/RelatedParty.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedParty.schema.json", - "title": "RelatedParty", - "definitions": { - "RelatedParty": { - "$id": "#RelatedParty", - "description": "Related Entity reference. A related party defines party or party role linked to a specific entity.", - "type": "object", - "required": [ - "id", - "@referredType" - ], - "properties": { - "role": { - "type": "string", - "description": "Role played by the related party" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedParty.schema.json", + "title": "RelatedParty", + "definitions": { + "RelatedParty": { + "$id": "#RelatedParty", + "description": "Related Entity reference. A related party defines party or party role linked to a specific entity.", + "type": "object", + "required": [ + "id", + "@referredType" + ], + "properties": { + "role": { + "type": "string", + "description": "Role played by the related party" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/RelatedPartyRef.schema.json b/EngagedParty/RelatedPartyRef.schema.json index 4a844880..0ac59384 100644 --- a/EngagedParty/RelatedPartyRef.schema.json +++ b/EngagedParty/RelatedPartyRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedPartyRef.schema.json", - "title": "RelatedPartyRef", - "definitions": { - "RelatedPartyRef": { - "$id": "#RelatedPartyRef", - "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of a related party" - }, - "href": { - "type": "string", - "description": "Reference of the related party, could be a party reference or a party role reference" - }, - "name": { - "type": "string", - "description": "Name of the related party" - }, - "role": { - "type": "string", - "description": "Role of the related party." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedPartyRef.schema.json", + "title": "RelatedPartyRef", + "definitions": { + "RelatedPartyRef": { + "$id": "#RelatedPartyRef", + "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of a related party" + }, + "href": { + "type": "string", + "description": "Reference of the related party, could be a party reference or a party role reference" + }, + "name": { + "type": "string", + "description": "Name of the related party" + }, + "role": { + "type": "string", + "description": "Role of the related party." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/RelatedPartyRefOrValue.schema.json b/EngagedParty/RelatedPartyRefOrValue.schema.json index 8b3797dd..629376f1 100644 --- a/EngagedParty/RelatedPartyRefOrValue.schema.json +++ b/EngagedParty/RelatedPartyRefOrValue.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedPartyRefOrValue.schema.json", - "title": "RelatedPartyRefOrValue", - "definitions": { - "RelatedPartyRefOrValue": { - "discriminator": "isRef", - "$id": "#RelatedPartyRefOrValue", - "description": "Entity reference. A related party defines party or party role linked to a specific entity.", - "type": "object", - "properties": { - "isRef": { - "type": "boolean", - "default": true - }, - "role": { - "type": "string" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedPartyRefOrValue.schema.json", + "title": "RelatedPartyRefOrValue", + "definitions": { + "RelatedPartyRefOrValue": { + "discriminator": "isRef", + "$id": "#RelatedPartyRefOrValue", + "description": "Entity reference. A related party defines party or party role linked to a specific entity.", + "type": "object", + "properties": { + "isRef": { + "type": "boolean", + "default": true + }, + "role": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "Party.schema.json#Party" + }, + { + "$ref": "PartyRef.schema.json#PartyRef" + } + ] } - }, - "allOf": [ - { - "$ref": "Party.schema.json#Party" - }, - { - "$ref": "PartyRef.schema.json#PartyRef" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/RoleType.schema.json b/EngagedParty/RoleType.schema.json index 0d5d4122..50c0453f 100644 --- a/EngagedParty/RoleType.schema.json +++ b/EngagedParty/RoleType.schema.json @@ -1,44 +1,44 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RoleType.schema.json", - "title": "RoleType", - "definitions": { - "RoleType": { - "$id": "#RoleType", - "description": "A RoleType represents the type of a PartyRole, defined in the context of a given type of partnership, such as Buyer, Seller.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "description": { - "type": "string", - "description": "An explanatory text documenting the role type" - }, - "name": { - "type": "string", - "description": "The name of the role type." - }, - "requiresBilling": { - "type": "boolean", - "description": "Indicates whether billing operations will be associated to parties playing the role" - }, - "requiresSettlement": { - "type": "boolean", - "description": "Indicates whether settlement operations will be associated to parties playing the role" - }, - "agreementSpecification": { - "type": "array", - "items": { - "$ref": "AgreementSpecificationRef.schema.json#AgreementSpecificationRef" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RoleType.schema.json", + "title": "RoleType", + "definitions": { + "RoleType": { + "$id": "#RoleType", + "description": "A RoleType represents the type of a PartyRole, defined in the context of a given type of partnership, such as Buyer, Seller.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "description": { + "type": "string", + "description": "An explanatory text documenting the role type" + }, + "name": { + "type": "string", + "description": "The name of the role type." + }, + "requiresBilling": { + "type": "boolean", + "description": "Indicates whether billing operations will be associated to parties playing the role" + }, + "requiresSettlement": { + "type": "boolean", + "description": "Indicates whether settlement operations will be associated to parties playing the role" + }, + "agreementSpecification": { + "type": "array", + "items": { + "$ref": "AgreementSpecificationRef.schema.json#AgreementSpecificationRef" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/RoleTypeRef.schema.json b/EngagedParty/RoleTypeRef.schema.json index 61ddff5e..2972330f 100644 --- a/EngagedParty/RoleTypeRef.schema.json +++ b/EngagedParty/RoleTypeRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RoleTypeRef.schema.json", - "title": "RoleTypeRef", - "definitions": { - "RoleTypeRef": { - "$id": "#RoleTypeRef", - "description": "RoleType reference.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the role type. It uniquely identifies the role type within the partnership type." - }, - "partnershipHref": { - "type": "string", - "description": "Reference url of the partnership type containing the role type" - }, - "partnershipId": { - "type": "string", - "description": "The identifier of the partnership type containing the role type" - }, - "partnershipName": { - "type": "string", - "description": "The name of the partnership type defining this role type" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RoleTypeRef.schema.json", + "title": "RoleTypeRef", + "definitions": { + "RoleTypeRef": { + "$id": "#RoleTypeRef", + "description": "RoleType reference.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the role type. It uniquely identifies the role type within the partnership type." + }, + "partnershipHref": { + "type": "string", + "description": "Reference url of the partnership type containing the role type" + }, + "partnershipId": { + "type": "string", + "description": "The identifier of the partnership type containing the role type" + }, + "partnershipName": { + "type": "string", + "description": "The name of the partnership type defining this role type" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/Rule.schema.json b/EngagedParty/Rule.schema.json index 882f9dc9..0fb3a4ca 100644 --- a/EngagedParty/Rule.schema.json +++ b/EngagedParty/Rule.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Rule.schema.json", - "title": "Rule", - "definitions": { - "Rule": { - "$id": "#Rule", - "type": "object", - "properties": { - "consequence": { - "type": "string" - }, - "id": { - "type": "string" - }, - "metric": { - "type": "string" - }, - "operator": { - "type": "string" - }, - "referenceValue": { - "type": "string" - }, - "tolerance": { - "type": "string" - }, - "unit": { - "type": "string" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Rule.schema.json", + "title": "Rule", + "definitions": { + "Rule": { + "$id": "#Rule", + "type": "object", + "properties": { + "consequence": { + "type": "string" + }, + "id": { + "type": "string" + }, + "metric": { + "type": "string" + }, + "operator": { + "type": "string" + }, + "referenceValue": { + "type": "string" + }, + "tolerance": { + "type": "string" + }, + "unit": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/RuleRef.schema.json b/EngagedParty/RuleRef.schema.json index ac6732d6..4335827f 100644 --- a/EngagedParty/RuleRef.schema.json +++ b/EngagedParty/RuleRef.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RuleRef.schema.json", - "title": "RuleRef", - "definitions": { - "RuleRef": { - "$id": "#RuleRef", - "description": "Rule reference. Rule is a common pattern or Template for the SLA parameters, metrics, and thresholds", - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "href": { - "type": "string", - "description": "The reference of the rule" - }, - "id": { - "type": "string", - "description": "The identifier of the referred rule" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RuleRef.schema.json", + "title": "RuleRef", + "definitions": { + "RuleRef": { + "$id": "#RuleRef", + "description": "Rule reference. Rule is a common pattern or Template for the SLA parameters, metrics, and thresholds", + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "href": { + "type": "string", + "description": "The reference of the rule" + }, + "id": { + "type": "string", + "description": "The identifier of the referred rule" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/SLA.schema.json b/EngagedParty/SLA.schema.json index 6b48dfbc..9842555d 100644 --- a/EngagedParty/SLA.schema.json +++ b/EngagedParty/SLA.schema.json @@ -1,69 +1,69 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SLA.schema.json", - "title": "SLA", - "definitions": { - "SLA": { - "$id": "#SLA", - "description": "Part of a business agreement between a Service Provider and a Customer, quantitatively specifying the service performance level the Service Provider commits to deliver.", - "type": "object", - "properties": { - "approvalDate": { - "type": "string", - "format": "date-time" - }, - "approved": { - "type": "boolean" - }, - "description": { - "type": "string", - "description": "Description of the Service Level Agreement (SLA)" - }, - "href": { - "type": "string", - "description": "Reference of the Service Level Agreement (SLA)" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Service Level Agreement (SLA)" - }, - "name": { - "type": "string", - "description": "Name of the Service Level Agreement (SLA)" - }, - "state": { - "type": "string", - "description": "State of the Service Level Agreement (SLA)" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Period where the clauses of the SLA are applicable" - }, - "version": { - "type": "string", - "description": "Version of the Service Level Agreement (SLA)" - }, - "rule": { - "type": "array", - "items": { - "$ref": "Rule.schema.json#Rule" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "template": { - "$ref": "TemplateRef.schema.json#TemplateRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SLA.schema.json", + "title": "SLA", + "definitions": { + "SLA": { + "$id": "#SLA", + "description": "Part of a business agreement between a Service Provider and a Customer, quantitatively specifying the service performance level the Service Provider commits to deliver.", + "type": "object", + "properties": { + "approvalDate": { + "type": "string", + "format": "date-time" + }, + "approved": { + "type": "boolean" + }, + "description": { + "type": "string", + "description": "Description of the Service Level Agreement (SLA)" + }, + "href": { + "type": "string", + "description": "Reference of the Service Level Agreement (SLA)" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Service Level Agreement (SLA)" + }, + "name": { + "type": "string", + "description": "Name of the Service Level Agreement (SLA)" + }, + "state": { + "type": "string", + "description": "State of the Service Level Agreement (SLA)" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Period where the clauses of the SLA are applicable" + }, + "version": { + "type": "string", + "description": "Version of the Service Level Agreement (SLA)" + }, + "rule": { + "type": "array", + "items": { + "$ref": "Rule.schema.json#Rule" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "RelatedParty.schema.json#RelatedParty" + } + }, + "template": { + "$ref": "TemplateRef.schema.json#TemplateRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/SLARef.schema.json b/EngagedParty/SLARef.schema.json index a98d0877..fc2c78a1 100644 --- a/EngagedParty/SLARef.schema.json +++ b/EngagedParty/SLARef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SLARef.schema.json", - "title": "SLARef", - "definitions": { - "SLARef": { - "$id": "#SLARef", - "description": "ServiceLevelAgreement reference: A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so forth. The SLA is a set of appropriate procedures and targets formally or informally agreed between parties in order to achieve and maintain specified Quality of Service.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the service level agreement" - }, - "id": { - "type": "string", - "description": "Unique identifier of service level agreement" - }, - "name": { - "type": "string", - "description": "Name of the service level agreement" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SLARef.schema.json", + "title": "SLARef", + "definitions": { + "SLARef": { + "$id": "#SLARef", + "description": "ServiceLevelAgreement reference: A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so forth. The SLA is a set of appropriate procedures and targets formally or informally agreed between parties in order to achieve and maintain specified Quality of Service.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the service level agreement" + }, + "id": { + "type": "string", + "description": "Unique identifier of service level agreement" + }, + "name": { + "type": "string", + "description": "Name of the service level agreement" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/SLAViolation.schema.json b/EngagedParty/SLAViolation.schema.json index 0f2d484d..7e9a29ee 100644 --- a/EngagedParty/SLAViolation.schema.json +++ b/EngagedParty/SLAViolation.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SLAViolation.schema.json", - "title": "SLAViolation", - "definitions": { - "SLAViolation": { - "$id": "#SLAViolation", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "href": { - "type": "string" - }, - "id": { - "type": "string" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "violation": { - "$ref": "Violation.schema.json#Violation" - }, - "sla": { - "$ref": "SLARef.schema.json#SLARef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SLAViolation.schema.json", + "title": "SLAViolation", + "definitions": { + "SLAViolation": { + "$id": "#SLAViolation", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "href": { + "type": "string" + }, + "id": { + "type": "string" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "RelatedParty.schema.json#RelatedParty" + } + }, + "violation": { + "$ref": "Violation.schema.json#Violation" + }, + "sla": { + "$ref": "SLARef.schema.json#SLARef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/SLAViolationRef.schema.json b/EngagedParty/SLAViolationRef.schema.json index a4f90d5f..1a2b1592 100755 --- a/EngagedParty/SLAViolationRef.schema.json +++ b/EngagedParty/SLAViolationRef.schema.json @@ -1,28 +1,28 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SLAViolationRef.schema.json", - "title": "SLAViolationRef", - "definitions": { - "SLAViolationRef": { - "$id": "#SLAViolationRef", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "id": { - "type": "string" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SLAViolationRef.schema.json", + "title": "SLAViolationRef", + "definitions": { + "SLAViolationRef": { + "$id": "#SLAViolationRef", + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "id": { + "type": "string" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/SettlementAccount.schema.json b/EngagedParty/SettlementAccount.schema.json index 4fb18209..d3a0e1f6 100644 --- a/EngagedParty/SettlementAccount.schema.json +++ b/EngagedParty/SettlementAccount.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SettlementAccount.schema.json", - "title": "SettlementAccount", - "definitions": { - "SettlementAccount": { - "$id": "#SettlementAccount", - "description": "A party account used for settlement purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.", - "type": "object", - "required": [ - "name", - "relatedParty" - ], - "properties": {}, - "allOf": [ - { - "$ref": "PartyAccount.schema.json#PartyAccount" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SettlementAccount.schema.json", + "title": "SettlementAccount", + "definitions": { + "SettlementAccount": { + "$id": "#SettlementAccount", + "description": "A party account used for settlement purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.", + "type": "object", + "required": [ + "name", + "relatedParty" + ], + "properties": {}, + "allOf": [ + { + "$ref": "PartyAccount.schema.json#PartyAccount" + } + ] } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/Skill.schema.json b/EngagedParty/Skill.schema.json index 386e2a4c..6cef6d4c 100644 --- a/EngagedParty/Skill.schema.json +++ b/EngagedParty/Skill.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Skill.schema.json", - "title": "Skill", - "definitions": { - "Skill": { - "$id": "#Skill", - "type": "object", - "description": "Skills evaluated for an individual with a level and possibly with a limited validity when an obsolescence is defined (Ex: the first-aid certificate first level is limited to one year and an update training is required each year to keep the level).", - "properties": { - "skillCode": { - "type": "string", - "description": "Code of the skill" - }, - "skillName": { - "type": "string", - "description": "Name of the skill such as Java language,…" - }, - "evaluatedLevel": { - "type": "string", - "description": "Level of expertise in a skill evaluated for an individual" - }, - "comment": { - "type": "string", - "description": "A free text comment linked to the evaluation done" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Skill.schema.json", + "title": "Skill", + "definitions": { + "Skill": { + "$id": "#Skill", + "type": "object", + "description": "Skills evaluated for an individual with a level and possibly with a limited validity when an obsolescence is defined (Ex: the first-aid certificate first level is limited to one year and an update training is required each year to keep the level).", + "properties": { + "skillCode": { + "type": "string", + "description": "Code of the skill" + }, + "skillName": { + "type": "string", + "description": "Name of the skill such as Java language,…" + }, + "evaluatedLevel": { + "type": "string", + "description": "Level of expertise in a skill evaluated for an individual" + }, + "comment": { + "type": "string", + "description": "A free text comment linked to the evaluation done" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/TaxExemptionCertificate.schema.json b/EngagedParty/TaxExemptionCertificate.schema.json index fd30cea3..8b5dfbf6 100644 --- a/EngagedParty/TaxExemptionCertificate.schema.json +++ b/EngagedParty/TaxExemptionCertificate.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaxExemptionCertificate.schema.json", - "title": "TaxExemptionCertificate", - "definitions": { - "TaxExemptionCertificate": { - "$id": "#TaxExemptionCertificate", - "type": "object", - "description": "A tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the certificate of the tax exemption" - }, - "taxDefinition": { - "type": "array", - "items": { - "$ref": "../Common/TaxDefinition.schema.json#TaxDefinition" - } - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - }, - "attachment": { - "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaxExemptionCertificate.schema.json", + "title": "TaxExemptionCertificate", + "definitions": { + "TaxExemptionCertificate": { + "$id": "#TaxExemptionCertificate", + "type": "object", + "description": "A tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the certificate of the tax exemption" + }, + "taxDefinition": { + "type": "array", + "items": { + "$ref": "../Common/TaxDefinition.schema.json#TaxDefinition" + } + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + }, + "attachment": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/TemplateRef.schema.json b/EngagedParty/TemplateRef.schema.json index 84bbb1a1..4cd7f4d3 100644 --- a/EngagedParty/TemplateRef.schema.json +++ b/EngagedParty/TemplateRef.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TemplateRef.schema.json", - "title": "TemplateRef", - "definitions": { - "TemplateRef": { - "$id": "#TemplateRef", - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "href": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TemplateRef.schema.json", + "title": "TemplateRef", + "definitions": { + "TemplateRef": { + "$id": "#TemplateRef", + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "href": { + "type": "string" + }, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/EngagedParty/Violation.schema.json b/EngagedParty/Violation.schema.json index fafe78f9..2c3a4cf4 100644 --- a/EngagedParty/Violation.schema.json +++ b/EngagedParty/Violation.schema.json @@ -1,48 +1,48 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Violation.schema.json", - "title": "Violation", - "definitions": { - "Violation": { - "$id": "#Violation", - "type": "object", - "properties": { - "actualValue": { - "type": "string" - }, - "comment": { - "type": "string" - }, - "consequence": { - "type": "string" - }, - "operator": { - "type": "string" - }, - "referenceValue": { - "type": "string" - }, - "tolerance": { - "type": "string" - }, - "unit": { - "type": "string" - }, - "violationAverage": { - "type": "string" - }, - "attachment": { - "$ref": "../Common/AttachmentRef.schema.json#AttachmentRef" - }, - "rule": { - "$ref": "RuleRef.schema.json#RuleRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Violation.schema.json", + "title": "Violation", + "definitions": { + "Violation": { + "$id": "#Violation", + "type": "object", + "properties": { + "actualValue": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "consequence": { + "type": "string" + }, + "operator": { + "type": "string" + }, + "referenceValue": { + "type": "string" + }, + "tolerance": { + "type": "string" + }, + "unit": { + "type": "string" + }, + "violationAverage": { + "type": "string" + }, + "attachment": { + "$ref": "../Common/AttachmentRef.schema.json#AttachmentRef" + }, + "rule": { + "$ref": "RuleRef.schema.json#RuleRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/MarketingSales/MarketSegmentRef.schema.json b/MarketingSales/MarketSegmentRef.schema.json index adc7a77b..b16efcd9 100644 --- a/MarketingSales/MarketSegmentRef.schema.json +++ b/MarketingSales/MarketSegmentRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "MarketSegmentRef.schema.json", - "title": "MarketSegmentRef", - "definitions": { - "MarketSegmentRef": { - "$id": "#MarketSegmentRef", - "type": "object", - "description": "provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth.", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the market segment" - }, - "href": { - "type": "string", - "description": "Reference of the market segment" - }, - "name": { - "type": "string", - "description": "Name of the market segment" - }, - "@referredType": { - "type": "string", - "description": "(Class) type of the referred market segment" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "MarketSegmentRef.schema.json", + "title": "MarketSegmentRef", + "definitions": { + "MarketSegmentRef": { + "$id": "#MarketSegmentRef", + "type": "object", + "description": "provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth.", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the market segment" + }, + "href": { + "type": "string", + "description": "Reference of the market segment" + }, + "name": { + "type": "string", + "description": "Name of the market segment" + }, + "@referredType": { + "type": "string", + "description": "(Class) type of the referred market segment" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/MarketingSales/MarketingCampaignRef.schema.json b/MarketingSales/MarketingCampaignRef.schema.json index 060b6b14..c6c77ea0 100644 --- a/MarketingSales/MarketingCampaignRef.schema.json +++ b/MarketingSales/MarketingCampaignRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "MarketingCampaignRef.schema.json", - "title": "MarketingCampaignRef", - "definitions": { - "MarketingCampaignRef": { - "$id": "#MarketingCampaignRef", - "description": "MarketingCampaign reference. Marketing campaign represents the carrier-initiated marketing activity which aims at the better recognition about its brand and offerings by the market", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "MarketingCampaignRef.schema.json", + "title": "MarketingCampaignRef", + "definitions": { + "MarketingCampaignRef": { + "$id": "#MarketingCampaignRef", + "description": "MarketingCampaign reference. Marketing campaign represents the carrier-initiated marketing activity which aims at the better recognition about its brand and offerings by the market", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - ] } - } } \ No newline at end of file diff --git a/MarketingSales/SalesLead.schema.json b/MarketingSales/SalesLead.schema.json index ddcad32b..f4cfd7f6 100644 --- a/MarketingSales/SalesLead.schema.json +++ b/MarketingSales/SalesLead.schema.json @@ -1,120 +1,120 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SalesLead.schema.json", - "title": "SalesLead", - "definitions": { - "SalesLead": { - "$id": "#SalesLead", - "description": "A Sales Lead is the identification of a person or organization that has an interest in the goods and/or services provided in the prospect of them becoming Customers with one or more Subscriptions.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the salesLead" - }, - "id": { - "type": "string", - "description": "Unique identifier of the salesLead" - }, - "name": { - "type": "string", - "description": "Name of the salesLead" - }, - "description": { - "type": "string", - "description": "Unique description of the salesLead" - }, - "status": { - "$ref": "SalesLeadStateType.schema.json#/definitions/SalesLeadStateType" - }, - "statusChangeDate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the salesLead creation" - }, - "referredDate": { - "type": "string", - "format": "date-time", - "description": "Date when the prospect information was received (for example, from a trade show)." - }, - "statusChangeReason": { - "type": "string", - "description": "Reason why the status has changed" - }, - "type": { - "type": "string", - "description": "Indicates the nature of the salesLead" - }, - "rating": { - "type": "string", - "description": "Identifies the potential of a salesLead for becoming a sale. Usual ratings for qualified leads are: hot, warm, cold." - }, - "priority": { - "$ref": "SalesLeadPriorityType.schema.json#/definitions/SalesLeadPriorityType" - }, - "estimatedRevenue": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Estimation of the revenue if the salesLead turns into a sale." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the salesLead is valid" - }, - "marketingCampaign": { - "$ref": "MarketingCampaignRef.schema.json#MarketingCampaignRef", - "description": "Campaign represents the carrier-initiated marketing activity which aims at the better recognition about its brand and offerings by the market." - }, - "marketSegment": { - "$ref": "MarketSegmentRef.schema.json#MarketSegmentRef", - "description": "MarketSegment reference. A Market Segment is a grouping of Parties, GeographicAreas, SalesChannels, and so forth. MarketSegments are the target of MarketingCampaigns, ProductOfferings, ProductPromotions, ProductPlacements, and ProductPrograms from both internal and external (Competitors, and other Providers) perspective." - }, - "channel": { - "$ref": "../Common/ChannelRef.schema.json#ChannelRef" - }, - "productOffering": { - "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "prospectContact": { - "type": "array", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - }, - "productSpecification": { - "$ref": "../Product/ProductSpecificationRef.schema.json#ProductSpecificationRef" - }, - "category": { - "$ref": "../Product/CategoryRef.schema.json#CategoryRef" - }, - "salesOpportunity": { - "$ref": "SalesOpportunityRef.schema.json#SalesOpportunityRef" - }, - "product": { - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SalesLead.schema.json", + "title": "SalesLead", + "definitions": { + "SalesLead": { + "$id": "#SalesLead", + "description": "A Sales Lead is the identification of a person or organization that has an interest in the goods and/or services provided in the prospect of them becoming Customers with one or more Subscriptions.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the salesLead" + }, + "id": { + "type": "string", + "description": "Unique identifier of the salesLead" + }, + "name": { + "type": "string", + "description": "Name of the salesLead" + }, + "description": { + "type": "string", + "description": "Unique description of the salesLead" + }, + "status": { + "$ref": "SalesLeadStateType.schema.json#/definitions/SalesLeadStateType" + }, + "statusChangeDate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the salesLead creation" + }, + "referredDate": { + "type": "string", + "format": "date-time", + "description": "Date when the prospect information was received (for example, from a trade show)." + }, + "statusChangeReason": { + "type": "string", + "description": "Reason why the status has changed" + }, + "type": { + "type": "string", + "description": "Indicates the nature of the salesLead" + }, + "rating": { + "type": "string", + "description": "Identifies the potential of a salesLead for becoming a sale. Usual ratings for qualified leads are: hot, warm, cold." + }, + "priority": { + "$ref": "SalesLeadPriorityType.schema.json#/definitions/SalesLeadPriorityType" + }, + "estimatedRevenue": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Estimation of the revenue if the salesLead turns into a sale." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the salesLead is valid" + }, + "marketingCampaign": { + "$ref": "MarketingCampaignRef.schema.json#MarketingCampaignRef", + "description": "Campaign represents the carrier-initiated marketing activity which aims at the better recognition about its brand and offerings by the market." + }, + "marketSegment": { + "$ref": "MarketSegmentRef.schema.json#MarketSegmentRef", + "description": "MarketSegment reference. A Market Segment is a grouping of Parties, GeographicAreas, SalesChannels, and so forth. MarketSegments are the target of MarketingCampaigns, ProductOfferings, ProductPromotions, ProductPlacements, and ProductPrograms from both internal and external (Competitors, and other Providers) perspective." + }, + "channel": { + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "productOffering": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "prospectContact": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "productSpecification": { + "$ref": "../Product/ProductSpecificationRef.schema.json#ProductSpecificationRef" + }, + "category": { + "$ref": "../Product/CategoryRef.schema.json#CategoryRef" + }, + "salesOpportunity": { + "$ref": "SalesOpportunityRef.schema.json#SalesOpportunityRef" + }, + "product": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/MarketingSales/SalesOpportunityRef.schema.json b/MarketingSales/SalesOpportunityRef.schema.json index b4867065..a4e225e3 100644 --- a/MarketingSales/SalesOpportunityRef.schema.json +++ b/MarketingSales/SalesOpportunityRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SalesOpportunityRef.schema.json", - "title": "SalesOpportunityRef", - "definitions": { - "SalesOpportunityRef": { - "$id": "#SalesOpportunityRef", - "description": "Sales Opportunity is an 'opportunity' to generate revenue from a Sales Account or Sales Lead. Opportunities are the pending deals that need to be tracked and on which Sales Team plans and executes Sales Activities (Events and Tasks). ", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SalesOpportunityRef.schema.json", + "title": "SalesOpportunityRef", + "definitions": { + "SalesOpportunityRef": { + "$id": "#SalesOpportunityRef", + "description": "Sales Opportunity is an 'opportunity' to generate revenue from a Sales Account or Sales Lead. Opportunities are the pending deals that need to be tracked and on which Sales Team plans and executes Sales Activities (Events and Tasks). ", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - ] } - } } \ No newline at end of file diff --git a/Product/AlternateProductOfferingProposal.schema.json b/Product/AlternateProductOfferingProposal.schema.json index 91870a64..3fecb617 100644 --- a/Product/AlternateProductOfferingProposal.schema.json +++ b/Product/AlternateProductOfferingProposal.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AlternateProductOfferingProposal.schema.json", - "title": "AlternateProductOfferingProposal", - "definitions": { - "AlternateProductOfferingProposal": { - "$id": "#AlternateProductOfferingProposal", - "description": "Alternate product Offering proposal is used when the requested product offering is not available with characteristic and date asked for. An alternate proposal could be a distinct product offering or product Spec close to requested one or same as requested but with a different activation date.", - "type": "object", - "properties": { - "alternateActivationDate": { - "type": "string", - "format": "date-time", - "description": "Alternate activation date in case seller is not able to meet requested expected activation date." - }, - "id": { - "type": "string", - "description": "Identifier of a alternate product offering proposal" - }, - "alternateProduct": { - "$ref": "ProductRefOrValue.schema.json#ProductRefOrValue", - "description": "Alternate product proposal" - }, - "alternateProductOffering": { - "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef", - "description": "Alternate product offering proposal" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AlternateProductOfferingProposal.schema.json", + "title": "AlternateProductOfferingProposal", + "definitions": { + "AlternateProductOfferingProposal": { + "$id": "#AlternateProductOfferingProposal", + "description": "Alternate product Offering proposal is used when the requested product offering is not available with characteristic and date asked for. An alternate proposal could be a distinct product offering or product Spec close to requested one or same as requested but with a different activation date.", + "type": "object", + "properties": { + "alternateActivationDate": { + "type": "string", + "format": "date-time", + "description": "Alternate activation date in case seller is not able to meet requested expected activation date." + }, + "id": { + "type": "string", + "description": "Identifier of a alternate product offering proposal" + }, + "alternateProduct": { + "$ref": "ProductRefOrValue.schema.json#ProductRefOrValue", + "description": "Alternate product proposal" + }, + "alternateProductOffering": { + "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef", + "description": "Alternate product offering proposal" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/BaseProductRefOrValue.schema.json b/Product/BaseProductRefOrValue.schema.json index f53947a4..f59d9f01 100644 --- a/Product/BaseProductRefOrValue.schema.json +++ b/Product/BaseProductRefOrValue.schema.json @@ -1,79 +1,79 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BaseProductRefOrValue.schema.json", - "title": "BaseProductRefOrValue", - "definitions": { - "BaseProductRefOrValue": { - "$id": "#BaseProductRefOrValue", - "description": "In the context of a product order or a product offering qualification, this data structure captures the product information useful to order or qualified an existing subscribed product or to a new one. This is a subset of relevant product attributes for ordering and qualification", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product" - }, - "isRef": { - "type": "boolean", - "default": true, - "description": "indicate if ref pattern is used" - }, - "name": { - "type": "string", - "description": "This is the name of the product." - }, - "productCharacteristic": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - } - }, - "realizingResource": { - "type": "array", - "items": { - "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" - } - }, - "realizingService": { - "type": "array", - "items": { - "$ref": "../Service/ServiceRef.schema.json#ServiceRef" - } - }, - "isBundle": { - "type": "boolean", - "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." - }, - "productRelationship": { - "type": "array", - "items": { - "$ref": "ProductRelationship.schema.json#ProductRelationship" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "productSpecification": { - "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef" - }, - "relatedPlace": { - "type": "array", - "items": { - "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BaseProductRefOrValue.schema.json", + "title": "BaseProductRefOrValue", + "definitions": { + "BaseProductRefOrValue": { + "$id": "#BaseProductRefOrValue", + "description": "In the context of a product order or a product offering qualification, this data structure captures the product information useful to order or qualified an existing subscribed product or to a new one. This is a subset of relevant product attributes for ordering and qualification", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product" + }, + "isRef": { + "type": "boolean", + "default": true, + "description": "indicate if ref pattern is used" + }, + "name": { + "type": "string", + "description": "This is the name of the product." + }, + "productCharacteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "realizingResource": { + "type": "array", + "items": { + "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" + } + }, + "realizingService": { + "type": "array", + "items": { + "$ref": "../Service/ServiceRef.schema.json#ServiceRef" + } + }, + "isBundle": { + "type": "boolean", + "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." + }, + "productRelationship": { + "type": "array", + "items": { + "$ref": "ProductRelationship.schema.json#ProductRelationship" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "productSpecification": { + "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef" + }, + "relatedPlace": { + "type": "array", + "items": { + "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/BundledProductOffering.schema.json b/Product/BundledProductOffering.schema.json index 79c1ef47..eedbdaa6 100644 --- a/Product/BundledProductOffering.schema.json +++ b/Product/BundledProductOffering.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BundledProductOffering.schema.json", - "title": "BundledProductOffering", - "definitions": { - "BundledProductOffering": { - "$id": "#BundledProductOffering", - "type": "object", - "description": "A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering.", - "properties": { - "href": { - "type": "string", - "description": "Unique reference of the BundledProductOffering" - }, - "id": { - "type": "string", - "description": "Unique identifier of the BundledProductOffering" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the BundledProductOffering" - }, - "bundledProductOfferingOption": { - "$ref": "BundledProductOfferingOption.schema.json#BundledProductOfferingOption", - "description": "A set of numbers that specifies the lower and upper limits for a ProductOffering that can be procured as part of the related BundledProductOffering. Values can range from 0 to unbounded." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BundledProductOffering.schema.json", + "title": "BundledProductOffering", + "definitions": { + "BundledProductOffering": { + "$id": "#BundledProductOffering", + "type": "object", + "description": "A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering.", + "properties": { + "href": { + "type": "string", + "description": "Unique reference of the BundledProductOffering" + }, + "id": { + "type": "string", + "description": "Unique identifier of the BundledProductOffering" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the BundledProductOffering" + }, + "bundledProductOfferingOption": { + "$ref": "BundledProductOfferingOption.schema.json#BundledProductOfferingOption", + "description": "A set of numbers that specifies the lower and upper limits for a ProductOffering that can be procured as part of the related BundledProductOffering. Values can range from 0 to unbounded." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/BundledProductOfferingOption.schema.json b/Product/BundledProductOfferingOption.schema.json index 4096fe25..619efb4a 100644 --- a/Product/BundledProductOfferingOption.schema.json +++ b/Product/BundledProductOfferingOption.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BundledProductOfferingOption.schema.json", - "title": "BundledProductOfferingOption", - "definitions": { - "BundledProductOfferingOption": { - "$id": "#BundledProductOfferingOption", - "type": "object", - "description": "A set of numbers that specifies the lower and upper limits for a ProductOffering that can be procured as part of the related BundledProductOffering. Values can range from 0 to unbounded", - "properties": { - "numberRelOfferDefault": { - "type": "integer", - "description": "Default number of produc offereings that should be procured as part of the related BundledProductOffering" - }, - "numberRelOfferLowerLimit": { - "type": "integer", - "description": "lower limit for a product offering that can be procured as part of the related BundledProductOffering" - }, - "numberRelOfferUpperLimit": { - "type": "integer", - "description": "upper limit for a product offering that can be procured as part of the related BundledProductOffering" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BundledProductOfferingOption.schema.json", + "title": "BundledProductOfferingOption", + "definitions": { + "BundledProductOfferingOption": { + "$id": "#BundledProductOfferingOption", + "type": "object", + "description": "A set of numbers that specifies the lower and upper limits for a ProductOffering that can be procured as part of the related BundledProductOffering. Values can range from 0 to unbounded", + "properties": { + "numberRelOfferDefault": { + "type": "integer", + "description": "Default number of produc offereings that should be procured as part of the related BundledProductOffering" + }, + "numberRelOfferLowerLimit": { + "type": "integer", + "description": "lower limit for a product offering that can be procured as part of the related BundledProductOffering" + }, + "numberRelOfferUpperLimit": { + "type": "integer", + "description": "upper limit for a product offering that can be procured as part of the related BundledProductOffering" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/BundledProductOfferingPriceRelationship.schema.json b/Product/BundledProductOfferingPriceRelationship.schema.json index be9de260..398a62e1 100644 --- a/Product/BundledProductOfferingPriceRelationship.schema.json +++ b/Product/BundledProductOfferingPriceRelationship.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BundledProductOfferingPriceRelationship.schema.json", - "title": "BundledProductOfferingPriceRelationship", - "definitions": { - "BundledProductOfferingPriceRelationship": { - "$id": "#BundledProductOfferingPriceRelationship", - "type": "object", - "description": "This represents a bundling pricing relationship, allowing a price to be composed of multiple other prices (e.g. a recurring charge and a onetime charge).", - "properties": { - "href": { - "type": "string", - "description": "hyperlink reference of the bundled product offering price" - }, - "id": { - "type": "string", - "description": "Unique identifier of the bundled product offering price" - }, - "name": { - "type": "string", - "description": "Name of the bundled product offering price" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BundledProductOfferingPriceRelationship.schema.json", + "title": "BundledProductOfferingPriceRelationship", + "definitions": { + "BundledProductOfferingPriceRelationship": { + "$id": "#BundledProductOfferingPriceRelationship", + "type": "object", + "description": "This represents a bundling pricing relationship, allowing a price to be composed of multiple other prices (e.g. a recurring charge and a onetime charge).", + "properties": { + "href": { + "type": "string", + "description": "hyperlink reference of the bundled product offering price" + }, + "id": { + "type": "string", + "description": "Unique identifier of the bundled product offering price" + }, + "name": { + "type": "string", + "description": "Name of the bundled product offering price" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/BundledProductOfferingRef.schema.json b/Product/BundledProductOfferingRef.schema.json index 2be37e8f..45933a5b 100644 --- a/Product/BundledProductOfferingRef.schema.json +++ b/Product/BundledProductOfferingRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BundledProductOfferingRef.schema.json", - "title": "BundledProductOfferingRef", - "definitions": { - "BundledProductOfferingRef": { - "$id": "#BundledProductOfferingRef", - "description": "BundledProductOffering Reference. A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the product offering" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product offering" - }, - "name": { - "type": "string", - "description": "Name of the product offering" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BundledProductOfferingRef.schema.json", + "title": "BundledProductOfferingRef", + "definitions": { + "BundledProductOfferingRef": { + "$id": "#BundledProductOfferingRef", + "description": "BundledProductOffering Reference. A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the product offering" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product offering" + }, + "name": { + "type": "string", + "description": "Name of the product offering" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] } - } } \ No newline at end of file diff --git a/Product/BundledProductSpecification.schema.json b/Product/BundledProductSpecification.schema.json index 65943172..4773d80c 100644 --- a/Product/BundledProductSpecification.schema.json +++ b/Product/BundledProductSpecification.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BundledProductSpecification.schema.json", - "title": "BundledProductSpecification", - "definitions": { - "BundledProductSpecification": { - "$id": "#BundledProductSpecification", - "description": "A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the product specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product specification" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the product specification" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BundledProductSpecification.schema.json", + "title": "BundledProductSpecification", + "definitions": { + "BundledProductSpecification": { + "$id": "#BundledProductSpecification", + "description": "A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the product specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product specification" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the product specification" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/CancelOrder.schema.json b/Product/CancelOrder.schema.json index b2d36207..e670fbf4 100644 --- a/Product/CancelOrder.schema.json +++ b/Product/CancelOrder.schema.json @@ -1,45 +1,45 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CancelOrder.schema.json", - "title": "CancelOrder", - "definitions": { - "CancelOrder": { - "$id": "#CancelOrder", - "description": "A Order cancel is a type of task which can be used to place a request to cancel an order", - "type": "object", - "properties": { - "requestedCancellationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the submitter wants the order to be cancelled" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the cancellation request" - }, - "id": { - "type": "string", - "description": "id of the cancellation request (this is not an order id)" - }, - "effectiveCancellationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order is cancelled." - }, - "cancellationReason": { - "type": "string", - "description": "Reason why the order is cancelled." - }, - "state": { - "description": "Tracks the lifecycle status of the cancellation request, such as Acknowledged, Rejected, InProgress, Pending and so on.", - "$ref": "../Common/TaskStateType.schema.json#TaskStateType" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CancelOrder.schema.json", + "title": "CancelOrder", + "definitions": { + "CancelOrder": { + "$id": "#CancelOrder", + "description": "A Order cancel is a type of task which can be used to place a request to cancel an order", + "type": "object", + "properties": { + "requestedCancellationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the submitter wants the order to be cancelled" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the cancellation request" + }, + "id": { + "type": "string", + "description": "id of the cancellation request (this is not an order id)" + }, + "effectiveCancellationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order is cancelled." + }, + "cancellationReason": { + "type": "string", + "description": "Reason why the order is cancelled." + }, + "state": { + "description": "Tracks the lifecycle status of the cancellation request, such as Acknowledged, Rejected, InProgress, Pending and so on.", + "$ref": "../Common/TaskStateType.schema.json#TaskStateType" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/CancelProductOrder.schema.json b/Product/CancelProductOrder.schema.json index 662f90f4..2a4e32a2 100644 --- a/Product/CancelProductOrder.schema.json +++ b/Product/CancelProductOrder.schema.json @@ -1,25 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CancelProductOrder.schema.json", - "title": "CancelProductOrder", - "definitions": { - "CancelProductOrder": { - "$id": "#CancelProductOrder", - "description": "Request for cancellation an existing product order", - "type": "object", - "required": [ - "productOrder" - ], - "properties": { - "productOrder": { - "$ref": "../Customer/ProductOrderRef.schema.json#ProductOrderRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CancelProductOrder.schema.json", + "title": "CancelProductOrder", + "definitions": { + "CancelProductOrder": { + "$id": "#CancelProductOrder", + "description": "Request for cancellation an existing product order", + "type": "object", + "required": [ + "productOrder" + ], + "properties": { + "productOrder": { + "$ref": "../Customer/ProductOrderRef.schema.json#ProductOrderRef" + } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#CancelOrderRef" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#CancelOrderRef" - } - ] } - } } \ No newline at end of file diff --git a/Product/Catalog.schema.json b/Product/Catalog.schema.json index 3e89ab99..7167d215 100644 --- a/Product/Catalog.schema.json +++ b/Product/Catalog.schema.json @@ -1,70 +1,70 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Catalog.schema.json", - "title": "Catalog", - "definitions": { - "Catalog": { - "$id": "#Catalog", - "description": "A collection of Product Offerings, intended for a specific DistributionChannel, enhanced with additional information such as SLA parameters, invoicing and shipping details", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Unique reference of the catalog" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Catalog" - }, - "description": { - "type": "string", - "description": "Description of this catalog" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the catalog" - }, - "catalogType": { - "type": "string", - "description": "Indicates if the catalog is a product, service or resource catalog" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the catalog is valid" - }, - "version": { - "type": "string", - "description": "Catalog version" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "description": "List of parties involved in this catalog" - }, - "category": { - "type": "array", - "items": { - "$ref": "CategoryRef.schema.json#CategoryRef" - }, - "description": "List of root categories contained in this catalog" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Catalog.schema.json", + "title": "Catalog", + "definitions": { + "Catalog": { + "$id": "#Catalog", + "description": "A collection of Product Offerings, intended for a specific DistributionChannel, enhanced with additional information such as SLA parameters, invoicing and shipping details", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Unique reference of the catalog" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Catalog" + }, + "description": { + "type": "string", + "description": "Description of this catalog" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the catalog" + }, + "catalogType": { + "type": "string", + "description": "Indicates if the catalog is a product, service or resource catalog" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the catalog is valid" + }, + "version": { + "type": "string", + "description": "Catalog version" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "List of parties involved in this catalog" + }, + "category": { + "type": "array", + "items": { + "$ref": "CategoryRef.schema.json#CategoryRef" + }, + "description": "List of root categories contained in this catalog" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/Category.schema.json b/Product/Category.schema.json index 22377c17..518aead4 100644 --- a/Product/Category.schema.json +++ b/Product/Category.schema.json @@ -1,74 +1,74 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Category.schema.json", - "title": "Category", - "definitions": { - "Category": { - "$id": "#Category", - "type": "object", - "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.", - "properties": { - "description": { - "type": "string", - "description": "Description of the category" - }, - "href": { - "type": "string", - "description": "Reference of the category" - }, - "id": { - "type": "string", - "description": "Unique identifier of the category" - }, - "isRoot": { - "type": "boolean", - "description": "If true, this Boolean indicates that the category is a root of categories" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the category" - }, - "parentId": { - "type": "string", - "description": "Unique identifier of the parent category" - }, - "productOffering": { - "type": "array", - "items": { - "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "description": "A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information." - }, - "subCategory": { - "type": "array", - "items": { - "$ref": "CategoryRef.schema.json#CategoryRef" - }, - "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other (sub-)categories and/or product offerings." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the category is valid" - }, - "version": { - "type": "string", - "description": "Category version" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Category.schema.json", + "title": "Category", + "definitions": { + "Category": { + "$id": "#Category", + "type": "object", + "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.", + "properties": { + "description": { + "type": "string", + "description": "Description of the category" + }, + "href": { + "type": "string", + "description": "Reference of the category" + }, + "id": { + "type": "string", + "description": "Unique identifier of the category" + }, + "isRoot": { + "type": "boolean", + "description": "If true, this Boolean indicates that the category is a root of categories" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the category" + }, + "parentId": { + "type": "string", + "description": "Unique identifier of the parent category" + }, + "productOffering": { + "type": "array", + "items": { + "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "description": "A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information." + }, + "subCategory": { + "type": "array", + "items": { + "$ref": "CategoryRef.schema.json#CategoryRef" + }, + "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other (sub-)categories and/or product offerings." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the category is valid" + }, + "version": { + "type": "string", + "description": "Category version" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/CategoryRef.schema.json b/Product/CategoryRef.schema.json index bc189966..30f90337 100644 --- a/Product/CategoryRef.schema.json +++ b/Product/CategoryRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CategoryRef.schema.json", - "title": "CategoryRef", - "definitions": { - "CategoryRef": { - "$id": "#CategoryRef", - "description": "The category for grouping recommendations", - "type": "object", - "properties": { - "version": { - "type": "string", - "description": "Category version" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CategoryRef.schema.json", + "title": "CategoryRef", + "definitions": { + "CategoryRef": { + "$id": "#CategoryRef", + "description": "The category for grouping recommendations", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "Category version" + } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] } - } } \ No newline at end of file diff --git a/Product/ConsumptionSummary.schema.json b/Product/ConsumptionSummary.schema.json index b3a1b7cf..8908f9ec 100644 --- a/Product/ConsumptionSummary.schema.json +++ b/Product/ConsumptionSummary.schema.json @@ -1,47 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ConsumptionSummary.schema.json", - "title": "ConsumptionSummary", - "definitions": { - "ConsumptionSummary": { - "$id": "#ConsumptionSummary", - "type": "object", - "description": "The consumption counters (called ConsumptionSummary in the SID model) detail for example the different kind of consumption done on the bucket.", - "properties": { - "consumptionPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Consumption counter period between a start date time and an end date time. For prepaid bucket, the period of counters is between the start date of the bucket and the effective date of the usage consumption report generation. For postpaid bucket, the period of counters is between the last bill date and the effective date of the usage consumption report generation." - }, - "counterType": { - "type": "string", - "description": "Type of the consumption counter. We can give for example a counter of the used value for a bucket (counterType=used for example) or the value of the consumption done out of the bucket(s) (counterType=outOfBucket for example)" - }, - "level": { - "type": "string", - "description": "Counter level. The counter can be given globally for the bucket or detailed by user or by network product for example in case of shared bucket" - }, - "product": { - "$ref": "NetworkProductRef.schema.json#NetworkProductRef", - "description": "Public identifier associated to the product for which the consumption counter is detailed. If the level of the counter is global (i.e. concerning all the network products), the list of them is not specified. It can be found through the network products listed in the bucket sub-resource" - }, - "user": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty", - "description": "Reference of the user for which the consumption counter is detailed. If the level of the counter is global (i.e. concerning all the users), the list of them is not specified. It can be found through the users listed in the network products of the bucket sub-resource" - }, - "value": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "Numeric value of the bucket counter in a given unit" - }, - "valueName": { - "type": "string", - "description": "Value of the counter in a formatted string used for display needs for example" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ConsumptionSummary.schema.json", + "title": "ConsumptionSummary", + "definitions": { + "ConsumptionSummary": { + "$id": "#ConsumptionSummary", + "type": "object", + "description": "The consumption counters (called ConsumptionSummary in the SID model) detail for example the different kind of consumption done on the bucket.", + "properties": { + "consumptionPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Consumption counter period between a start date time and an end date time. For prepaid bucket, the period of counters is between the start date of the bucket and the effective date of the usage consumption report generation. For postpaid bucket, the period of counters is between the last bill date and the effective date of the usage consumption report generation." + }, + "counterType": { + "type": "string", + "description": "Type of the consumption counter. We can give for example a counter of the used value for a bucket (counterType=used for example) or the value of the consumption done out of the bucket(s) (counterType=outOfBucket for example)" + }, + "level": { + "type": "string", + "description": "Counter level. The counter can be given globally for the bucket or detailed by user or by network product for example in case of shared bucket" + }, + "product": { + "$ref": "NetworkProductRef.schema.json#NetworkProductRef", + "description": "Public identifier associated to the product for which the consumption counter is detailed. If the level of the counter is global (i.e. concerning all the network products), the list of them is not specified. It can be found through the network products listed in the bucket sub-resource" + }, + "user": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty", + "description": "Reference of the user for which the consumption counter is detailed. If the level of the counter is global (i.e. concerning all the users), the list of them is not specified. It can be found through the users listed in the network products of the bucket sub-resource" + }, + "value": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "Numeric value of the bucket counter in a given unit" + }, + "valueName": { + "type": "string", + "description": "Value of the counter in a formatted string used for display needs for example" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/EligibilityUnavailabilityReason.schema.json b/Product/EligibilityUnavailabilityReason.schema.json index fb3361fc..140df858 100644 --- a/Product/EligibilityUnavailabilityReason.schema.json +++ b/Product/EligibilityUnavailabilityReason.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EligibilityUnavailabilityReason.schema.json", - "title": "EligibilityUnavailabilityReason", - "definitions": { - "EligibilityUnavailabilityReason": { - "$id": "#EligibilityUnavailabilityReason", - "description": "Reason for eligibility result if the productOfferingQualification result is no (meaning the productOffering or productSpec is not available).", - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Unavailability reason code." - }, - "label": { - "type": "string", - "description": "Unavailability reason label." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EligibilityUnavailabilityReason.schema.json", + "title": "EligibilityUnavailabilityReason", + "definitions": { + "EligibilityUnavailabilityReason": { + "$id": "#EligibilityUnavailabilityReason", + "description": "Reason for eligibility result if the productOfferingQualification result is no (meaning the productOffering or productSpec is not available).", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Unavailability reason code." + }, + "label": { + "type": "string", + "description": "Unavailability reason label." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/LoyaltyAccount.schema.json b/Product/LoyaltyAccount.schema.json index dcfd7858..bffb87c7 100644 --- a/Product/LoyaltyAccount.schema.json +++ b/Product/LoyaltyAccount.schema.json @@ -1,25 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyAccount.schema.json", - "title": "LoyaltyAccount", - "definitions": { - "LoyaltyAccount": { - "$id": "#LoyaltyAccount", - "description": "A loyalty account, containing loyalty balances.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the account." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty member’s loyalty account." - }, - "loyaltyProgramProduct": { - "$ref": "LoyaltyProgramProductRef.schema.json#LoyaltyProgramProductRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyAccount.schema.json", + "title": "LoyaltyAccount", + "definitions": { + "LoyaltyAccount": { + "$id": "#LoyaltyAccount", + "description": "A loyalty account, containing loyalty balances.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the account." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty member’s loyalty account." + }, + "loyaltyProgramProduct": { + "$ref": "LoyaltyProgramProductRef.schema.json#LoyaltyProgramProductRef" + } + } } - } } - } } \ No newline at end of file diff --git a/Product/LoyaltyAccountRef.schema.json b/Product/LoyaltyAccountRef.schema.json index 7edea9a8..283747a2 100644 --- a/Product/LoyaltyAccountRef.schema.json +++ b/Product/LoyaltyAccountRef.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyAccountRef.schema.json", - "title": "LoyaltyAccountRef", - "definitions": { - "LoyaltyAccountRef": { - "$id": "#LoyaltyAccountRef", - "description": "Reference to a loyalty account.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the account." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty member’s loyalty account." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyAccountRef.schema.json", + "title": "LoyaltyAccountRef", + "definitions": { + "LoyaltyAccountRef": { + "$id": "#LoyaltyAccountRef", + "description": "Reference to a loyalty account.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the account." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty member’s loyalty account." + } + } } - } } - } } \ No newline at end of file diff --git a/Product/LoyaltyAction.schema.json b/Product/LoyaltyAction.schema.json index 250a39dd..e94d6bec 100644 --- a/Product/LoyaltyAction.schema.json +++ b/Product/LoyaltyAction.schema.json @@ -1,73 +1,73 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyAction.schema.json", - "title": "LoyaltyAction", - "definitions": { - "LoyaltyAction": { - "$id": "#LoyaltyAction", - "description": "Contains information on a loyalty action that should be applied should certain conditions be met for a loyalty rule and program.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty event type." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty event type." - }, - "type": { - "type": "string", - "description": "The type of loyalty action.", - "enum": [ - "LoyaltyEarn", - "CustomerOrder", - "BusinessInteraction" - ] - }, - "actionAttributes": { - "type": "object", - "$ref": "../Common/Any.schema.json#Any", - "description": "Additional attributes required to perform the action. These attributes will depend on the type of the loyalty action. For example, if it is a LoyaltyEarn action, there will be a “quantity” attribute value pair indicating how many points should be earned." - }, - "body": { - "type": "object", - "$ref": "../Common/Any.schema.json#Any", - "description": "The body if the request that is made when this action i executed. The body is assumed to be of type text/json. Any tokens denoted with {} will be replaced by attributes present in: Member profile, actionAttributes or event attributes in the loyalty event request." - }, - "headers": { - "type": "object", - "$ref": "../Common/Any.schema.json#Any", - "description": "The HTTP headers that is added to the action call." - }, - "version": { - "type": "string", - "description": "A string that identifies the version of the loyalty action." - }, - "commonName": { - "type": "string", - "description": "A user-friendly identifier of the loyalty execution point." - }, - "description": { - "type": "string", - "description": "A free-form description of the loyalty execution point." - }, - "action": { - "type": "string", - "description": "The HTTP operation to be used when calling the endpoint", - "enum": [ - "POST", - "PUT", - "GET", - "PATCH", - "DELETE" - ] - }, - "endpoint": { - "type": "string", - "description": "The endpoint to call to trigger a BusinessInteraction, CustomerOrder or LoyaltyEarn." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyAction.schema.json", + "title": "LoyaltyAction", + "definitions": { + "LoyaltyAction": { + "$id": "#LoyaltyAction", + "description": "Contains information on a loyalty action that should be applied should certain conditions be met for a loyalty rule and program.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty event type." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty event type." + }, + "type": { + "type": "string", + "description": "The type of loyalty action.", + "enum": [ + "LoyaltyEarn", + "CustomerOrder", + "BusinessInteraction" + ] + }, + "actionAttributes": { + "type": "object", + "$ref": "../Common/Any.schema.json#Any", + "description": "Additional attributes required to perform the action. These attributes will depend on the type of the loyalty action. For example, if it is a LoyaltyEarn action, there will be a “quantity” attribute value pair indicating how many points should be earned." + }, + "body": { + "type": "object", + "$ref": "../Common/Any.schema.json#Any", + "description": "The body if the request that is made when this action i executed. The body is assumed to be of type text/json. Any tokens denoted with {} will be replaced by attributes present in: Member profile, actionAttributes or event attributes in the loyalty event request." + }, + "headers": { + "type": "object", + "$ref": "../Common/Any.schema.json#Any", + "description": "The HTTP headers that is added to the action call." + }, + "version": { + "type": "string", + "description": "A string that identifies the version of the loyalty action." + }, + "commonName": { + "type": "string", + "description": "A user-friendly identifier of the loyalty execution point." + }, + "description": { + "type": "string", + "description": "A free-form description of the loyalty execution point." + }, + "action": { + "type": "string", + "description": "The HTTP operation to be used when calling the endpoint", + "enum": [ + "POST", + "PUT", + "GET", + "PATCH", + "DELETE" + ] + }, + "endpoint": { + "type": "string", + "description": "The endpoint to call to trigger a BusinessInteraction, CustomerOrder or LoyaltyEarn." + } + } } - } } - } } \ No newline at end of file diff --git a/Product/LoyaltyActionRef.schema.json b/Product/LoyaltyActionRef.schema.json index 1eefc1e0..a62edf61 100644 --- a/Product/LoyaltyActionRef.schema.json +++ b/Product/LoyaltyActionRef.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyActionRef.schema.json", - "title": "LoyaltyActionRef", - "definitions": { - "LoyaltyActionRef": { - "$id": "#LoyaltyActionRef", - "description": "A reference to a loyalty action.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty action." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty action." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyActionRef.schema.json", + "title": "LoyaltyActionRef", + "definitions": { + "LoyaltyActionRef": { + "$id": "#LoyaltyActionRef", + "description": "A reference to a loyalty action.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty action." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty action." + } + } } - } } - } } \ No newline at end of file diff --git a/Product/LoyaltyBalance.schema.json b/Product/LoyaltyBalance.schema.json index c5cdd24e..5f40ffd5 100644 --- a/Product/LoyaltyBalance.schema.json +++ b/Product/LoyaltyBalance.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyBalance.schema.json", - "title": "LoyaltyBalance", - "definitions": { - "LoyaltyBalance": { - "$id": "#LoyaltyBalance", - "description": "A loyalty balance, containing a balance unit and value.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty balance." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty member’s loyalty balance." - }, - "quantity": { - "type": "object", - "description": "Unit and value of the balance.", - "$ref": "../Common/Money.schema.json#Money" - }, - "loyaltyProgramMember": { - "type": "object", - "description": "Reference to the loyaltyProgramMember to whom the loyaltyAccount belongs.", - "$ref": "LoyaltyProgramMemberRef.schema.json#LoyaltyProgramMemberRef" - }, - "validFor": { - "type": "object", - "description": "The validity period in which loyalty can be burned using the account.", - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyBalance.schema.json", + "title": "LoyaltyBalance", + "definitions": { + "LoyaltyBalance": { + "$id": "#LoyaltyBalance", + "description": "A loyalty balance, containing a balance unit and value.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty balance." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty member’s loyalty balance." + }, + "quantity": { + "type": "object", + "description": "Unit and value of the balance.", + "$ref": "../Common/Money.schema.json#Money" + }, + "loyaltyProgramMember": { + "type": "object", + "description": "Reference to the loyaltyProgramMember to whom the loyaltyAccount belongs.", + "$ref": "LoyaltyProgramMemberRef.schema.json#LoyaltyProgramMemberRef" + }, + "validFor": { + "type": "object", + "description": "The validity period in which loyalty can be burned using the account.", + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + } + } } - } } - } } \ No newline at end of file diff --git a/Product/LoyaltyCondition.schema.json b/Product/LoyaltyCondition.schema.json index d611668c..6ff375b2 100644 --- a/Product/LoyaltyCondition.schema.json +++ b/Product/LoyaltyCondition.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyCondition.schema.json", - "title": "LoyaltyCondition", - "definitions": { - "LoyaltyCondition": { - "$id": "#LoyaltyCondition", - "description": "A condition, comprised of a attribute that will be tested against a value.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty condition." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty event type." - }, - "attribute": { - "type": "string", - "description": "The attribute to evaluate." - }, - "operator": { - "type": "string", - "description": "Comparison operator to be used in the evaluation." - }, - "value": { - "type": "string", - "description": "The value of the attribute to be evaluated." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyCondition.schema.json", + "title": "LoyaltyCondition", + "definitions": { + "LoyaltyCondition": { + "$id": "#LoyaltyCondition", + "description": "A condition, comprised of a attribute that will be tested against a value.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty condition." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty event type." + }, + "attribute": { + "type": "string", + "description": "The attribute to evaluate." + }, + "operator": { + "type": "string", + "description": "Comparison operator to be used in the evaluation." + }, + "value": { + "type": "string", + "description": "The value of the attribute to be evaluated." + } + } } - } } - } } \ No newline at end of file diff --git a/Product/LoyaltyConditionRef.schema.json b/Product/LoyaltyConditionRef.schema.json index dd9c25a5..818f7bd8 100644 --- a/Product/LoyaltyConditionRef.schema.json +++ b/Product/LoyaltyConditionRef.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyConditionRef.schema.json", - "title": "LoyaltyConditionRef", - "definitions": { - "LoyaltyConditionRef": { - "$id": "#LoyaltyConditionRef", - "description": "A reference to a loyalty condition.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty condition." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty condition." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyConditionRef.schema.json", + "title": "LoyaltyConditionRef", + "definitions": { + "LoyaltyConditionRef": { + "$id": "#LoyaltyConditionRef", + "description": "A reference to a loyalty condition.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty condition." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty condition." + } + } } - } } - } } \ No newline at end of file diff --git a/Product/LoyaltyEvent.schema.json b/Product/LoyaltyEvent.schema.json index 945f810a..e3f854e6 100644 --- a/Product/LoyaltyEvent.schema.json +++ b/Product/LoyaltyEvent.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyEvent.schema.json", - "title": "LoyaltyEvent", - "definitions": { - "LoyaltyEvent": { - "$id": "#LoyaltyEvent", - "description": "A loyalty event notification.", - "type": "object", - "properties": { - "eventId": { - "$ref": "LoyaltyProgramProductRef.schema.json#LoyaltyProgramProductRef" - }, - "eventType": { - "type": "string", - "description": "The incoming loyalty event type." - }, - "eventTime": { - "type": "string", - "description": "The time that the event was received." - }, - "memberId": { - "type": "string", - "description": "The loyalty program member ID associated with the event." - }, - "event": { - "type": "object", - "$ref": "../Common/Any.schema.json#Any", - "description": "The event attributes." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyEvent.schema.json", + "title": "LoyaltyEvent", + "definitions": { + "LoyaltyEvent": { + "$id": "#LoyaltyEvent", + "description": "A loyalty event notification.", + "type": "object", + "properties": { + "eventId": { + "$ref": "LoyaltyProgramProductRef.schema.json#LoyaltyProgramProductRef" + }, + "eventType": { + "type": "string", + "description": "The incoming loyalty event type." + }, + "eventTime": { + "type": "string", + "description": "The time that the event was received." + }, + "memberId": { + "type": "string", + "description": "The loyalty program member ID associated with the event." + }, + "event": { + "type": "object", + "$ref": "../Common/Any.schema.json#Any", + "description": "The event attributes." + } + } } - } } - } } \ No newline at end of file diff --git a/Product/LoyaltyEventType.schema.json b/Product/LoyaltyEventType.schema.json index 4f7094f1..44af2231 100644 --- a/Product/LoyaltyEventType.schema.json +++ b/Product/LoyaltyEventType.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyEventType.schema.json", - "title": "LoyaltyEventType", - "definitions": { - "LoyaltyEventType": { - "$id": "#LoyaltyEventType", - "description": "An event type used to match filter incoming loyalty events.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty event type." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty event type." - }, - "eventType": { - "type": "string", - "description": "The type of loyalty event expected to trigger the loyalty rule evaluation, e.g. a CustomerOrder or an Invoice. The eventType should be unique to prevent existing resources not being reused. An eventType that already exists will result in a 422 error." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyEventType.schema.json", + "title": "LoyaltyEventType", + "definitions": { + "LoyaltyEventType": { + "$id": "#LoyaltyEventType", + "description": "An event type used to match filter incoming loyalty events.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty event type." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty event type." + }, + "eventType": { + "type": "string", + "description": "The type of loyalty event expected to trigger the loyalty rule evaluation, e.g. a CustomerOrder or an Invoice. The eventType should be unique to prevent existing resources not being reused. An eventType that already exists will result in a 422 error." + } + } } - } } - } } \ No newline at end of file diff --git a/Product/LoyaltyEventTypeRef.schema.json b/Product/LoyaltyEventTypeRef.schema.json index 05e9e336..c5625f4c 100644 --- a/Product/LoyaltyEventTypeRef.schema.json +++ b/Product/LoyaltyEventTypeRef.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyEventTypeRef.schema.json", - "title": "LoyaltyEventTypeRef", - "definitions": { - "LoyaltyEventTypeRef": { - "$id": "#LoyaltyEventTypeRef", - "description": "A reference to a loyalty event type.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty event type." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty event type." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyEventTypeRef.schema.json", + "title": "LoyaltyEventTypeRef", + "definitions": { + "LoyaltyEventTypeRef": { + "$id": "#LoyaltyEventTypeRef", + "description": "A reference to a loyalty event type.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty event type." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty event type." + } + } } - } } - } } \ No newline at end of file diff --git a/Product/LoyaltyExecutionPoint.schema.json b/Product/LoyaltyExecutionPoint.schema.json index 8773d916..59001c32 100644 --- a/Product/LoyaltyExecutionPoint.schema.json +++ b/Product/LoyaltyExecutionPoint.schema.json @@ -1,79 +1,79 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyExecutionPoint.schema.json", - "title": "LoyaltyExecutionPoint", - "definitions": { - "LoyaltyAccount": { - "$id": "#LoyaltyExecutionPoint", - "description": "A record of a loyalty action that was applied.", - "type": "object", - "title": "LoyaltyExecutionPoint", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty event type." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty event type." - }, - "type": { - "type": "string", - "description": "The type of loyalty action.", - "enum": [ - "LoyaltyEarn", - "CustomerOrder", - "BusinessInteraction" - ] - }, - "actionAttributes": { - "type": "object", - "$ref": "../Common/Any.schema.json#/definitions/Any", - "description": "Additional attributes required to perform the action. These attributes will depend on the type of the loyalty action. For example, if it is a LoyaltyEarn action, there will be a “quantity” attribute value pair indicating how many points should be earned." - }, - "body": { - "type": "object", - "$ref": "../Common/Any.schema.json#/definitions/Any", - "description": "The body if the request that is made when this action i executed. The body is assumed to be of type text/json. Any tokens denoted with {} will be replaced by attributes present in: Member profile, actionAttributes or event attributes in the loyalty event request." - }, - "headers": { - "type": "object", - "$ref": "../Common/Any.schema.json#/definitions/Any", - "description": "The HTTP headers that is added to the action call." - }, - "version": { - "type": "string", - "description": "A string that identifies the version of the loyalty action." - }, - "commonName": { - "type": "string", - "description": "A user-friendly identifier of the loyalty execution point." - }, - "description": { - "type": "string", - "description": "A free-form description of the loyalty execution point." - }, - "action": { - "type": "string", - "description": "The HTTP operation to be used when calling the endpoint", - "enum": [ - "POST", - "PUT", - "GET", - "PATCH", - "DELETE" - ] - }, - "endpoint": { - "type": "string", - "description": "The endpoint to call to trigger a BusinessInteraction, CustomerOrder or LoyaltyEarn." - }, - "datetime": { - "type": "string", - "description": "The timestamp that the action was applied.", - "format": "date-time" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyExecutionPoint.schema.json", + "title": "LoyaltyExecutionPoint", + "definitions": { + "LoyaltyAccount": { + "$id": "#LoyaltyExecutionPoint", + "description": "A record of a loyalty action that was applied.", + "type": "object", + "title": "LoyaltyExecutionPoint", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty event type." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty event type." + }, + "type": { + "type": "string", + "description": "The type of loyalty action.", + "enum": [ + "LoyaltyEarn", + "CustomerOrder", + "BusinessInteraction" + ] + }, + "actionAttributes": { + "type": "object", + "$ref": "../Common/Any.schema.json#/definitions/Any", + "description": "Additional attributes required to perform the action. These attributes will depend on the type of the loyalty action. For example, if it is a LoyaltyEarn action, there will be a “quantity” attribute value pair indicating how many points should be earned." + }, + "body": { + "type": "object", + "$ref": "../Common/Any.schema.json#/definitions/Any", + "description": "The body if the request that is made when this action i executed. The body is assumed to be of type text/json. Any tokens denoted with {} will be replaced by attributes present in: Member profile, actionAttributes or event attributes in the loyalty event request." + }, + "headers": { + "type": "object", + "$ref": "../Common/Any.schema.json#/definitions/Any", + "description": "The HTTP headers that is added to the action call." + }, + "version": { + "type": "string", + "description": "A string that identifies the version of the loyalty action." + }, + "commonName": { + "type": "string", + "description": "A user-friendly identifier of the loyalty execution point." + }, + "description": { + "type": "string", + "description": "A free-form description of the loyalty execution point." + }, + "action": { + "type": "string", + "description": "The HTTP operation to be used when calling the endpoint", + "enum": [ + "POST", + "PUT", + "GET", + "PATCH", + "DELETE" + ] + }, + "endpoint": { + "type": "string", + "description": "The endpoint to call to trigger a BusinessInteraction, CustomerOrder or LoyaltyEarn." + }, + "datetime": { + "type": "string", + "description": "The timestamp that the action was applied.", + "format": "date-time" + } + } } - } } - } } \ No newline at end of file diff --git a/Product/LoyaltyProgramMember.schema.json b/Product/LoyaltyProgramMember.schema.json index d9b913c7..177333f7 100644 --- a/Product/LoyaltyProgramMember.schema.json +++ b/Product/LoyaltyProgramMember.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyProgramMember.schema.json", - "title": "LoyaltyProgramMember", - "definitions": { - "LoyaltyProgramMember": { - "$id": "#LoyaltyProgramMember", - "description": "A person or group that opts in to a loyalty program.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty program member." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty program member." - }, - "name": { - "type": "string", - "description": "The loyalty member’s name." - }, - "status": { - "type": "string", - "description": "A free-form field in which the member’s status may be captured, e.g. 'active', 'suspended', .etc." - }, - "ValidFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period during which the loyalty member is valid for." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyProgramMember.schema.json", + "title": "LoyaltyProgramMember", + "definitions": { + "LoyaltyProgramMember": { + "$id": "#LoyaltyProgramMember", + "description": "A person or group that opts in to a loyalty program.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty program member." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty program member." + }, + "name": { + "type": "string", + "description": "The loyalty member’s name." + }, + "status": { + "type": "string", + "description": "A free-form field in which the member’s status may be captured, e.g. 'active', 'suspended', .etc." + }, + "ValidFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period during which the loyalty member is valid for." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/LoyaltyProgramMemberRef.schema.json b/Product/LoyaltyProgramMemberRef.schema.json index c89e4e6a..c59155e3 100644 --- a/Product/LoyaltyProgramMemberRef.schema.json +++ b/Product/LoyaltyProgramMemberRef.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyProgramMemberRef.schema.json", - "title": "LoyaltyProgramMemberRef", - "definitions": { - "LoyaltyProgramMemberRef": { - "$id": "#LoyaltyProgramMemberRef", - "description": "Reference to a loyalty member.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty program member." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty program member." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyProgramMemberRef.schema.json", + "title": "LoyaltyProgramMemberRef", + "definitions": { + "LoyaltyProgramMemberRef": { + "$id": "#LoyaltyProgramMemberRef", + "description": "Reference to a loyalty member.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty program member." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty program member." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/LoyaltyProgramProduct.schema.json b/Product/LoyaltyProgramProduct.schema.json index 829ef1e9..f00f77a0 100644 --- a/Product/LoyaltyProgramProduct.schema.json +++ b/Product/LoyaltyProgramProduct.schema.json @@ -1,57 +1,57 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyProgramProduct.schema.json", - "title": "LoyaltyProgramProduct", - "definitions": { - "LoyaltyProgramProduct": { - "$id": "#LoyaltyProgramProduct", - "description": "An instance of a loyalty program specification, linked to a specified loyalty member.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty program product." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty account." - }, - "name": { - "type": "string", - "description": "A word, term, or phrase by which the product is known and distinguished from other products." - }, - "description": { - "type": "string", - "description": "An explanation of what the product is." - }, - "productStatus": { - "type": "string", - "description": "The condition of the product, such as planned, designed, activated, disconnected." - }, - "characteristic": { - "type": "array", - "description": "Name value pairs of product characteristics.", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - } - }, - "loyaltyProgramProductSpec": { - "type": "object", - "$ref": "LoyaltyProgramProductSpecRef.schema.json#LoyaltyProgramProductSpecRef" - }, - "loyaltyAccount": { - "type": "object", - "$ref": "LoyaltyAccountRef.schema.json#LoyaltyAccountRef" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyProgramProduct.schema.json", + "title": "LoyaltyProgramProduct", + "definitions": { + "LoyaltyProgramProduct": { + "$id": "#LoyaltyProgramProduct", + "description": "An instance of a loyalty program specification, linked to a specified loyalty member.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty program product." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty account." + }, + "name": { + "type": "string", + "description": "A word, term, or phrase by which the product is known and distinguished from other products." + }, + "description": { + "type": "string", + "description": "An explanation of what the product is." + }, + "productStatus": { + "type": "string", + "description": "The condition of the product, such as planned, designed, activated, disconnected." + }, + "characteristic": { + "type": "array", + "description": "Name value pairs of product characteristics.", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "loyaltyProgramProductSpec": { + "type": "object", + "$ref": "LoyaltyProgramProductSpecRef.schema.json#LoyaltyProgramProductSpecRef" + }, + "loyaltyAccount": { + "type": "object", + "$ref": "LoyaltyAccountRef.schema.json#LoyaltyAccountRef" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/LoyaltyProgramProductRef.schema.json b/Product/LoyaltyProgramProductRef.schema.json index d83b628c..91881daa 100644 --- a/Product/LoyaltyProgramProductRef.schema.json +++ b/Product/LoyaltyProgramProductRef.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyProgramProductRef.schema.json", - "title": "LoyaltyProgramProductRef", - "definitions": { - "LoyaltyProgramProductRef": { - "$id": "#LoyaltyProgramProductRef", - "type": "object", - "description": "A reference to a loyalty product.", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty program product." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty program product." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyProgramProductRef.schema.json", + "title": "LoyaltyProgramProductRef", + "definitions": { + "LoyaltyProgramProductRef": { + "$id": "#LoyaltyProgramProductRef", + "type": "object", + "description": "A reference to a loyalty product.", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty program product." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty program product." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/LoyaltyProgramProductSpec.schema.json b/Product/LoyaltyProgramProductSpec.schema.json index 4bd34183..09cf4d92 100644 --- a/Product/LoyaltyProgramProductSpec.schema.json +++ b/Product/LoyaltyProgramProductSpec.schema.json @@ -1,49 +1,49 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyProgramProductSpec.schema.json", - "title": "LoyaltyProgramProductSpec", - "definitions": { - "LoyaltyProgramProductSpec": { - "$id": "#LoyaltyProgramProductSpec", - "type": "object", - "description": "A reference to a loyalty program specification.", - "properties": { - "brand": { - "type": "string", - "description": "The manufacturer or trademark of the specification." - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the product specification is." - }, - "id": { - "type": "string", - "description": "Unique identifier for the product specification." - }, - "href": { - "type": "string", - "description": "A reference to the product specification." - }, - "lifeCycleStatus": { - "type": "string", - "description": "The condition of the product specification, such as active, inactive, planned." - }, - "name": { - "type": "string", - "description": "The name of the product specification." - }, - "needsLoyaltyAccount": { - "type": "boolean", - "description": "A narrative that explains in detail what the product specification is." - }, - "productNumber": { - "type": "string", - "productNumber": "An identification number assigned to uniquely identify the specification." - }, - "ValidFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyProgramProductSpec.schema.json", + "title": "LoyaltyProgramProductSpec", + "definitions": { + "LoyaltyProgramProductSpec": { + "$id": "#LoyaltyProgramProductSpec", + "type": "object", + "description": "A reference to a loyalty program specification.", + "properties": { + "brand": { + "type": "string", + "description": "The manufacturer or trademark of the specification." + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the product specification is." + }, + "id": { + "type": "string", + "description": "Unique identifier for the product specification." + }, + "href": { + "type": "string", + "description": "A reference to the product specification." + }, + "lifeCycleStatus": { + "type": "string", + "description": "The condition of the product specification, such as active, inactive, planned." + }, + "name": { + "type": "string", + "description": "The name of the product specification." + }, + "needsLoyaltyAccount": { + "type": "boolean", + "description": "A narrative that explains in detail what the product specification is." + }, + "productNumber": { + "type": "string", + "productNumber": "An identification number assigned to uniquely identify the specification." + }, + "ValidFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + } + } } - } } - } } \ No newline at end of file diff --git a/Product/LoyaltyProgramProductSpecRef.schema.json b/Product/LoyaltyProgramProductSpecRef.schema.json index 171820c0..4b6f2719 100644 --- a/Product/LoyaltyProgramProductSpecRef.schema.json +++ b/Product/LoyaltyProgramProductSpecRef.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyProgramProductSpecRef.schema.json", - "title": "LoyaltyProgramProductSpecRef", - "definitions": { - "LoyaltyProgramProductSpecRef": { - "$id": "#LoyaltyProgramProductSpecRef", - "description": "A reference to a loyalty program specification.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the product specification." - }, - "href": { - "type": "string", - "description": "A reference to the product specification." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyProgramProductSpecRef.schema.json", + "title": "LoyaltyProgramProductSpecRef", + "definitions": { + "LoyaltyProgramProductSpecRef": { + "$id": "#LoyaltyProgramProductSpecRef", + "description": "A reference to a loyalty program specification.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the product specification." + }, + "href": { + "type": "string", + "description": "A reference to the product specification." + } + } } - } } - } } \ No newline at end of file diff --git a/Product/LoyaltyRule.schema.json b/Product/LoyaltyRule.schema.json index dd7bb279..fd8d7273 100644 --- a/Product/LoyaltyRule.schema.json +++ b/Product/LoyaltyRule.schema.json @@ -1,75 +1,75 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyRule.schema.json", - "title": "LoyaltyRule", - "definitions": { - "LoyaltyRule": { - "$id": "#LoyaltyRule", - "description": "Loyalty rule, containing conditions, event types and actions.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty rule." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty rule." - }, - "isCNF": { - "type": "boolean", - "description": "Unit and value of the balance." - }, - "hasSubRules": { - "type": "boolean", - "description": "A Boolean attribute that signifies whether this loyalty rule has one or more sub-rules. Sub-rules are used to enforce a hierarchical nesting of rules, so that parent rules may control the execution and other semantics of sub-rules that they contain." - }, - "isMandatoryEvaluation": { - "type": "boolean", - "description": "A Boolean attribute that, if true, signifies that evaluation (and possibly action execution) of this entity is mandatory and must be attempted. If the Mandatory property value of this entity is false, then the evaluation of this entity is considered to be 'best effort' and may be ignored." - }, - "usage": { - "type": "string", - "description": "A free-form string attribute that recommends how this policy object should be used." - }, - "keywords": { - "type": "string", - "description": "A string attribute that defines a set of one or more keywords that a policy administrator may use to assist in characterizing or categorizing a policy object to facilitate search operations." - }, - "policyName": { - "type": "string", - "description": "A generic naming attribute that can be used to identify different policy entities." - }, - "commonName": { - "type": "string", - "description": "A user-friendly identifier of the loyalty rule." - }, - "description": { - "type": "string", - "description": "A free-form description of the rule." - }, - "loyaltyEventType": { - "type": "array", - "description": "References to linked event types.", - "items": { - "$ref": "LoyaltyEventTypeRef.schema.json#LoyaltyEventTypeRef" - } - }, - "loyaltyCondition": { - "type": "array", - "description": "References to linked conditions.", - "items": { - "$ref": "LoyaltyConditionRef.schema.json#LoyaltyConditionRef" - } - }, - "loyaltyAction": { - "type": "array", - "description": "References to linked actions.", - "items": { - "$ref": "LoyaltyActionRef.schema.json#LoyaltyActionRef" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyRule.schema.json", + "title": "LoyaltyRule", + "definitions": { + "LoyaltyRule": { + "$id": "#LoyaltyRule", + "description": "Loyalty rule, containing conditions, event types and actions.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty rule." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty rule." + }, + "isCNF": { + "type": "boolean", + "description": "Unit and value of the balance." + }, + "hasSubRules": { + "type": "boolean", + "description": "A Boolean attribute that signifies whether this loyalty rule has one or more sub-rules. Sub-rules are used to enforce a hierarchical nesting of rules, so that parent rules may control the execution and other semantics of sub-rules that they contain." + }, + "isMandatoryEvaluation": { + "type": "boolean", + "description": "A Boolean attribute that, if true, signifies that evaluation (and possibly action execution) of this entity is mandatory and must be attempted. If the Mandatory property value of this entity is false, then the evaluation of this entity is considered to be 'best effort' and may be ignored." + }, + "usage": { + "type": "string", + "description": "A free-form string attribute that recommends how this policy object should be used." + }, + "keywords": { + "type": "string", + "description": "A string attribute that defines a set of one or more keywords that a policy administrator may use to assist in characterizing or categorizing a policy object to facilitate search operations." + }, + "policyName": { + "type": "string", + "description": "A generic naming attribute that can be used to identify different policy entities." + }, + "commonName": { + "type": "string", + "description": "A user-friendly identifier of the loyalty rule." + }, + "description": { + "type": "string", + "description": "A free-form description of the rule." + }, + "loyaltyEventType": { + "type": "array", + "description": "References to linked event types.", + "items": { + "$ref": "LoyaltyEventTypeRef.schema.json#LoyaltyEventTypeRef" + } + }, + "loyaltyCondition": { + "type": "array", + "description": "References to linked conditions.", + "items": { + "$ref": "LoyaltyConditionRef.schema.json#LoyaltyConditionRef" + } + }, + "loyaltyAction": { + "type": "array", + "description": "References to linked actions.", + "items": { + "$ref": "LoyaltyActionRef.schema.json#LoyaltyActionRef" + } + } + } } - } } - } } \ No newline at end of file diff --git a/Product/LoyaltyRuleAction.schema.json b/Product/LoyaltyRuleAction.schema.json index 4c8f22fe..f50d05f5 100644 --- a/Product/LoyaltyRuleAction.schema.json +++ b/Product/LoyaltyRuleAction.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyRuleAction.schema.json", - "title": "LoyaltyRuleAction", - "definitions": { - "LoyaltyRuleAction": { - "$id": "#LoyaltyRuleAction", - "description": "Resource containing a the ID of a action to link to a loyalty rule.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty action." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty action." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyRuleAction.schema.json", + "title": "LoyaltyRuleAction", + "definitions": { + "LoyaltyRuleAction": { + "$id": "#LoyaltyRuleAction", + "description": "Resource containing a the ID of a action to link to a loyalty rule.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty action." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty action." + } + } } - } } - } } \ No newline at end of file diff --git a/Product/LoyaltyRuleCondition.schema.json b/Product/LoyaltyRuleCondition.schema.json index b2668147..5c1cecf1 100644 --- a/Product/LoyaltyRuleCondition.schema.json +++ b/Product/LoyaltyRuleCondition.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyRuleCondition.schema.json", - "title": "LoyaltyRuleCondition", - "definitions": { - "LoyaltyRuleCondition": { - "$id": "#LoyaltyRuleCondition", - "description": "Resource containing a the ID of a condition to link to a loyalty rule.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty condition." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty condition." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyRuleCondition.schema.json", + "title": "LoyaltyRuleCondition", + "definitions": { + "LoyaltyRuleCondition": { + "$id": "#LoyaltyRuleCondition", + "description": "Resource containing a the ID of a condition to link to a loyalty rule.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty condition." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty condition." + } + } } - } } - } } \ No newline at end of file diff --git a/Product/LoyaltyRuleEventType.schema.json b/Product/LoyaltyRuleEventType.schema.json index 0d025da1..3d6b1970 100644 --- a/Product/LoyaltyRuleEventType.schema.json +++ b/Product/LoyaltyRuleEventType.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyRuleEventType.schema.json", - "title": "LoyaltyRuleEventType", - "definitions": { - "LoyaltyRuleEventType": { - "$id": "#LoyaltyRuleEventType", - "description": "Resource containing a the ID of a event type to link to a loyalty rule.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty event type." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty event type." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyRuleEventType.schema.json", + "title": "LoyaltyRuleEventType", + "definitions": { + "LoyaltyRuleEventType": { + "$id": "#LoyaltyRuleEventType", + "description": "Resource containing a the ID of a event type to link to a loyalty rule.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty event type." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty event type." + } + } } - } } - } } \ No newline at end of file diff --git a/Product/NetworkProduct.schema.json b/Product/NetworkProduct.schema.json index ce6017b2..7203d354 100644 --- a/Product/NetworkProduct.schema.json +++ b/Product/NetworkProduct.schema.json @@ -1,49 +1,49 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "NetworkProduct.schema.json", - "title": "NetworkProduct", - "definitions": { - "NetworkProduct": { - "$id": "#NetworkProduct", - "type": "object", - "description": "An instantiated network product (specialization of a product) subscribed by a customer.", - "properties": { - "href": { - "type": "string", - "description": "Reference to the network product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the network product" - }, - "name": { - "type": "string", - "description": "Network product name" - }, - "outOfBucketCounter": { - "type": "array", - "description": "Counters detailing usage consumption out of the buckets", - "items": { - "$ref": "ConsumptionSummary.schema.json#ConsumptionSummary" - } - }, - "publicIdentifier": { - "type": "string", - "description": "Public number associated to the network product (msisdn number for mobile line for example)" - }, - "user": { - "type": "array", - "description": "References of the users of the network product", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "NetworkProduct.schema.json", + "title": "NetworkProduct", + "definitions": { + "NetworkProduct": { + "$id": "#NetworkProduct", + "type": "object", + "description": "An instantiated network product (specialization of a product) subscribed by a customer.", + "properties": { + "href": { + "type": "string", + "description": "Reference to the network product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the network product" + }, + "name": { + "type": "string", + "description": "Network product name" + }, + "outOfBucketCounter": { + "type": "array", + "description": "Counters detailing usage consumption out of the buckets", + "items": { + "$ref": "ConsumptionSummary.schema.json#ConsumptionSummary" + } + }, + "publicIdentifier": { + "type": "string", + "description": "Public number associated to the network product (msisdn number for mobile line for example)" + }, + "user": { + "type": "array", + "description": "References of the users of the network product", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/NetworkProductRef.schema.json b/Product/NetworkProductRef.schema.json index 01516aee..e4e3afd5 100644 --- a/Product/NetworkProductRef.schema.json +++ b/Product/NetworkProductRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "NetworkProductRef.schema.json", - "title": "NetworkProductRef", - "definitions": { - "NetworkProductRef": { - "$id": "#NetworkProductRef", - "type": "object", - "description": "Reference of a product", - "properties": { - "@referredType": { - "type": "string", - "description": "Generic attribute indicating the name of the class type of the referred resource entity" - }, - "href": { - "type": "string", - "description": "Reference to the network product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the network product" - }, - "name": { - "type": "string", - "description": "Network product name" - }, - "publicIdentifier": { - "type": "string", - "description": "Public number associated to the product (msisdn number for mobile line for example)" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "NetworkProductRef.schema.json", + "title": "NetworkProductRef", + "definitions": { + "NetworkProductRef": { + "$id": "#NetworkProductRef", + "type": "object", + "description": "Reference of a product", + "properties": { + "@referredType": { + "type": "string", + "description": "Generic attribute indicating the name of the class type of the referred resource entity" + }, + "href": { + "type": "string", + "description": "Reference to the network product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the network product" + }, + "name": { + "type": "string", + "description": "Network product name" + }, + "publicIdentifier": { + "type": "string", + "description": "Public number associated to the product (msisdn number for mobile line for example)" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/OrderStateType.schema.json b/Product/OrderStateType.schema.json index 44c1e225..20085318 100644 --- a/Product/OrderStateType.schema.json +++ b/Product/OrderStateType.schema.json @@ -1,25 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderStateType.schema.json", - "title": "OrderStateType", - "definitions": { - "OrderStateType": { - "$id": "#OrderStateType", - "type": "string", - "description": "Possible values for the state of the order", - "enum": [ - "acknowledged", - "rejected", - "pending", - "held", - "inProgress", - "cancelled", - "completed", - "failed", - "partial", - "assessingCancellation", - "pendingCancellation" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderStateType.schema.json", + "title": "OrderStateType", + "definitions": { + "OrderStateType": { + "$id": "#OrderStateType", + "type": "string", + "description": "Possible values for the state of the order", + "enum": [ + "acknowledged", + "rejected", + "pending", + "held", + "inProgress", + "cancelled", + "completed", + "failed", + "partial", + "assessingCancellation", + "pendingCancellation" + ] + } } - } } \ No newline at end of file diff --git a/Product/PriceAlteration.schema.json b/Product/PriceAlteration.schema.json index 747a86b3..0c1c1179 100644 --- a/Product/PriceAlteration.schema.json +++ b/Product/PriceAlteration.schema.json @@ -1,57 +1,57 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PriceAlteration.schema.json", - "title": "PriceAlteration", - "definitions": { - "PriceAlteration": { - "$id": "#PriceAlteration", - "description": "Is an amount, usually of money, that modifies the price charged for an order item.", - "type": "object", - "required": [ - "priceType", - "price" - ], - "properties": { - "applicationDuration": { - "type": "integer", - "description": "Duration during which the alteration applies on the order item price (for instance 2 months free of charge for the recurring charge)" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail the semantics of this order item price alteration" - }, - "name": { - "type": "string", - "description": "Name of the order item price alteration" - }, - "productOfferingPrice": { - "$ref": "ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" - }, - "priceType": { - "type": "string", - "description": "A category that describes the price such as recurring, one time and usage." - }, - "priority": { - "type": "integer", - "description": "Priority level for applying this alteration among all the defined alterations on the order item price" - }, - "recurringChargePeriod": { - "type": "string", - "description": "Could be month, week..." - }, - "unitOfMeasure": { - "type": "string", - "description": "Could be minutes, GB..." - }, - "price": { - "$ref": "../Customer/Price.schema.json#Price" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PriceAlteration.schema.json", + "title": "PriceAlteration", + "definitions": { + "PriceAlteration": { + "$id": "#PriceAlteration", + "description": "Is an amount, usually of money, that modifies the price charged for an order item.", + "type": "object", + "required": [ + "priceType", + "price" + ], + "properties": { + "applicationDuration": { + "type": "integer", + "description": "Duration during which the alteration applies on the order item price (for instance 2 months free of charge for the recurring charge)" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail the semantics of this order item price alteration" + }, + "name": { + "type": "string", + "description": "Name of the order item price alteration" + }, + "productOfferingPrice": { + "$ref": "ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" + }, + "priceType": { + "type": "string", + "description": "A category that describes the price such as recurring, one time and usage." + }, + "priority": { + "type": "integer", + "description": "Priority level for applying this alteration among all the defined alterations on the order item price" + }, + "recurringChargePeriod": { + "type": "string", + "description": "Could be month, week..." + }, + "unitOfMeasure": { + "type": "string", + "description": "Could be minutes, GB..." + }, + "price": { + "$ref": "../Customer/Price.schema.json#Price" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/PricingLogicAlgorithm.schema.json b/Product/PricingLogicAlgorithm.schema.json index 61af5f22..d9cfb2c6 100644 --- a/Product/PricingLogicAlgorithm.schema.json +++ b/Product/PricingLogicAlgorithm.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PricingLogicAlgorithm.schema.json", - "title": "PricingLogicAlgorithm", - "definitions": { - "PricingLogicAlgorithm": { - "$id": "#PricingLogicAlgorithm", - "type": "object", - "description": "The PricingLogicAlgorithm entity represents an instantiation of an interface specification to external rating function (without a modeled bahavior in SID). Some of the parameters of the interface definiition may be already set (such as price per unit) and some may be gathered during the rating process from the event (such as call duration) or from ProductCharacteristicValues (such as assigned bandwidth)", - "properties": { - "description": { - "type": "string", - "description": "Description of the PricingLogicAlgorithm" - }, - "href": { - "type": "string", - "description": "hyperlink reference of this PricingLogicAlgorithm" - }, - "id": { - "type": "string", - "description": "unique id of the PricingLogicAlgorithm" - }, - "name": { - "type": "string", - "description": "Name given to the PricingLogicAlgorithm" - }, - "plaSpecId": { - "type": "string", - "description": "id of corresponding PricingLogicAlgorithm specification" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the PricingLogicAlgorithm is valid" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PricingLogicAlgorithm.schema.json", + "title": "PricingLogicAlgorithm", + "definitions": { + "PricingLogicAlgorithm": { + "$id": "#PricingLogicAlgorithm", + "type": "object", + "description": "The PricingLogicAlgorithm entity represents an instantiation of an interface specification to external rating function (without a modeled bahavior in SID). Some of the parameters of the interface definiition may be already set (such as price per unit) and some may be gathered during the rating process from the event (such as call duration) or from ProductCharacteristicValues (such as assigned bandwidth)", + "properties": { + "description": { + "type": "string", + "description": "Description of the PricingLogicAlgorithm" + }, + "href": { + "type": "string", + "description": "hyperlink reference of this PricingLogicAlgorithm" + }, + "id": { + "type": "string", + "description": "unique id of the PricingLogicAlgorithm" + }, + "name": { + "type": "string", + "description": "Name given to the PricingLogicAlgorithm" + }, + "plaSpecId": { + "type": "string", + "description": "id of corresponding PricingLogicAlgorithm specification" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the PricingLogicAlgorithm is valid" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/Product.schema.json b/Product/Product.schema.json index fd13fb2b..96969cfa 100644 --- a/Product/Product.schema.json +++ b/Product/Product.schema.json @@ -1,141 +1,141 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Product.schema.json", - "title": "Product", - "definitions": { - "Product": { - "$id": "#Product", - "type": "object", - "description": "A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service(s) and / or resource(s).", - "properties": { - "agreement": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AgreementItemRef.schema.json#AgreementItemRef" - } - }, - "billingAccount": { - "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" - }, - "description": { - "type": "string", - "description": "Is the description of the product. It could be copied from the description of the Product Offering." - }, - "href": { - "type": "string", - "description": "Reference of the product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product" - }, - "isBundle": { - "type": "boolean", - "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." - }, - "isCustomerVisible": { - "type": "boolean", - "description": "If true, the product is visible by the customer." - }, - "name": { - "type": "string", - "description": "Name of the product. It could be the same as the name of the product offering" - }, - "orderDate": { - "type": "string", - "format": "date-time", - "description": "Is the date when the product was ordered" - }, - "productCharacteristic": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - } - }, - "productOffering": { - "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "productOrderItem": { - "type": "array", - "items": { - "$ref": "RelatedProductOrderItem.schema.json#RelatedProductOrderItem" - } - }, - "product": { - "type": "array", - "items": { - "$ref": "ProductRefOrValue.schema.json#ProductRefOrValue" - } - }, - "productPrice": { - "type": "array", - "items": { - "$ref": "ProductPrice.schema.json#ProductPrice" - } - }, - "productRelationship": { - "type": "array", - "items": { - "$ref": "ProductRelationship.schema.json#ProductRelationship" - } - }, - "productSerialNumber": { - "type": "string", - "description": "Is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router." - }, - "productSpecification": { - "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef" - }, - "productTerm": { - "type": "array", - "items": { - "$ref": "ProductTerm.schema.json#ProductTerm" - } - }, - "realizingResource": { - "type": "array", - "items": { - "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" - } - }, - "realizingService": { - "type": "array", - "items": { - "$ref": "../Service/ServiceRef.schema.json#ServiceRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "place": { - "type": "array", - "items": { - "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" - } - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "Is the date from which the product starts" - }, - "status": { - "$ref": "ProductStatusType.schema.json#ProductStatusType", - "description": "Is the lifecycle status of the product." - }, - "terminationDate": { - "type": "string", - "format": "date-time", - "description": "Is the date when the product was terminated" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Product.schema.json", + "title": "Product", + "definitions": { + "Product": { + "$id": "#Product", + "type": "object", + "description": "A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service(s) and / or resource(s).", + "properties": { + "agreement": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementItemRef.schema.json#AgreementItemRef" + } + }, + "billingAccount": { + "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" + }, + "description": { + "type": "string", + "description": "Is the description of the product. It could be copied from the description of the Product Offering." + }, + "href": { + "type": "string", + "description": "Reference of the product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product" + }, + "isBundle": { + "type": "boolean", + "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." + }, + "isCustomerVisible": { + "type": "boolean", + "description": "If true, the product is visible by the customer." + }, + "name": { + "type": "string", + "description": "Name of the product. It could be the same as the name of the product offering" + }, + "orderDate": { + "type": "string", + "format": "date-time", + "description": "Is the date when the product was ordered" + }, + "productCharacteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "productOffering": { + "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "productOrderItem": { + "type": "array", + "items": { + "$ref": "RelatedProductOrderItem.schema.json#RelatedProductOrderItem" + } + }, + "product": { + "type": "array", + "items": { + "$ref": "ProductRefOrValue.schema.json#ProductRefOrValue" + } + }, + "productPrice": { + "type": "array", + "items": { + "$ref": "ProductPrice.schema.json#ProductPrice" + } + }, + "productRelationship": { + "type": "array", + "items": { + "$ref": "ProductRelationship.schema.json#ProductRelationship" + } + }, + "productSerialNumber": { + "type": "string", + "description": "Is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router." + }, + "productSpecification": { + "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef" + }, + "productTerm": { + "type": "array", + "items": { + "$ref": "ProductTerm.schema.json#ProductTerm" + } + }, + "realizingResource": { + "type": "array", + "items": { + "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" + } + }, + "realizingService": { + "type": "array", + "items": { + "$ref": "../Service/ServiceRef.schema.json#ServiceRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "place": { + "type": "array", + "items": { + "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" + } + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "Is the date from which the product starts" + }, + "status": { + "$ref": "ProductStatusType.schema.json#ProductStatusType", + "description": "Is the lifecycle status of the product." + }, + "terminationDate": { + "type": "string", + "format": "date-time", + "description": "Is the date when the product was terminated" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductActionType.schema.json b/Product/ProductActionType.schema.json index 728d5ad1..06db8508 100644 --- a/Product/ProductActionType.schema.json +++ b/Product/ProductActionType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductActionType.schema.json", - "title": "ProductActionType", - "definitions": { - "ProductActionType": { - "$id": "#ProductActionType", - "description": "action to be performed on the product", - "type": "string", - "enum": [ - "add", - "modify", - "delete", - "noChange" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductActionType.schema.json", + "title": "ProductActionType", + "definitions": { + "ProductActionType": { + "$id": "#ProductActionType", + "description": "action to be performed on the product", + "type": "string", + "enum": [ + "add", + "modify", + "delete", + "noChange" + ] + } } - } } \ No newline at end of file diff --git a/Product/ProductCharacteristic.schema.json b/Product/ProductCharacteristic.schema.json index 71ee1d96..f43473ea 100644 --- a/Product/ProductCharacteristic.schema.json +++ b/Product/ProductCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductCharacteristic.schema.json", - "title": "ProductCharacteristic", - "definitions": { - "ProductCharacteristic": { - "$id": "#ProductCharacteristic", - "description": "Characteristics of the product to instantiate or to modify", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "value": { - "type": "string", - "description": "Value of the characteristic" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductCharacteristic.schema.json", + "title": "ProductCharacteristic", + "definitions": { + "ProductCharacteristic": { + "$id": "#ProductCharacteristic", + "description": "Characteristics of the product to instantiate or to modify", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "value": { + "type": "string", + "description": "Value of the characteristic" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductInventoryRelationship.schema.json b/Product/ProductInventoryRelationship.schema.json index 3b0c6e2e..cf0bf96b 100644 --- a/Product/ProductInventoryRelationship.schema.json +++ b/Product/ProductInventoryRelationship.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductInventoryRelationship.schema.json", - "title": "ProductInventoryRelationship", - "definitions": { - "ProductInventoryRelationship": { - "$id": "#ProductInventoryRelationship", - "description": "Linked products to the one instantiate, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful", - "type": "object", - "required": [ - "relationshipType", - "product" - ], - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of the product relationship, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful" - }, - "product": { - "$ref": "ProductRef.schema.json#ProductRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductInventoryRelationship.schema.json", + "title": "ProductInventoryRelationship", + "definitions": { + "ProductInventoryRelationship": { + "$id": "#ProductInventoryRelationship", + "description": "Linked products to the one instantiate, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful", + "type": "object", + "required": [ + "relationshipType", + "product" + ], + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of the product relationship, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful" + }, + "product": { + "$ref": "ProductRef.schema.json#ProductRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductOffering.schema.json b/Product/ProductOffering.schema.json index e9092108..c0b3846a 100644 --- a/Product/ProductOffering.schema.json +++ b/Product/ProductOffering.schema.json @@ -1,150 +1,150 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOffering.schema.json", - "title": "ProductOffering", - "definitions": { - "ProductOffering": { - "$id": "#ProductOffering", - "description": "Represents entities that are orderable from the provider of the catalog, this resource includes pricing information.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the productOffering" - }, - "href": { - "type": "string", - "description": "Reference of the ProductOffering" - }, - "id": { - "type": "string", - "description": "Unique identifier of the productOffering" - }, - "isBundle": { - "type": "boolean", - "description": "isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true)." - }, - "isSellable": { - "type": "boolean", - "description": "A flag indicating if this product offer can be sold stand-alone for sale or not. If this flag is false it indicates that the offer can only be sold within a bundle." - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the productOffering" - }, - "statusReason": { - "type": "string", - "description": "A string providing a complementary information on the value of the lifecycle status attribute." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productOffering is valid" - }, - "version": { - "type": "string", - "description": "ProductOffering version" - }, - "place": { - "type": "array", - "items": { - "$ref": "../Common/PlaceRef.schema.json#PlaceRef" - }, - "description": "Place defines the places where the products are sold or delivered." - }, - "serviceLevelAgreement": { - "$ref": "../EngagedParty/SLARef.schema.json#SLARef", - "description": "A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so forth. The SLA is a set of appropriate procedures and targets formally or informally agreed between parties in order to achieve and maintain specified Quality of Service." - }, - "productSpecification": { - "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef", - "description": "A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role." - }, - "channel": { - "type": "array", - "items": { - "$ref": "../Common/ChannelRef.schema.json#ChannelRef" - }, - "description": "The channel defines the channel for selling product offerings." - }, - "serviceCandidate": { - "$ref": "../Service/ServiceCandidateRef.schema.json#ServiceCandidateRef", - "description": "ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog." - }, - "category": { - "type": "array", - "items": { - "$ref": "CategoryRef.schema.json#CategoryRef" - }, - "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates." - }, - "resourceCandidate": { - "$ref": "../Resource/ResourceCandidateRef.schema.json#ResourceCandidateRef", - "description": "A resource candidate is an entity that makes a ResourceSpecification available to a catalog." - }, - "productOfferingTerm": { - "type": "array", - "items": { - "$ref": "ProductOfferingTerm.schema.json#ProductOfferingTerm" - }, - "description": "A condition under which a ProductOffering is made available to Customers. For instance, a productOffering can be offered with multiple commitment periods." - }, - "productOfferingPrice": { - "type": "array", - "items": { - "$ref": "ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" - }, - "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time and may not represent the actual price paid by a customer." - }, - "agreement": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" - }, - "description": "An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications." - }, - "attachment": { - "type": "array", - "items": { - "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" - }, - "description": "Complements the description of an element (for instance a product) through video, pictures..." - }, - "marketSegment": { - "type": "array", - "items": { - "$ref": "../MarketingSales/MarketSegmentRef.schema.json#MarketSegmentRef" - }, - "description": "provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth." - }, - "bundledProductOffering": { - "type": "array", - "items": { - "$ref": "BundledProductOffering.schema.json#BundledProductOffering" - }, - "description": "A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering." - }, - "prodSpecCharValueUse": { - "type": "array", - "items": { - "$ref": "ProductSpecificationCharacteristicValueUse.schema.json#ProductSpecificationCharacteristicValueUse" - }, - "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOffering.schema.json", + "title": "ProductOffering", + "definitions": { + "ProductOffering": { + "$id": "#ProductOffering", + "description": "Represents entities that are orderable from the provider of the catalog, this resource includes pricing information.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the productOffering" + }, + "href": { + "type": "string", + "description": "Reference of the ProductOffering" + }, + "id": { + "type": "string", + "description": "Unique identifier of the productOffering" + }, + "isBundle": { + "type": "boolean", + "description": "isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true)." + }, + "isSellable": { + "type": "boolean", + "description": "A flag indicating if this product offer can be sold stand-alone for sale or not. If this flag is false it indicates that the offer can only be sold within a bundle." + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the productOffering" + }, + "statusReason": { + "type": "string", + "description": "A string providing a complementary information on the value of the lifecycle status attribute." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productOffering is valid" + }, + "version": { + "type": "string", + "description": "ProductOffering version" + }, + "place": { + "type": "array", + "items": { + "$ref": "../Common/PlaceRef.schema.json#PlaceRef" + }, + "description": "Place defines the places where the products are sold or delivered." + }, + "serviceLevelAgreement": { + "$ref": "../EngagedParty/SLARef.schema.json#SLARef", + "description": "A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so forth. The SLA is a set of appropriate procedures and targets formally or informally agreed between parties in order to achieve and maintain specified Quality of Service." + }, + "productSpecification": { + "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef", + "description": "A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role." + }, + "channel": { + "type": "array", + "items": { + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "description": "The channel defines the channel for selling product offerings." + }, + "serviceCandidate": { + "$ref": "../Service/ServiceCandidateRef.schema.json#ServiceCandidateRef", + "description": "ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog." + }, + "category": { + "type": "array", + "items": { + "$ref": "CategoryRef.schema.json#CategoryRef" + }, + "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates." + }, + "resourceCandidate": { + "$ref": "../Resource/ResourceCandidateRef.schema.json#ResourceCandidateRef", + "description": "A resource candidate is an entity that makes a ResourceSpecification available to a catalog." + }, + "productOfferingTerm": { + "type": "array", + "items": { + "$ref": "ProductOfferingTerm.schema.json#ProductOfferingTerm" + }, + "description": "A condition under which a ProductOffering is made available to Customers. For instance, a productOffering can be offered with multiple commitment periods." + }, + "productOfferingPrice": { + "type": "array", + "items": { + "$ref": "ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" + }, + "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time and may not represent the actual price paid by a customer." + }, + "agreement": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" + }, + "description": "An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications." + }, + "attachment": { + "type": "array", + "items": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + }, + "description": "Complements the description of an element (for instance a product) through video, pictures..." + }, + "marketSegment": { + "type": "array", + "items": { + "$ref": "../MarketingSales/MarketSegmentRef.schema.json#MarketSegmentRef" + }, + "description": "provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth." + }, + "bundledProductOffering": { + "type": "array", + "items": { + "$ref": "BundledProductOffering.schema.json#BundledProductOffering" + }, + "description": "A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering." + }, + "prodSpecCharValueUse": { + "type": "array", + "items": { + "$ref": "ProductSpecificationCharacteristicValueUse.schema.json#ProductSpecificationCharacteristicValueUse" + }, + "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductOfferingPrice.schema.json b/Product/ProductOfferingPrice.schema.json index 507cba64..032ef06e 100644 --- a/Product/ProductOfferingPrice.schema.json +++ b/Product/ProductOfferingPrice.schema.json @@ -1,149 +1,149 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingPrice.schema.json", - "title": "ProductOfferingPrice", - "definitions": { - "ProductOfferingPrice": { - "$id": "#ProductOfferingPrice", - "description": "Is based on both the basic cost to develop and produce products and the enterprises policy on revenue targets. This price may be further revised through discounting (productOfferPriceAlteration). The price, applied for a productOffering may also be influenced by the productOfferingTerm, the customer selected, eg: a productOffering can be offered with multiple terms, like commitment periods for the contract. The price may be influenced by this productOfferingTerm. A productOffering may be cheaper with a 24 month commitment than with a 12 month commitment.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "unique id of this resource" - }, - "href": { - "type": "string", - "description": "Reference of the ProductOfferingPrice" - }, - "name": { - "type": "string", - "description": "Name of the productOfferingPrice" - }, - "description": { - "type": "string", - "description": "Description of the productOfferingPrice" - }, - "version": { - "type": "string", - "description": "ProductOffering version" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productOfferingPrice is valid" - }, - "priceType": { - "type": "string", - "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth." - }, - "unitOfMeasure": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "A number and unit representing how many (for instance 1 dozen) of an ProductOffering is available at the offered price. Its meaning depends on the priceType. It could be a price, a rate, or a discount." - }, - "recurringChargePeriodType": { - "type": "string", - "description": "The period to repeat the application of the price\nCould be month, week..." - }, - "recurringChargePeriodLength": { - "type": "integer", - "description": "the period of the recurring charge: 1, 2, ... .It sets to zero if it is not applicable" - }, - "@type": { - "type": "string", - "description": "The class type of this Product offering" - }, - "@baseType": { - "type": "string", - "description": "the immediate base class type of this product offering" - }, - "@schemaLocation": { - "type": "string", - "description": "hyperlink reference to the schema describing this resource" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "the last update time of this ProductOfferingPrice" - }, - "isBundle": { - "type": "boolean", - "description": "A flag indicating if this ProductOfferingPrice is composite (bundle) or not" - }, - "lifecycleStatus": { - "type": "string", - "description": "the lifecycle status of this ProductOfferingPrice" - }, - "price": { - "$ref": "../Common/Money.schema.json#Money", - "description": "The amount of money that characterizes the price." - }, - "percentage": { - "type": "number", - "format": "float", - "description": "Percentage to apply for ProductOfferPriceAlteration (Discount)" - }, - "bundledPopRelationship": { - "type": "array", - "items": { - "$ref": "BundledProductOfferingPriceRelationship.schema.json#BundledProductOfferingPriceRelationship" - }, - "description": "this object represents a bundle relationship from a bundle product offering price (parent) to a simple product offering price (child). A simple product offering price may participate in more than one bundle relationship." - }, - "popRelationship": { - "type": "array", - "items": { - "$ref": "ProductOfferingPriceRelationship.schema.json#ProductOfferingPriceRelationship" - }, - "description": "Product Offering Prices related to this Product Offering Price, for example a price alteration such as allowance or discount" - }, - "prodSpecCharValueUse": { - "type": "array", - "items": { - "$ref": "ProductSpecificationCharacteristicValueUse.schema.json#ProductSpecificationCharacteristicValueUse" - }, - "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOfferingPrice to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering and ProcuctOfferingPrice level. The list of values in ProductSpecificationCharacteristicValueUse is a strict subset of the list of values as defined in the corresponding product specification characteristics." - }, - "productOfferingTerm": { - "type": "array", - "items": { - "$ref": "ProductOfferingTerm.schema.json#ProductOfferingTerm" - }, - "description": "A list of conditions under which a ProductOfferingPrice is made available to Customers. For instance, a Product Offering Price can be offered with multiple commitment periods." - }, - "place": { - "type": "array", - "items": { - "$ref": "../Common/PlaceRef.schema.json#PlaceRef" - }, - "description": "Place defines the places where the products are sold or delivered." - }, - "constraint": { - "type": "array", - "items": { - "$ref": "../Common/ConstraintRef.schema.json#ConstraintRef" - }, - "description": "The Constraint resource represents a policy/rule applied to ProductOfferingPrice." - }, - "pricingLogicAlgorithm": { - "type": "array", - "items": { - "$ref": "PricingLogicAlgorithm.schema.json#PricingLogicAlgorithm" - }, - "description": "The PricingLogicAlgorithm entity represents an instantiation of an interface specification to external rating function (without a modeled behavior in SID). Some of the parameters of the interface definition may be already set (such as price per unit) and some may be gathered during the rating process from the event (such as call duration) or from ProductCharacteristicValues (such as assigned bandwidth)." - }, - "tax": { - "type": "array", - "items": { - "$ref": "../Customer/TaxItem.schema.json#TaxItem" - }, - "description": "An amount of money levied on the price of a Product by a legislative body." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingPrice.schema.json", + "title": "ProductOfferingPrice", + "definitions": { + "ProductOfferingPrice": { + "$id": "#ProductOfferingPrice", + "description": "Is based on both the basic cost to develop and produce products and the enterprises policy on revenue targets. This price may be further revised through discounting (productOfferPriceAlteration). The price, applied for a productOffering may also be influenced by the productOfferingTerm, the customer selected, eg: a productOffering can be offered with multiple terms, like commitment periods for the contract. The price may be influenced by this productOfferingTerm. A productOffering may be cheaper with a 24 month commitment than with a 12 month commitment.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "unique id of this resource" + }, + "href": { + "type": "string", + "description": "Reference of the ProductOfferingPrice" + }, + "name": { + "type": "string", + "description": "Name of the productOfferingPrice" + }, + "description": { + "type": "string", + "description": "Description of the productOfferingPrice" + }, + "version": { + "type": "string", + "description": "ProductOffering version" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productOfferingPrice is valid" + }, + "priceType": { + "type": "string", + "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth." + }, + "unitOfMeasure": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "A number and unit representing how many (for instance 1 dozen) of an ProductOffering is available at the offered price. Its meaning depends on the priceType. It could be a price, a rate, or a discount." + }, + "recurringChargePeriodType": { + "type": "string", + "description": "The period to repeat the application of the price\nCould be month, week..." + }, + "recurringChargePeriodLength": { + "type": "integer", + "description": "the period of the recurring charge: 1, 2, ... .It sets to zero if it is not applicable" + }, + "@type": { + "type": "string", + "description": "The class type of this Product offering" + }, + "@baseType": { + "type": "string", + "description": "the immediate base class type of this product offering" + }, + "@schemaLocation": { + "type": "string", + "description": "hyperlink reference to the schema describing this resource" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "the last update time of this ProductOfferingPrice" + }, + "isBundle": { + "type": "boolean", + "description": "A flag indicating if this ProductOfferingPrice is composite (bundle) or not" + }, + "lifecycleStatus": { + "type": "string", + "description": "the lifecycle status of this ProductOfferingPrice" + }, + "price": { + "$ref": "../Common/Money.schema.json#Money", + "description": "The amount of money that characterizes the price." + }, + "percentage": { + "type": "number", + "format": "float", + "description": "Percentage to apply for ProductOfferPriceAlteration (Discount)" + }, + "bundledPopRelationship": { + "type": "array", + "items": { + "$ref": "BundledProductOfferingPriceRelationship.schema.json#BundledProductOfferingPriceRelationship" + }, + "description": "this object represents a bundle relationship from a bundle product offering price (parent) to a simple product offering price (child). A simple product offering price may participate in more than one bundle relationship." + }, + "popRelationship": { + "type": "array", + "items": { + "$ref": "ProductOfferingPriceRelationship.schema.json#ProductOfferingPriceRelationship" + }, + "description": "Product Offering Prices related to this Product Offering Price, for example a price alteration such as allowance or discount" + }, + "prodSpecCharValueUse": { + "type": "array", + "items": { + "$ref": "ProductSpecificationCharacteristicValueUse.schema.json#ProductSpecificationCharacteristicValueUse" + }, + "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOfferingPrice to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering and ProcuctOfferingPrice level. The list of values in ProductSpecificationCharacteristicValueUse is a strict subset of the list of values as defined in the corresponding product specification characteristics." + }, + "productOfferingTerm": { + "type": "array", + "items": { + "$ref": "ProductOfferingTerm.schema.json#ProductOfferingTerm" + }, + "description": "A list of conditions under which a ProductOfferingPrice is made available to Customers. For instance, a Product Offering Price can be offered with multiple commitment periods." + }, + "place": { + "type": "array", + "items": { + "$ref": "../Common/PlaceRef.schema.json#PlaceRef" + }, + "description": "Place defines the places where the products are sold or delivered." + }, + "constraint": { + "type": "array", + "items": { + "$ref": "../Common/ConstraintRef.schema.json#ConstraintRef" + }, + "description": "The Constraint resource represents a policy/rule applied to ProductOfferingPrice." + }, + "pricingLogicAlgorithm": { + "type": "array", + "items": { + "$ref": "PricingLogicAlgorithm.schema.json#PricingLogicAlgorithm" + }, + "description": "The PricingLogicAlgorithm entity represents an instantiation of an interface specification to external rating function (without a modeled behavior in SID). Some of the parameters of the interface definition may be already set (such as price per unit) and some may be gathered during the rating process from the event (such as call duration) or from ProductCharacteristicValues (such as assigned bandwidth)." + }, + "tax": { + "type": "array", + "items": { + "$ref": "../Customer/TaxItem.schema.json#TaxItem" + }, + "description": "An amount of money levied on the price of a Product by a legislative body." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductOfferingPriceRef.schema.json b/Product/ProductOfferingPriceRef.schema.json index 1b5dd09c..830eb049 100644 --- a/Product/ProductOfferingPriceRef.schema.json +++ b/Product/ProductOfferingPriceRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingPriceRef.schema.json", - "title": "ProductOfferingPriceRef", - "definitions": { - "ProductOfferingPriceRef": { - "$id": "#ProductOfferingPriceRef", - "description": "ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingPriceRef.schema.json", + "title": "ProductOfferingPriceRef", + "definitions": { + "ProductOfferingPriceRef": { + "$id": "#ProductOfferingPriceRef", + "description": "ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - ] } - } } \ No newline at end of file diff --git a/Product/ProductOfferingPriceRelationship.schema.json b/Product/ProductOfferingPriceRelationship.schema.json index dd7590f9..bfec733d 100644 --- a/Product/ProductOfferingPriceRelationship.schema.json +++ b/Product/ProductOfferingPriceRelationship.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingPriceRelationship.schema.json", - "title": "ProductOfferingPriceRelationship", - "definitions": { - "ProductOfferingPriceRelationship": { - "$id": "#ProductOfferingPriceRelationship", - "type": "object", - "description": "Describes a non-composite relationship between product offering prices. For example one price might be an discount alteration for another price.", - "properties": { - "href": { - "type": "string", - "description": "hyperlink reference of the associated product offering price" - }, - "id": { - "type": "string", - "description": "Unique identifier of the associated product offering price" - }, - "name": { - "type": "string", - "description": "Name of the associated product offering price" - }, - "relationshipType": { - "type": "string", - "description": "type of the relationship, for example override, discount, etc." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingPriceRelationship.schema.json", + "title": "ProductOfferingPriceRelationship", + "definitions": { + "ProductOfferingPriceRelationship": { + "$id": "#ProductOfferingPriceRelationship", + "type": "object", + "description": "Describes a non-composite relationship between product offering prices. For example one price might be an discount alteration for another price.", + "properties": { + "href": { + "type": "string", + "description": "hyperlink reference of the associated product offering price" + }, + "id": { + "type": "string", + "description": "Unique identifier of the associated product offering price" + }, + "name": { + "type": "string", + "description": "Name of the associated product offering price" + }, + "relationshipType": { + "type": "string", + "description": "type of the relationship, for example override, discount, etc." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductOfferingQualification.schema.json b/Product/ProductOfferingQualification.schema.json index 626f1a51..74cd8cfe 100644 --- a/Product/ProductOfferingQualification.schema.json +++ b/Product/ProductOfferingQualification.schema.json @@ -1,109 +1,109 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingQualification.schema.json", - "title": "ProductOfferingQualification", - "definitions": { - "ProductOfferingQualification": { - "$id": "#ProductOfferingQualification", - "type": "object", - "required": [ - "productOfferingQualificationItem" - ], - "description": "ProductOfferingQualification is used to perform a commercial eligibility. It allows to retrieve a list of productOffering that are commercially available in the context of the interaction (defined be place, channel, party, product).", - "properties": { - "channel": { - "description": "Channel used for the qualification", - "$ref": "../Common/ChannelRef.schema.json#ChannelRef" - }, - "description": { - "type": "string", - "description": "Description of the productOfferingQualification" - }, - "effectiveQualificationDate": { - "type": "string", - "format": "date-time", - "description": "Effective date to productOfferingQualification completion" - }, - "expectedPOQCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Date when the requester expect to provide an answer for the qualification request" - }, - "expirationDate": { - "type": "string", - "format": "date-time", - "description": "Date the qualification response expires" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the productOfferingQualification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the productOfferingQualification resource" - }, - "instantSyncQualification": { - "type": "boolean", - "description": "An indicator which when the value is \"true\" means that requester expects to get qualifcation result immediately in the response. If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201." - }, - "note": { - "type": "array", - "description": "Free form text associated with the qualification request", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "productOfferingQualificationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the productOfferingQualification has been submitted" - }, - "productOfferingQualificationItem": { - "type": "array", - "description": "Qualification item for a product or a category", - "items": { - "$ref": "ProductOfferingQualificationItem.schema.json#ProductOfferingQualificationItem" - }, - "minItems": 1 - }, - "provideAlternative": { - "type": "boolean", - "description": "An indicator which when the value is \"true\" means that alternative solutions should be provided" - }, - "provideOnlyAvailable": { - "type": "boolean", - "description": "An indicator which when the value is \"true\" means that only available product offering must be listed in the response" - }, - "provideUnavailabilityReason": { - "type": "boolean", - "description": "An indicator which when the value is \"true\" means that unavailability reason are expected for non available product offering" - }, - "qualificationResult": { - "type": "string", - "description": "Result of the qualification (example: green, yellow, red)" - }, - "relatedParty": { - "type": "array", - "description": "Party playing a role for this qualification (as requester for example)", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "requestedPOQCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Deadline date when the requester expected a qualification answer" - }, - "state": { - "$ref": "../Common/TaskStateType.schema.json#TaskStateType", - "description": "State of the productOfferingQualification defined in the state engine" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingQualification.schema.json", + "title": "ProductOfferingQualification", + "definitions": { + "ProductOfferingQualification": { + "$id": "#ProductOfferingQualification", + "type": "object", + "required": [ + "productOfferingQualificationItem" + ], + "description": "ProductOfferingQualification is used to perform a commercial eligibility. It allows to retrieve a list of productOffering that are commercially available in the context of the interaction (defined be place, channel, party, product).", + "properties": { + "channel": { + "description": "Channel used for the qualification", + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "description": { + "type": "string", + "description": "Description of the productOfferingQualification" + }, + "effectiveQualificationDate": { + "type": "string", + "format": "date-time", + "description": "Effective date to productOfferingQualification completion" + }, + "expectedPOQCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Date when the requester expect to provide an answer for the qualification request" + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "Date the qualification response expires" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the productOfferingQualification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the productOfferingQualification resource" + }, + "instantSyncQualification": { + "type": "boolean", + "description": "An indicator which when the value is \"true\" means that requester expects to get qualifcation result immediately in the response. If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201." + }, + "note": { + "type": "array", + "description": "Free form text associated with the qualification request", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "productOfferingQualificationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the productOfferingQualification has been submitted" + }, + "productOfferingQualificationItem": { + "type": "array", + "description": "Qualification item for a product or a category", + "items": { + "$ref": "ProductOfferingQualificationItem.schema.json#ProductOfferingQualificationItem" + }, + "minItems": 1 + }, + "provideAlternative": { + "type": "boolean", + "description": "An indicator which when the value is \"true\" means that alternative solutions should be provided" + }, + "provideOnlyAvailable": { + "type": "boolean", + "description": "An indicator which when the value is \"true\" means that only available product offering must be listed in the response" + }, + "provideUnavailabilityReason": { + "type": "boolean", + "description": "An indicator which when the value is \"true\" means that unavailability reason are expected for non available product offering" + }, + "qualificationResult": { + "type": "string", + "description": "Result of the qualification (example: green, yellow, red)" + }, + "relatedParty": { + "type": "array", + "description": "Party playing a role for this qualification (as requester for example)", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "requestedPOQCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Deadline date when the requester expected a qualification answer" + }, + "state": { + "$ref": "../Common/TaskStateType.schema.json#TaskStateType", + "description": "State of the productOfferingQualification defined in the state engine" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductOfferingQualificationItem.schema.json b/Product/ProductOfferingQualificationItem.schema.json index db19d102..0d8c97db 100644 --- a/Product/ProductOfferingQualificationItem.schema.json +++ b/Product/ProductOfferingQualificationItem.schema.json @@ -1,78 +1,78 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingQualificationItem.schema.json", - "title": "ProductOfferingQualificationItem", - "definitions": { - "ProductOfferingQualificationItem": { - "$id": "#ProductOfferingQualificationItem", - "type": "object", - "properties": { - "expectedActivationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the requester look for productOfferingQualification activation" - }, - "id": { - "type": "string", - "description": "Id of the productOfferingQualification item" - }, - "action": { - "description": "Can be \"add\" / \"modify\" / \"no_change\"/ \"delete\" - by default add is considered", - "$ref": "ProductActionType.schema.json#ProductActionType" - }, - "qualificationItemResult": { - "type": "string", - "description": "Qualification result for this productOfferingQualification item. It could be:\n\n qualified (request productOffering or productSpecification are available), \n unqualified (requested not available and not alternate available),\n alternate (requested not available but proposal available)\n" - }, - "state": { - "description": "State of the productOfferingQualification item defined in the state engine", - "$ref": "../Common/TaskStateType.schema.json#TaskStateType" - }, - "eligibilityUnavailabilityReason": { - "type": "array", - "items": { - "$ref": "EligibilityUnavailabilityReason.schema.json#EligibilityUnavailabilityReason" - } - }, - "category": { - "$ref": "CategoryRef.schema.json#CategoryRef" - }, - "qualificationItemRelationship": { - "type": "array", - "items": { - "$ref": "QualificationItemRelationship.schema.json#QualificationItemRelationship" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "product": { - "$ref": "ProductRefOrValue.schema.json#ProductRefOrValue" - }, - "terminationError": { - "type": "array", - "items": { - "$ref": "../Service/TerminationError.schema.json#TerminationError" - } - }, - "productOffering": { - "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "alternateProductOfferingProposal": { - "type": "array", - "items": { - "$ref": "AlternateProductOfferingProposal.schema.json#AlternateProductOfferingProposal" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingQualificationItem.schema.json", + "title": "ProductOfferingQualificationItem", + "definitions": { + "ProductOfferingQualificationItem": { + "$id": "#ProductOfferingQualificationItem", + "type": "object", + "properties": { + "expectedActivationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the requester look for productOfferingQualification activation" + }, + "id": { + "type": "string", + "description": "Id of the productOfferingQualification item" + }, + "action": { + "description": "Can be \"add\" / \"modify\" / \"no_change\"/ \"delete\" - by default add is considered", + "$ref": "ProductActionType.schema.json#ProductActionType" + }, + "qualificationItemResult": { + "type": "string", + "description": "Qualification result for this productOfferingQualification item. It could be:\n\n qualified (request productOffering or productSpecification are available), \n unqualified (requested not available and not alternate available),\n alternate (requested not available but proposal available)\n" + }, + "state": { + "description": "State of the productOfferingQualification item defined in the state engine", + "$ref": "../Common/TaskStateType.schema.json#TaskStateType" + }, + "eligibilityUnavailabilityReason": { + "type": "array", + "items": { + "$ref": "EligibilityUnavailabilityReason.schema.json#EligibilityUnavailabilityReason" + } + }, + "category": { + "$ref": "CategoryRef.schema.json#CategoryRef" + }, + "qualificationItemRelationship": { + "type": "array", + "items": { + "$ref": "QualificationItemRelationship.schema.json#QualificationItemRelationship" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "product": { + "$ref": "ProductRefOrValue.schema.json#ProductRefOrValue" + }, + "terminationError": { + "type": "array", + "items": { + "$ref": "../Service/TerminationError.schema.json#TerminationError" + } + }, + "productOffering": { + "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "alternateProductOfferingProposal": { + "type": "array", + "items": { + "$ref": "AlternateProductOfferingProposal.schema.json#AlternateProductOfferingProposal" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductOfferingQualificationItemRef.schema.json b/Product/ProductOfferingQualificationItemRef.schema.json index 4e2fd9f3..d437d635 100644 --- a/Product/ProductOfferingQualificationItemRef.schema.json +++ b/Product/ProductOfferingQualificationItemRef.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingQualificationItemRef.schema.json", - "title": "ProductOfferingQualificationItemRef", - "definitions": { - "ProductOfferingQualificationItemRef": { - "$id": "#ProductOfferingQualificationItemRef", - "type": "object", - "description": "It's a productOfferingQualification item that has been executed previously.", - "required": [ - "id", - "productOfferingQualificationId" - ], - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "productOfferingQualificationHref": { - "type": "string", - "description": "Reference of the related entity." - }, - "productOfferingQualificationId": { - "type": "string", - "description": "Unique identifier of a related entity." - }, - "productOfferingQualificationName": { - "type": "string", - "description": "Name of the related entity." - }, - "id": { - "type": "string", - "description": "Id of an item of a product offering qualification" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingQualificationItemRef.schema.json", + "title": "ProductOfferingQualificationItemRef", + "definitions": { + "ProductOfferingQualificationItemRef": { + "$id": "#ProductOfferingQualificationItemRef", + "type": "object", + "description": "It's a productOfferingQualification item that has been executed previously.", + "required": [ + "id", + "productOfferingQualificationId" + ], + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "productOfferingQualificationHref": { + "type": "string", + "description": "Reference of the related entity." + }, + "productOfferingQualificationId": { + "type": "string", + "description": "Unique identifier of a related entity." + }, + "productOfferingQualificationName": { + "type": "string", + "description": "Name of the related entity." + }, + "id": { + "type": "string", + "description": "Id of an item of a product offering qualification" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductOfferingQualificationRef.schema.json b/Product/ProductOfferingQualificationRef.schema.json index 1763bbc6..350b93cf 100644 --- a/Product/ProductOfferingQualificationRef.schema.json +++ b/Product/ProductOfferingQualificationRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingQualificationRef.schema.json", - "title": "ProductOfferingQualificationRef", - "definitions": { - "ProductOfferingQualificationRef": { - "$id": "#ProductOfferingQualificationRef", - "type": "object", - "description": "It's a productOfferingQualification that has been executed previously", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingQualificationRef.schema.json", + "title": "ProductOfferingQualificationRef", + "definitions": { + "ProductOfferingQualificationRef": { + "$id": "#ProductOfferingQualificationRef", + "type": "object", + "description": "It's a productOfferingQualification that has been executed previously", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - ] } - } } \ No newline at end of file diff --git a/Product/ProductOfferingQualificationStateType.schema.json b/Product/ProductOfferingQualificationStateType.schema.json index d4a07c6c..ccf4d9e2 100644 --- a/Product/ProductOfferingQualificationStateType.schema.json +++ b/Product/ProductOfferingQualificationStateType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingQualificationStateType.schema.json", - "title": "ProductOfferingQualificationStateType", - "definitions": { - "ProductOfferingQualificationStateType": { - "$id": "#ProductOfferingQualificationStateType", - "type": "string", - "description": "Possible values for the state of the product offering qualification & item", - "enum": [ - "acknowledged", - "terminatedWithError", - "inProgress", - "done" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingQualificationStateType.schema.json", + "title": "ProductOfferingQualificationStateType", + "definitions": { + "ProductOfferingQualificationStateType": { + "$id": "#ProductOfferingQualificationStateType", + "type": "string", + "description": "Possible values for the state of the product offering qualification & item", + "enum": [ + "acknowledged", + "terminatedWithError", + "inProgress", + "done" + ] + } } - } } \ No newline at end of file diff --git a/Product/ProductOfferingRef.schema.json b/Product/ProductOfferingRef.schema.json index ab8edd37..dccf75b6 100644 --- a/Product/ProductOfferingRef.schema.json +++ b/Product/ProductOfferingRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingRef.schema.json", - "title": "ProductOfferingRef", - "definitions": { - "ProductOfferingRef": { - "$id": "#ProductOfferingRef", - "description": "ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingRef.schema.json", + "title": "ProductOfferingRef", + "definitions": { + "ProductOfferingRef": { + "$id": "#ProductOfferingRef", + "description": "ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - ] } - } } \ No newline at end of file diff --git a/Product/ProductOfferingTerm.schema.json b/Product/ProductOfferingTerm.schema.json index 3f2fe44e..4cf84a49 100644 --- a/Product/ProductOfferingTerm.schema.json +++ b/Product/ProductOfferingTerm.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingTerm.schema.json", - "title": "ProductOfferingTerm", - "definitions": { - "ProductOfferingTerm": { - "$id": "#ProductOfferingTerm", - "description": "A condition under which a ProductOffering is made available to Customers. For instance, a productOffering can be offered with multiple commitment periods.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the productOfferingTerm" - }, - "duration": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "Duration of the productOfferingTerm" - }, - "name": { - "type": "string", - "description": "Name of the productOfferingTerm" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productOfferingTerm is valid" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingTerm.schema.json", + "title": "ProductOfferingTerm", + "definitions": { + "ProductOfferingTerm": { + "$id": "#ProductOfferingTerm", + "description": "A condition under which a ProductOffering is made available to Customers. For instance, a productOffering can be offered with multiple commitment periods.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the productOfferingTerm" + }, + "duration": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "Duration of the productOfferingTerm" + }, + "name": { + "type": "string", + "description": "Name of the productOfferingTerm" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productOfferingTerm is valid" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductPrice.schema.json b/Product/ProductPrice.schema.json index 2728540c..7959687e 100644 --- a/Product/ProductPrice.schema.json +++ b/Product/ProductPrice.schema.json @@ -1,58 +1,58 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductPrice.schema.json", - "title": "ProductPrice", - "definitions": { - "ProductPrice": { - "$id": "#ProductPrice", - "description": "An amount, usually of money, that represents the actual price paid by a Customer for a purchase, a rent or a lease of a Product. The price is valid for a defined period of time.", - "type": "object", - "required": [ - "priceType", - "price" - ], - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail the semantics of this product price." - }, - "name": { - "type": "string", - "description": "A short descriptive name such as \"Subscription price\"." - }, - "productOfferingPrice": { - "$ref": "ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" - }, - "billingAccount": { - "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" - }, - "priceType": { - "type": "string", - "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth." - }, - "recurringChargePeriod": { - "type": "string", - "description": "Could be month, week..." - }, - "unitOfMeasure": { - "type": "string", - "description": "Could be minutes, GB..." - }, - "productPriceAlteration": { - "type": "array", - "items": { - "$ref": "PriceAlteration.schema.json#PriceAlteration" - } - }, - "price": { - "$ref": "../Customer/Price.schema.json#Price" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductPrice.schema.json", + "title": "ProductPrice", + "definitions": { + "ProductPrice": { + "$id": "#ProductPrice", + "description": "An amount, usually of money, that represents the actual price paid by a Customer for a purchase, a rent or a lease of a Product. The price is valid for a defined period of time.", + "type": "object", + "required": [ + "priceType", + "price" + ], + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail the semantics of this product price." + }, + "name": { + "type": "string", + "description": "A short descriptive name such as \"Subscription price\"." + }, + "productOfferingPrice": { + "$ref": "ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" + }, + "billingAccount": { + "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" + }, + "priceType": { + "type": "string", + "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth." + }, + "recurringChargePeriod": { + "type": "string", + "description": "Could be month, week..." + }, + "unitOfMeasure": { + "type": "string", + "description": "Could be minutes, GB..." + }, + "productPriceAlteration": { + "type": "array", + "items": { + "$ref": "PriceAlteration.schema.json#PriceAlteration" + } + }, + "price": { + "$ref": "../Customer/Price.schema.json#Price" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductRef.schema.json b/Product/ProductRef.schema.json index 385a899c..b0ff84ec 100644 --- a/Product/ProductRef.schema.json +++ b/Product/ProductRef.schema.json @@ -1,17 +1,17 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductRef.schema.json", - "title": "ProductRef", - "definitions": { - "ProductRef": { - "$id": "#ProductRef", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductRef.schema.json", + "title": "ProductRef", + "definitions": { + "ProductRef": { + "$id": "#ProductRef", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - ] } - } } \ No newline at end of file diff --git a/Product/ProductRefOrValue.schema.json b/Product/ProductRefOrValue.schema.json index 9a41704f..66801d88 100644 --- a/Product/ProductRefOrValue.schema.json +++ b/Product/ProductRefOrValue.schema.json @@ -1,21 +1,21 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductRefOrValue.schema.json", - "title": "ProductRefOrValue", - "definitions": { - "ProductRefOrValue": { - "$id": "#ProductRefOrValue", - "description": "A product to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the product entity and not the RelatedProductRefOrValue class itself", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "ProductRef.schema.json#ProductRef" - }, - { - "$ref": "Product.schema.json#Product" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductRefOrValue.schema.json", + "title": "ProductRefOrValue", + "definitions": { + "ProductRefOrValue": { + "$id": "#ProductRefOrValue", + "description": "A product to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the product entity and not the RelatedProductRefOrValue class itself", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "ProductRef.schema.json#ProductRef" + }, + { + "$ref": "Product.schema.json#Product" + } + ] } - ] } - } } \ No newline at end of file diff --git a/Product/ProductRelationship.schema.json b/Product/ProductRelationship.schema.json index 4f5b57bf..8c84bc96 100644 --- a/Product/ProductRelationship.schema.json +++ b/Product/ProductRelationship.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductRelationship.schema.json", - "title": "ProductRelationship", - "definitions": { - "ProductRelationship": { - "$id": "#ProductRelationship", - "description": "Linked products to the one instantiate, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful", - "type": "object", - "required": [ - "relationshipType", - "product" - ], - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of the product relationship, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful" - }, - "product": { - "$ref": "ProductRefOrValue.schema.json#ProductRefOrValue" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductRelationship.schema.json", + "title": "ProductRelationship", + "definitions": { + "ProductRelationship": { + "$id": "#ProductRelationship", + "description": "Linked products to the one instantiate, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful", + "type": "object", + "required": [ + "relationshipType", + "product" + ], + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of the product relationship, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful" + }, + "product": { + "$ref": "ProductRefOrValue.schema.json#ProductRefOrValue" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductRequest.schema.json b/Product/ProductRequest.schema.json index 768a4122..85534b74 100644 --- a/Product/ProductRequest.schema.json +++ b/Product/ProductRequest.schema.json @@ -1,128 +1,128 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductRequest.schema.json", - "title": "ProductRequest", - "definitions": { - "ProductRequest": { - "$id": "#ProductRequest", - "type": "object", - "properties": { - "referredProduct": { - "$ref": "ProductRef.schema.json#ProductRef" - }, - "description": { - "type": "string", - "description": "Is the description of the product. It could be copied from the description of the Product Offering." - }, - "href": { - "type": "string", - "description": "Reference of the product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product" - }, - "isBundle": { - "type": "boolean", - "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." - }, - "isCustomerVisible": { - "type": "boolean", - "description": "If true, the product is visible by the customer." - }, - "name": { - "type": "string", - "description": "Name of the product. It could be the same as the name of the product offering" - }, - "orderDate": { - "type": "string", - "format": "date-time", - "description": "Is the date when the product was ordered" - }, - "productSerialNumber": { - "type": "string", - "description": "Is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router." - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "Is the date from which the product starts" - }, - "status": { - "type": "string", - "description": "Is the lifecycle status of the product." - }, - "terminationDate": { - "type": "string", - "format": "date-time", - "description": "Is the date when the product was terminated" - }, - "realizingService": { - "type": "array", - "items": { - "$ref": "../Service/ServiceRef.schema.json#ServiceRef" - } - }, - "billingAccount": { - "type": "array", - "items": { - "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" - } - }, - "productOffering": { - "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "agreement": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "ProductCharacteristic.schema.json#ProductCharacteristic" - } - }, - "productRelationship": { - "type": "array", - "items": { - "$ref": "ProductRelationship.schema.json#ProductRelationship" - } - }, - "realizingResource": { - "type": "array", - "items": { - "$ref": "../Resource/RealizingResourceRef.schema.json#RealizingResourceRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "productPrice": { - "type": "array", - "items": { - "$ref": "ProductPrice.schema.json#ProductPrice" - } - }, - "productSpecification": { - "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef" - }, - "place": { - "type": "array", - "items": { - "$ref": "../Common/Place.schema.json#Place" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductRequest.schema.json", + "title": "ProductRequest", + "definitions": { + "ProductRequest": { + "$id": "#ProductRequest", + "type": "object", + "properties": { + "referredProduct": { + "$ref": "ProductRef.schema.json#ProductRef" + }, + "description": { + "type": "string", + "description": "Is the description of the product. It could be copied from the description of the Product Offering." + }, + "href": { + "type": "string", + "description": "Reference of the product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product" + }, + "isBundle": { + "type": "boolean", + "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." + }, + "isCustomerVisible": { + "type": "boolean", + "description": "If true, the product is visible by the customer." + }, + "name": { + "type": "string", + "description": "Name of the product. It could be the same as the name of the product offering" + }, + "orderDate": { + "type": "string", + "format": "date-time", + "description": "Is the date when the product was ordered" + }, + "productSerialNumber": { + "type": "string", + "description": "Is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router." + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "Is the date from which the product starts" + }, + "status": { + "type": "string", + "description": "Is the lifecycle status of the product." + }, + "terminationDate": { + "type": "string", + "format": "date-time", + "description": "Is the date when the product was terminated" + }, + "realizingService": { + "type": "array", + "items": { + "$ref": "../Service/ServiceRef.schema.json#ServiceRef" + } + }, + "billingAccount": { + "type": "array", + "items": { + "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" + } + }, + "productOffering": { + "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "agreement": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "ProductCharacteristic.schema.json#ProductCharacteristic" + } + }, + "productRelationship": { + "type": "array", + "items": { + "$ref": "ProductRelationship.schema.json#ProductRelationship" + } + }, + "realizingResource": { + "type": "array", + "items": { + "$ref": "../Resource/RealizingResourceRef.schema.json#RealizingResourceRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "productPrice": { + "type": "array", + "items": { + "$ref": "ProductPrice.schema.json#ProductPrice" + } + }, + "productSpecification": { + "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef" + }, + "place": { + "type": "array", + "items": { + "$ref": "../Common/Place.schema.json#Place" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductRestriction.schema.json b/Product/ProductRestriction.schema.json index 7dce1656..09d68388 100644 --- a/Product/ProductRestriction.schema.json +++ b/Product/ProductRestriction.schema.json @@ -1,58 +1,58 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductRestriction.schema.json", - "title": "ProductRestriction", - "definitions": { - "ProductRestriction": { - "$id": "#ProductRestriction", - "description": "In the context of a product order or a product offering qualification, this data structure captures the product information useful to order or qualified an existing subscribed product or to a new one. This is a subset of relevant product attributes for ordering and qualification", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product" - }, - "name": { - "type": "string", - "description": "This is the name of the product." - }, - "productCharacteristic": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - } - }, - "productRelationship": { - "type": "array", - "items": { - "$ref": "ProductRelationship.schema.json#ProductRelationship" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - } - }, - "productSpecification": { - "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef" - }, - "relatedPlace": { - "type": "array", - "items": { - "$ref": "../Common/RelatedPlace.schema.json#RelatedPlace" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductRestriction.schema.json", + "title": "ProductRestriction", + "definitions": { + "ProductRestriction": { + "$id": "#ProductRestriction", + "description": "In the context of a product order or a product offering qualification, this data structure captures the product information useful to order or qualified an existing subscribed product or to a new one. This is a subset of relevant product attributes for ordering and qualification", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product" + }, + "name": { + "type": "string", + "description": "This is the name of the product." + }, + "productCharacteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "productRelationship": { + "type": "array", + "items": { + "$ref": "ProductRelationship.schema.json#ProductRelationship" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + } + }, + "productSpecification": { + "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef" + }, + "relatedPlace": { + "type": "array", + "items": { + "$ref": "../Common/RelatedPlace.schema.json#RelatedPlace" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductSpecCharRelationship.schema.json b/Product/ProductSpecCharRelationship.schema.json index c3309c4e..b005c94e 100644 --- a/Product/ProductSpecCharRelationship.schema.json +++ b/Product/ProductSpecCharRelationship.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecCharRelationship.schema.json", - "title": "ProductSpecCharRelationship", - "definitions": { - "ProductSpecCharRelationship": { - "$id": "#ProductSpecCharRelationship", - "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productSpecCharRelationship is valid" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecCharRelationship.schema.json", + "title": "ProductSpecCharRelationship", + "definitions": { + "ProductSpecCharRelationship": { + "$id": "#ProductSpecCharRelationship", + "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productSpecCharRelationship is valid" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductSpecCharacteristic.schema.json b/Product/ProductSpecCharacteristic.schema.json index ca95d109..dc11e61b 100644 --- a/Product/ProductSpecCharacteristic.schema.json +++ b/Product/ProductSpecCharacteristic.schema.json @@ -1,51 +1,51 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecCharacteristic.schema.json", - "title": "ProductSpecCharacteristic", - "definitions": { - "ProductSpecCharacteristic": { - "$id": "#ProductSpecCharacteristic", - "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", - "type": "object", - "properties": { - "configurable": { - "type": "boolean", - "description": "If true, the Boolean indicates that the productSpecCharacteristic is configurable" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the productSpecCharacteristic is" - }, - "name": { - "type": "string", - "description": "Name of the productSpecCharacteristic" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productSpecCharacteristic is valid" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" - }, - "productSpecCharRelationship": { - "type": "array", - "items": { - "$ref": "ProductSpecCharRelationship.schema.json#ProductSpecCharRelationship" - } - }, - "productSpecCharacteristicValue": { - "type": "array", - "items": { - "$ref": "ProductSpecCharacteristicValue.schema.json#ProductSpecCharacteristicValue" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecCharacteristic.schema.json", + "title": "ProductSpecCharacteristic", + "definitions": { + "ProductSpecCharacteristic": { + "$id": "#ProductSpecCharacteristic", + "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", + "type": "object", + "properties": { + "configurable": { + "type": "boolean", + "description": "If true, the Boolean indicates that the productSpecCharacteristic is configurable" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the productSpecCharacteristic is" + }, + "name": { + "type": "string", + "description": "Name of the productSpecCharacteristic" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productSpecCharacteristic is valid" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" + }, + "productSpecCharRelationship": { + "type": "array", + "items": { + "$ref": "ProductSpecCharRelationship.schema.json#ProductSpecCharRelationship" + } + }, + "productSpecCharacteristicValue": { + "type": "array", + "items": { + "$ref": "ProductSpecCharacteristicValue.schema.json#ProductSpecCharacteristicValue" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductSpecCharacteristicValue.schema.json b/Product/ProductSpecCharacteristicValue.schema.json index 83df6a8e..60ddb502 100644 --- a/Product/ProductSpecCharacteristicValue.schema.json +++ b/Product/ProductSpecCharacteristicValue.schema.json @@ -1,47 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecCharacteristicValue.schema.json", - "title": "ProductSpecCharacteristicValue", - "definitions": { - "ProductSpecCharacteristicValue": { - "$id": "#ProductSpecCharacteristicValue", - "description": "A number or text that can be assigned to a ProductSpecCharacteristic.", - "type": "object", - "properties": { - "default": { - "type": "boolean", - "description": "Indicates if the value is the default value for a characteristic" - }, - "unitOfMeasure": { - "type": "string", - "description": "Could be minutes, GB..." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period of time for which a value is applicable" - }, - "value": { - "type": "string", - "description": "A discrete value that the characteristic can take on" - }, - "valueFrom": { - "type": "string", - "description": "The low range value that a characteristic can take on" - }, - "valueTo": { - "type": "string", - "description": "The upper range value that a characteristic can take on" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecCharacteristicValue.schema.json", + "title": "ProductSpecCharacteristicValue", + "definitions": { + "ProductSpecCharacteristicValue": { + "$id": "#ProductSpecCharacteristicValue", + "description": "A number or text that can be assigned to a ProductSpecCharacteristic.", + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Indicates if the value is the default value for a characteristic" + }, + "unitOfMeasure": { + "type": "string", + "description": "Could be minutes, GB..." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period of time for which a value is applicable" + }, + "value": { + "type": "string", + "description": "A discrete value that the characteristic can take on" + }, + "valueFrom": { + "type": "string", + "description": "The low range value that a characteristic can take on" + }, + "valueTo": { + "type": "string", + "description": "The upper range value that a characteristic can take on" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductSpecification.schema.json b/Product/ProductSpecification.schema.json index d9af7319..4f7ba3b6 100644 --- a/Product/ProductSpecification.schema.json +++ b/Product/ProductSpecification.schema.json @@ -1,117 +1,117 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecification.schema.json", - "title": "ProductSpecification", - "definitions": { - "ProductSpecification": { - "$id": "#ProductSpecification", - "description": "Is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.", - "type": "object", - "properties": { - "brand": { - "type": "string", - "description": "The manufacturer or trademark of the specification" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the product specification is" - }, - "href": { - "type": "string", - "description": "Reference of the product specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product specification" - }, - "isBundle": { - "type": "boolean", - "description": "isBundle determines whether a productSpecification represents a single productSpecification (false), or a bundle of productSpecification (true)." - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the product specification" - }, - "productNumber": { - "type": "string", - "description": "An identification number assigned to uniquely identity the specification" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the product specification is valid" - }, - "version": { - "type": "string", - "description": "Product specification version" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "description": "A related party defines party or party role linked to a specific entity." - }, - "productSpecCharacteristic": { - "type": "array", - "items": { - "$ref": "ProductSpecificationCharacteristic.schema.json#ProductSpecificationCharacteristic" - }, - "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process." - }, - "serviceSpecification": { - "type": "array", - "items": { - "$ref": "../Service/ServiceSpecificationRef.schema.json#ServiceSpecificationRef" - }, - "description": "ServiceSpecification(s) required to realize a ProductSpecification." - }, - "productSpecificationRelationship": { - "type": "array", - "items": { - "$ref": "ProductSpecificationRelationship.schema.json#ProductSpecificationRelationship" - }, - "description": "A migration, substitution, dependency or exclusivity relationship between/among product specifications." - }, - "resourceSpecification": { - "type": "array", - "items": { - "$ref": "../Resource/ResourceSpecificationRef.schema.json#ResourceSpecificationRef" - }, - "description": "The ResourceSpecification is required to realize a ProductSpecification." - }, - "attachment": { - "type": "array", - "items": { - "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" - }, - "description": "Complements the description of an element (for instance a product) through video, pictures..." - }, - "bundledProductSpecification": { - "type": "array", - "items": { - "$ref": "BundledProductSpecification.schema.json#BundledProductSpecification" - }, - "description": "A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification." - }, - "targetProductSchema": { - "description": "A target product schema reference. The reference object to the schema and type of target product which is described by product specification.", - "$ref": "TargetProductSchema.schema.json#TargetProductSchema" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecification.schema.json", + "title": "ProductSpecification", + "definitions": { + "ProductSpecification": { + "$id": "#ProductSpecification", + "description": "Is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.", + "type": "object", + "properties": { + "brand": { + "type": "string", + "description": "The manufacturer or trademark of the specification" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the product specification is" + }, + "href": { + "type": "string", + "description": "Reference of the product specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product specification" + }, + "isBundle": { + "type": "boolean", + "description": "isBundle determines whether a productSpecification represents a single productSpecification (false), or a bundle of productSpecification (true)." + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the product specification" + }, + "productNumber": { + "type": "string", + "description": "An identification number assigned to uniquely identity the specification" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the product specification is valid" + }, + "version": { + "type": "string", + "description": "Product specification version" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "A related party defines party or party role linked to a specific entity." + }, + "productSpecCharacteristic": { + "type": "array", + "items": { + "$ref": "ProductSpecificationCharacteristic.schema.json#ProductSpecificationCharacteristic" + }, + "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process." + }, + "serviceSpecification": { + "type": "array", + "items": { + "$ref": "../Service/ServiceSpecificationRef.schema.json#ServiceSpecificationRef" + }, + "description": "ServiceSpecification(s) required to realize a ProductSpecification." + }, + "productSpecificationRelationship": { + "type": "array", + "items": { + "$ref": "ProductSpecificationRelationship.schema.json#ProductSpecificationRelationship" + }, + "description": "A migration, substitution, dependency or exclusivity relationship between/among product specifications." + }, + "resourceSpecification": { + "type": "array", + "items": { + "$ref": "../Resource/ResourceSpecificationRef.schema.json#ResourceSpecificationRef" + }, + "description": "The ResourceSpecification is required to realize a ProductSpecification." + }, + "attachment": { + "type": "array", + "items": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + }, + "description": "Complements the description of an element (for instance a product) through video, pictures..." + }, + "bundledProductSpecification": { + "type": "array", + "items": { + "$ref": "BundledProductSpecification.schema.json#BundledProductSpecification" + }, + "description": "A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification." + }, + "targetProductSchema": { + "description": "A target product schema reference. The reference object to the schema and type of target product which is described by product specification.", + "$ref": "TargetProductSchema.schema.json#TargetProductSchema" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductSpecificationCharacteristic.schema.json b/Product/ProductSpecificationCharacteristic.schema.json index 73384c37..b427e84c 100644 --- a/Product/ProductSpecificationCharacteristic.schema.json +++ b/Product/ProductSpecificationCharacteristic.schema.json @@ -1,73 +1,73 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationCharacteristic.schema.json", - "title": "ProductSpecificationCharacteristic", - "definitions": { - "ProductSpecificationCharacteristic": { - "$id": "#ProductSpecificationCharacteristic", - "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", - "type": "object", - "properties": { - "configurable": { - "type": "boolean", - "description": "If true, the Boolean indicates that the ProductSpecificationCharacteristic is configurable" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the ProductSpecificationCharacteristic is" - }, - "extensible": { - "type": "boolean", - "description": "An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a product" - }, - "isUnique": { - "type": "boolean", - "description": "An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"" - }, - "maxCardinality": { - "type": "integer", - "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality" - }, - "minCardinality": { - "type": "integer", - "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality" - }, - "name": { - "type": "string", - "description": "Name of the ProductSpecificationCharacteristic" - }, - "regex": { - "type": "string", - "description": "A rule or principle represented in regular expression used to derive the value of a characteristic value" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" - }, - "productSpecCharacteristicValue": { - "type": "array", - "items": { - "$ref": "ProductSpecificationCharacteristicValue.schema.json#ProductSpecificationCharacteristicValue" - }, - "description": "A ProductSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ProductSpecificationCharacteristic object. The values of the attributes in the ProductSpecificationCharacteristicValue object describe the values of the attributes that a corresponding ProductSpecificationCharacteristic object can take on." - }, - "productSpecCharRelationship": { - "type": "array", - "items": { - "$ref": "ProductSpecificationCharacteristicRelationship.schema.json#ProductSpecificationCharacteristicRelationship" - }, - "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the ProductSpecificationCharacteristic is valid" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationCharacteristic.schema.json", + "title": "ProductSpecificationCharacteristic", + "definitions": { + "ProductSpecificationCharacteristic": { + "$id": "#ProductSpecificationCharacteristic", + "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", + "type": "object", + "properties": { + "configurable": { + "type": "boolean", + "description": "If true, the Boolean indicates that the ProductSpecificationCharacteristic is configurable" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the ProductSpecificationCharacteristic is" + }, + "extensible": { + "type": "boolean", + "description": "An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a product" + }, + "isUnique": { + "type": "boolean", + "description": "An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"" + }, + "maxCardinality": { + "type": "integer", + "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality" + }, + "minCardinality": { + "type": "integer", + "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality" + }, + "name": { + "type": "string", + "description": "Name of the ProductSpecificationCharacteristic" + }, + "regex": { + "type": "string", + "description": "A rule or principle represented in regular expression used to derive the value of a characteristic value" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" + }, + "productSpecCharacteristicValue": { + "type": "array", + "items": { + "$ref": "ProductSpecificationCharacteristicValue.schema.json#ProductSpecificationCharacteristicValue" + }, + "description": "A ProductSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ProductSpecificationCharacteristic object. The values of the attributes in the ProductSpecificationCharacteristicValue object describe the values of the attributes that a corresponding ProductSpecificationCharacteristic object can take on." + }, + "productSpecCharRelationship": { + "type": "array", + "items": { + "$ref": "ProductSpecificationCharacteristicRelationship.schema.json#ProductSpecificationCharacteristicRelationship" + }, + "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the ProductSpecificationCharacteristic is valid" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductSpecificationCharacteristicRelationship.schema.json b/Product/ProductSpecificationCharacteristicRelationship.schema.json index 67981387..f060913a 100644 --- a/Product/ProductSpecificationCharacteristicRelationship.schema.json +++ b/Product/ProductSpecificationCharacteristicRelationship.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationCharacteristicRelationship.schema.json", - "title": "ProductSpecificationCharacteristicRelationship", - "definitions": { - "ProductSpecificationCharacteristicRelationship": { - "$id": "#ProductSpecificationCharacteristicRelationship", - "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecificationCharacteristics.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "the identifier of the associated product specification" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to the target product specification" - }, - "charSpecSeq": { - "type": "integer", - "description": "The order in which a CharacteristicSpecification appears within another CharacteristicSpecification that defines a grouping of CharacteristicSpecifications.\n\nFor example, a grouping may represent the name of an individual. The given name is first, the middle name is second, and the last name is third." - }, - "name": { - "type": "string", - "description": "Name of the target product specification characteristic" - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productSpecificationCharacteristicRelationship is valid" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationCharacteristicRelationship.schema.json", + "title": "ProductSpecificationCharacteristicRelationship", + "definitions": { + "ProductSpecificationCharacteristicRelationship": { + "$id": "#ProductSpecificationCharacteristicRelationship", + "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecificationCharacteristics.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "the identifier of the associated product specification" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to the target product specification" + }, + "charSpecSeq": { + "type": "integer", + "description": "The order in which a CharacteristicSpecification appears within another CharacteristicSpecification that defines a grouping of CharacteristicSpecifications.\n\nFor example, a grouping may represent the name of an individual. The given name is first, the middle name is second, and the last name is third." + }, + "name": { + "type": "string", + "description": "Name of the target product specification characteristic" + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productSpecificationCharacteristicRelationship is valid" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductSpecificationCharacteristicValue.schema.json b/Product/ProductSpecificationCharacteristicValue.schema.json index 95e1d7b7..c60c7dfe 100644 --- a/Product/ProductSpecificationCharacteristicValue.schema.json +++ b/Product/ProductSpecificationCharacteristicValue.schema.json @@ -1,55 +1,55 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationCharacteristicValue.schema.json", - "title": "ProductSpecificationCharacteristicValue", - "definitions": { - "ProductSpecificationCharacteristicValue": { - "$id": "#ProductSpecificationCharacteristicValue", - "description": "A ProductSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ProductSpecificationCharacteristic object. The values of the attributes in the ProductSpecificationCharacteristicValue object describe the values of the attributes that a corresponding ProductSpecificationCharacteristic object can take on.", - "type": "object", - "properties": { - "isDefault": { - "type": "boolean", - "description": "Indicates if the value is the default value for a characteristic" - }, - "rangeInterval": { - "type": "string", - "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." - }, - "regex": { - "type": "string", - "description": "Regular expression to define constraint on the allowed value" - }, - "unitOfMeasure": { - "type": "string", - "description": "A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period of time for which a value is applicable" - }, - "value": { - "$ref": "../Common/Any.schema.json#Any", - "description": "A discrete value that the characteristic can take on, or the actual value of the characteristic" - }, - "valueFrom": { - "type": "string", - "description": "The low range value that a characteristic can take on" - }, - "valueTo": { - "type": "string", - "description": "The upper range value that a characteristic can take on" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationCharacteristicValue.schema.json", + "title": "ProductSpecificationCharacteristicValue", + "definitions": { + "ProductSpecificationCharacteristicValue": { + "$id": "#ProductSpecificationCharacteristicValue", + "description": "A ProductSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ProductSpecificationCharacteristic object. The values of the attributes in the ProductSpecificationCharacteristicValue object describe the values of the attributes that a corresponding ProductSpecificationCharacteristic object can take on.", + "type": "object", + "properties": { + "isDefault": { + "type": "boolean", + "description": "Indicates if the value is the default value for a characteristic" + }, + "rangeInterval": { + "type": "string", + "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." + }, + "regex": { + "type": "string", + "description": "Regular expression to define constraint on the allowed value" + }, + "unitOfMeasure": { + "type": "string", + "description": "A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period of time for which a value is applicable" + }, + "value": { + "$ref": "../Common/Any.schema.json#Any", + "description": "A discrete value that the characteristic can take on, or the actual value of the characteristic" + }, + "valueFrom": { + "type": "string", + "description": "The low range value that a characteristic can take on" + }, + "valueTo": { + "type": "string", + "description": "The upper range value that a characteristic can take on" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductSpecificationCharacteristicValueUse.schema.json b/Product/ProductSpecificationCharacteristicValueUse.schema.json index bab86723..ed1f2415 100644 --- a/Product/ProductSpecificationCharacteristicValueUse.schema.json +++ b/Product/ProductSpecificationCharacteristicValueUse.schema.json @@ -1,49 +1,49 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationCharacteristicValueUse.schema.json", - "title": "ProductSpecificationCharacteristicValueUse", - "definitions": { - "ProductSpecificationCharacteristicValueUse": { - "$id": "#ProductSpecificationCharacteristicValueUse", - "type": "object", - "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.", - "properties": { - "name": { - "type": "string", - "description": "Name of the associated productSpecificationCharacteristic" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the productSpecificationCharacteristic is" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" - }, - "minCardinality": { - "type": "integer", - "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality." - }, - "maxCardinality": { - "type": "integer", - "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productSpecificationCharacteristic is valid" - }, - "productSpecCharacteristicValue": { - "type": "array", - "items": { - "$ref": "ProductSpecificationCharacteristicValue.schema.json#ProductSpecificationCharacteristicValue" - }, - "description": "A number or text that can be assigned to a ProductSpecificationCharacteristic." - }, - "productSpecification": { - "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef", - "description": "A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationCharacteristicValueUse.schema.json", + "title": "ProductSpecificationCharacteristicValueUse", + "definitions": { + "ProductSpecificationCharacteristicValueUse": { + "$id": "#ProductSpecificationCharacteristicValueUse", + "type": "object", + "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.", + "properties": { + "name": { + "type": "string", + "description": "Name of the associated productSpecificationCharacteristic" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the productSpecificationCharacteristic is" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" + }, + "minCardinality": { + "type": "integer", + "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality." + }, + "maxCardinality": { + "type": "integer", + "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productSpecificationCharacteristic is valid" + }, + "productSpecCharacteristicValue": { + "type": "array", + "items": { + "$ref": "ProductSpecificationCharacteristicValue.schema.json#ProductSpecificationCharacteristicValue" + }, + "description": "A number or text that can be assigned to a ProductSpecificationCharacteristic." + }, + "productSpecification": { + "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef", + "description": "A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role." + } + } } - } } - } } \ No newline at end of file diff --git a/Product/ProductSpecificationRef.schema.json b/Product/ProductSpecificationRef.schema.json index 9181158d..84bbfe76 100644 --- a/Product/ProductSpecificationRef.schema.json +++ b/Product/ProductSpecificationRef.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationRef.schema.json", - "title": "ProductSpecificationRef", - "definitions": { - "ProductSpecificationRef": { - "$id": "#ProductSpecificationRef", - "description": "Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.", - "type": "object", - "properties": { - "version": { - "type": "string", - "description": "Version of the product specification" - }, - "targetProductSchema": { - "description": "A target product schema reference. The reference object to the schema and type of target product which is described by product specification.", - "$ref": "TargetProductSchema.schema.json#TargetProductSchema" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationRef.schema.json", + "title": "ProductSpecificationRef", + "definitions": { + "ProductSpecificationRef": { + "$id": "#ProductSpecificationRef", + "description": "Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "Version of the product specification" + }, + "targetProductSchema": { + "description": "A target product schema reference. The reference object to the schema and type of target product which is described by product specification.", + "$ref": "TargetProductSchema.schema.json#TargetProductSchema" + } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductSpecificationRelationship.schema.json b/Product/ProductSpecificationRelationship.schema.json index 4c8fd480..577e0ce6 100644 --- a/Product/ProductSpecificationRelationship.schema.json +++ b/Product/ProductSpecificationRelationship.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationRelationship.schema.json", - "title": "ProductSpecificationRelationship", - "definitions": { - "ProductSpecificationRelationship": { - "$id": "#ProductSpecificationRelationship", - "description": "A migration, substitution, dependency or exclusivity relationship between/among product specifications.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the productSpecification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the productSpecification" - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship such as migration, substitution, dependency, exclusivity" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productSpecificationRelationship is valid" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationRelationship.schema.json", + "title": "ProductSpecificationRelationship", + "definitions": { + "ProductSpecificationRelationship": { + "$id": "#ProductSpecificationRelationship", + "description": "A migration, substitution, dependency or exclusivity relationship between/among product specifications.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the productSpecification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the productSpecification" + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship such as migration, substitution, dependency, exclusivity" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productSpecificationRelationship is valid" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductSpecificationSchemaRef.schema.json b/Product/ProductSpecificationSchemaRef.schema.json index 1f6e3497..b2d5074a 100644 --- a/Product/ProductSpecificationSchemaRef.schema.json +++ b/Product/ProductSpecificationSchemaRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationSchemaRef.schema.json", - "title": "ProductSpecificationSchemaRef", - "definitions": { - "ProductSpecificationSchemaRef": { - "$id": "#ProductSpecificationSchemaRef", - "description": "ProductSpecification description could be done with schema use. This information allows to retrieve schema type and location", - "type": "object", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationSchemaRef.schema.json", + "title": "ProductSpecificationSchemaRef", + "definitions": { + "ProductSpecificationSchemaRef": { + "$id": "#ProductSpecificationSchemaRef", + "description": "ProductSpecification description could be done with schema use. This information allows to retrieve schema type and location", + "type": "object", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/ProductStatusType.schema.json b/Product/ProductStatusType.schema.json index 5d06efb3..da3e0700 100644 --- a/Product/ProductStatusType.schema.json +++ b/Product/ProductStatusType.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductStatusType.schema.json", - "title": "ProductStatusType", - "definitions": { - "ProductStatusType": { - "$id": "#ProductStatusType", - "type": "string", - "description": "Possible values for the status of the product", - "enum": [ - "created", - "pendingActive", - "cancelled", - "active", - "pendingTerminate", - "terminated", - "suspended", - "aborted " - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductStatusType.schema.json", + "title": "ProductStatusType", + "definitions": { + "ProductStatusType": { + "$id": "#ProductStatusType", + "type": "string", + "description": "Possible values for the status of the product", + "enum": [ + "created", + "pendingActive", + "cancelled", + "active", + "pendingTerminate", + "terminated", + "suspended", + "aborted " + ] + } } - } } \ No newline at end of file diff --git a/Product/ProductTerm.schema.json b/Product/ProductTerm.schema.json index cc5ebcca..800b343b 100644 --- a/Product/ProductTerm.schema.json +++ b/Product/ProductTerm.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductTerm.schema.json", - "title": "ProductTerm", - "definitions": { - "ProductTerm": { - "$id": "#ProductTerm", - "description": "Description of a productTerm linked to this product. This represent a commitment with a duration", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the productTerm" - }, - "duration": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "Duration of the productTerm" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "productTerm validity period" - }, - "name": { - "type": "string", - "description": "Name of the productTerm" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductTerm.schema.json", + "title": "ProductTerm", + "definitions": { + "ProductTerm": { + "$id": "#ProductTerm", + "description": "Description of a productTerm linked to this product. This represent a commitment with a duration", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the productTerm" + }, + "duration": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "Duration of the productTerm" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "productTerm validity period" + }, + "name": { + "type": "string", + "description": "Name of the productTerm" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/Promotion.schema.json b/Product/Promotion.schema.json index bac5d930..bd5b9be0 100644 --- a/Product/Promotion.schema.json +++ b/Product/Promotion.schema.json @@ -1,58 +1,58 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Promotion.schema.json", - "title": "Promotion", - "definitions": { - "Promotion": { - "$id": "#Promotion", - "description": "Promotion Resource is used to provide the additional discount, voucher, bonus or gift to the customer who meets the pre-defined criteria. Using promotion, the enterprise is able to attract the users and encourage more consumption, especially continuous purchases. Normally Promotion is not regarded as one type of product or product offering. It is often applied when the customer buys the product offerings with the price or amount surpassing the certain limit.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of Promotion" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the Promotion" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Promotion" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Latest update date of the Promotion" - }, - "lifecycleStatus": { - "type": "string", - "description": "Status of the Promotion, including Draft/Test/WaitForApproval/Release/Suspend/Retirement" - }, - "name": { - "type": "string", - "description": "Name of the Promotion" - }, - "promotionType": { - "type": "string", - "description": "Type of the Promotion. The basic type is Award/Discount/Reduction. More types can be extended in future" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the Promotion is valid" - }, - "pattern": { - "type": "array", - "items": { - "$ref": "PromotionPattern.schema.json#PromotionPattern" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Promotion.schema.json", + "title": "Promotion", + "definitions": { + "Promotion": { + "$id": "#Promotion", + "description": "Promotion Resource is used to provide the additional discount, voucher, bonus or gift to the customer who meets the pre-defined criteria. Using promotion, the enterprise is able to attract the users and encourage more consumption, especially continuous purchases. Normally Promotion is not regarded as one type of product or product offering. It is often applied when the customer buys the product offerings with the price or amount surpassing the certain limit.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Promotion" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the Promotion" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Promotion" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Latest update date of the Promotion" + }, + "lifecycleStatus": { + "type": "string", + "description": "Status of the Promotion, including Draft/Test/WaitForApproval/Release/Suspend/Retirement" + }, + "name": { + "type": "string", + "description": "Name of the Promotion" + }, + "promotionType": { + "type": "string", + "description": "Type of the Promotion. The basic type is Award/Discount/Reduction. More types can be extended in future" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the Promotion is valid" + }, + "pattern": { + "type": "array", + "items": { + "$ref": "PromotionPattern.schema.json#PromotionPattern" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/PromotionAction.schema.json b/Product/PromotionAction.schema.json index aac9d76e..888a4c3b 100644 --- a/Product/PromotionAction.schema.json +++ b/Product/PromotionAction.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PromotionAction.schema.json", - "title": "PromotionAction", - "definitions": { - "PromotionAction": { - "$id": "#PromotionAction", - "description": "Action of the promotion.When the customer meets the conditions in the promotion pattern, the customer can be given the benefits in the action.", - "type": "object", - "properties": { - "actionObjectId": { - "type": "string", - "description": "It refers to the object (entity) ID which is impacted by the promotion action. When the Promotion -> type is 1: Award, the actionObjectId is the sub-account ID; When the Promotion -> type is 2: Discount, it is the offering ID; When the Promotion -> type is 3: reduction, it is the offering ID." - }, - "actionType": { - "type": "string", - "description": "When the Promotion -> type is 1: Award, the action type can be one of the following:voice (minute),data (MB),data (GB),SMS,bonus point,physical gift,voucher,promotion code,an existing offering,currency. More types of action can be extended in future." - }, - "actionValue": { - "type": "number", - "format": "float", - "description": "When the Promotion -> type is 1: Award, it means the amount or value of the awards decided by actionType, such as:Amount of gift,Amount of bonus,Value of discount; When the Promotion -> type is 2: Discount, it means the value of the discount; When the Promotion -> type is 3: reduction, it means the value of the reduced money ." - }, - "id": { - "type": "string", - "description": "Unique identifier." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PromotionAction.schema.json", + "title": "PromotionAction", + "definitions": { + "PromotionAction": { + "$id": "#PromotionAction", + "description": "Action of the promotion.When the customer meets the conditions in the promotion pattern, the customer can be given the benefits in the action.", + "type": "object", + "properties": { + "actionObjectId": { + "type": "string", + "description": "It refers to the object (entity) ID which is impacted by the promotion action. When the Promotion -> type is 1: Award, the actionObjectId is the sub-account ID; When the Promotion -> type is 2: Discount, it is the offering ID; When the Promotion -> type is 3: reduction, it is the offering ID." + }, + "actionType": { + "type": "string", + "description": "When the Promotion -> type is 1: Award, the action type can be one of the following:voice (minute),data (MB),data (GB),SMS,bonus point,physical gift,voucher,promotion code,an existing offering,currency. More types of action can be extended in future." + }, + "actionValue": { + "type": "number", + "format": "float", + "description": "When the Promotion -> type is 1: Award, it means the amount or value of the awards decided by actionType, such as:Amount of gift,Amount of bonus,Value of discount; When the Promotion -> type is 2: Discount, it means the value of the discount; When the Promotion -> type is 3: reduction, it means the value of the reduced money ." + }, + "id": { + "type": "string", + "description": "Unique identifier." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/PromotionCriteria.schema.json b/Product/PromotionCriteria.schema.json index e8ad70a6..a8a4ff1b 100644 --- a/Product/PromotionCriteria.schema.json +++ b/Product/PromotionCriteria.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PromotionCriteria.schema.json", - "title": "PromotionCriteria", - "definitions": { - "PromotionCriteria": { - "$id": "#PromotionCriteria", - "description": "Criteria of the promotion.", - "type": "object", - "properties": { - "criteriaOperator": { - "type": "string", - "description": "The logic expression including parameter and operator. including:=,>,<,>=,<=,<>" - }, - "criteriaPara": { - "type": "string", - "description": "The parameter (factor) of the criteria.The basic factors are abstracted from these data sources. There are several detail parameters ." - }, - "criteriaValue": { - "type": "string", - "description": "The value is filled for the comparison of the criteria." - }, - "id": { - "type": "string", - "description": "Unique identifier." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PromotionCriteria.schema.json", + "title": "PromotionCriteria", + "definitions": { + "PromotionCriteria": { + "$id": "#PromotionCriteria", + "description": "Criteria of the promotion.", + "type": "object", + "properties": { + "criteriaOperator": { + "type": "string", + "description": "The logic expression including parameter and operator. including:=,>,<,>=,<=,<>" + }, + "criteriaPara": { + "type": "string", + "description": "The parameter (factor) of the criteria.The basic factors are abstracted from these data sources. There are several detail parameters ." + }, + "criteriaValue": { + "type": "string", + "description": "The value is filled for the comparison of the criteria." + }, + "id": { + "type": "string", + "description": "Unique identifier." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/PromotionCriteriaGroup.schema.json b/Product/PromotionCriteriaGroup.schema.json index 5e9e2978..6108cd54 100644 --- a/Product/PromotionCriteriaGroup.schema.json +++ b/Product/PromotionCriteriaGroup.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PromotionCriteriaGroup.schema.json", - "title": "PromotionCriteriaGroup", - "definitions": { - "PromotionCriteriaGroup": { - "$id": "#PromotionCriteriaGroup", - "description": "The group of the criteria of the promotion. The logical relationship between different groups is decided by the relationTypeInGroup.", - "type": "object", - "properties": { - "groupName": { - "type": "string", - "description": "Name of the group." - }, - "id": { - "type": "string", - "description": "Unique Identifier" - }, - "relationTypeInGroup": { - "type": "string", - "description": "AND/OR,The logical relation type amongst the various criteria inside a promotion criteria group." - }, - "criteria": { - "type": "array", - "items": { - "$ref": "PromotionCriteria.schema.json#PromotionCriteria" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PromotionCriteriaGroup.schema.json", + "title": "PromotionCriteriaGroup", + "definitions": { + "PromotionCriteriaGroup": { + "$id": "#PromotionCriteriaGroup", + "description": "The group of the criteria of the promotion. The logical relationship between different groups is decided by the relationTypeInGroup.", + "type": "object", + "properties": { + "groupName": { + "type": "string", + "description": "Name of the group." + }, + "id": { + "type": "string", + "description": "Unique Identifier" + }, + "relationTypeInGroup": { + "type": "string", + "description": "AND/OR,The logical relation type amongst the various criteria inside a promotion criteria group." + }, + "criteria": { + "type": "array", + "items": { + "$ref": "PromotionCriteria.schema.json#PromotionCriteria" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/PromotionPattern.schema.json b/Product/PromotionPattern.schema.json index cccb1fba..eaf75155 100644 --- a/Product/PromotionPattern.schema.json +++ b/Product/PromotionPattern.schema.json @@ -1,55 +1,55 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PromotionPattern.schema.json", - "title": "PromotionPattern", - "definitions": { - "PromotionPattern": { - "$id": "#PromotionPattern", - "description": "Detailed pattern of the promotion.The pattern decides the conditions of promotion and the benefit of the promotion to be given to the eligible customer.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description" - }, - "id": { - "type": "string", - "description": "Unique identifier." - }, - "name": { - "type": "string", - "description": "Name" - }, - "priority": { - "type": "integer", - "description": "Priority. Smaller number means high." - }, - "relationTypeAmongGroup": { - "type": "string", - "description": "AND/OR ,The logical relation type amongst the promotion criteria group." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the promotion pattern is valid." - }, - "action": { - "type": "array", - "items": { - "$ref": "PromotionAction.schema.json#PromotionAction" - } - }, - "criteriaGroup": { - "type": "array", - "items": { - "$ref": "PromotionCriteriaGroup.schema.json#PromotionCriteriaGroup" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PromotionPattern.schema.json", + "title": "PromotionPattern", + "definitions": { + "PromotionPattern": { + "$id": "#PromotionPattern", + "description": "Detailed pattern of the promotion.The pattern decides the conditions of promotion and the benefit of the promotion to be given to the eligible customer.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description" + }, + "id": { + "type": "string", + "description": "Unique identifier." + }, + "name": { + "type": "string", + "description": "Name" + }, + "priority": { + "type": "integer", + "description": "Priority. Smaller number means high." + }, + "relationTypeAmongGroup": { + "type": "string", + "description": "AND/OR ,The logical relation type amongst the promotion criteria group." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the promotion pattern is valid." + }, + "action": { + "type": "array", + "items": { + "$ref": "PromotionAction.schema.json#PromotionAction" + } + }, + "criteriaGroup": { + "type": "array", + "items": { + "$ref": "PromotionCriteriaGroup.schema.json#PromotionCriteriaGroup" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/QualificationItemRelationship.schema.json b/Product/QualificationItemRelationship.schema.json index 15865ad7..176161b3 100644 --- a/Product/QualificationItemRelationship.schema.json +++ b/Product/QualificationItemRelationship.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QualificationItemRelationship.schema.json", - "title": "QualificationItemRelationship", - "definitions": { - "QualificationItemRelationship": { - "$id": "#QualificationItemRelationship", - "description": "Structure used to describe relationship between productOfferingQualification item from the same ProductOfferingQualification.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Id of the ProductOfferingQualificationItem (from the same ProductOfferingQualificationItem)." - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship (ex: reliesOn, connectedTo, etc...)" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QualificationItemRelationship.schema.json", + "title": "QualificationItemRelationship", + "definitions": { + "QualificationItemRelationship": { + "$id": "#QualificationItemRelationship", + "description": "Structure used to describe relationship between productOfferingQualification item from the same ProductOfferingQualification.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Id of the ProductOfferingQualificationItem (from the same ProductOfferingQualificationItem)." + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship (ex: reliesOn, connectedTo, etc...)" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/QuoteItemStateType.schema.json b/Product/QuoteItemStateType.schema.json index a673fbd2..6384d362 100644 --- a/Product/QuoteItemStateType.schema.json +++ b/Product/QuoteItemStateType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteItemStateType.schema.json", - "title": "QuoteItemStateType", - "definitions": { - "QuoteItemStateType": { - "$id": "#QuoteItemStateType", - "type": "string", - "description": "Possible values for the state of the quote item", - "enum": [ - "rejected", - "pending", - "inProgress", - "approved" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteItemStateType.schema.json", + "title": "QuoteItemStateType", + "definitions": { + "QuoteItemStateType": { + "$id": "#QuoteItemStateType", + "type": "string", + "description": "Possible values for the state of the quote item", + "enum": [ + "rejected", + "pending", + "inProgress", + "approved" + ] + } } - } } \ No newline at end of file diff --git a/Product/QuoteStateType.schema.json b/Product/QuoteStateType.schema.json index 407a8a49..6ea3cb2f 100644 --- a/Product/QuoteStateType.schema.json +++ b/Product/QuoteStateType.schema.json @@ -1,20 +1,20 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteStateType.schema.json", - "title": "QuoteStateType", - "definitions": { - "QuoteStateType": { - "$id": "#QuoteStateType", - "type": "string", - "description": "Possible values for the state of the quote", - "enum": [ - "rejected", - "pending", - "inProgress", - "cancelled", - "approved", - "accepted" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteStateType.schema.json", + "title": "QuoteStateType", + "definitions": { + "QuoteStateType": { + "$id": "#QuoteStateType", + "type": "string", + "description": "Possible values for the state of the quote", + "enum": [ + "rejected", + "pending", + "inProgress", + "cancelled", + "approved", + "accepted" + ] + } } - } } \ No newline at end of file diff --git a/Product/QuoteTerm.schema.json b/Product/QuoteTerm.schema.json index 1d44368f..3d3928c4 100644 --- a/Product/QuoteTerm.schema.json +++ b/Product/QuoteTerm.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteTerm.schema.json", - "title": "QuoteTerm", - "definitions": { - "QuoteTerm": { - "$id": "#QuoteTerm", - "description": "Description of aproduct Term linked to this quoteItem. This represent a commitment with a duration", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the quoteTerm" - }, - "duration": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "Duration of the Term associated with this item" - }, - "name": { - "type": "string", - "description": "Name of the quoteTerm" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteTerm.schema.json", + "title": "QuoteTerm", + "definitions": { + "QuoteTerm": { + "$id": "#QuoteTerm", + "description": "Description of aproduct Term linked to this quoteItem. This represent a commitment with a duration", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the quoteTerm" + }, + "duration": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "Duration of the Term associated with this item" + }, + "name": { + "type": "string", + "description": "Name of the quoteTerm" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/Recommendation.schema.json b/Product/Recommendation.schema.json index 2019bbb5..3f847206 100644 --- a/Product/Recommendation.schema.json +++ b/Product/Recommendation.schema.json @@ -1,69 +1,69 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Recommendation.schema.json", - "title": "Recommendation", - "definitions": { - "Recommendation": { - "$id": "#Recommendation", - "description": "Recommendation API is used to recommend offering quickly based on the history and real-time context of customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omni-channel.", - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "href": { - "type": "string", - "description": "Hypertext Reference of the recommendation" - }, - "id": { - "type": "string", - "description": "Unique identifier of recommendation" - }, - "name": { - "type": "string", - "description": "Name of recommendation" - }, - "recommendationType": { - "type": "string", - "description": "The type of recommendation" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period in which the recommendation is valid" - }, - "order": { - "$ref": "../Customer/ProductOrderRef.schema.json#ProductOrderRef" - }, - "location": { - "$ref": "../Common/GeographicLocationRef.schema.json#GeographicLocationRef", - "description": "The geographic location which the recommendation is related to" - }, - "channel": { - "$ref": "../Common/ChannelRef.schema.json#ChannelRef" - }, - "category": { - "$ref": "CategoryRef.schema.json#CategoryRef", - "description": "The category for grouping recommendations" - }, - "shoppingCart": { - "$ref": "../Customer/ShoppingCartRef.schema.json#ShoppingCartRef", - "description": "The shopping cart which the recommendation is related to" - }, - "party": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "item": { - "type": "array", - "items": { - "$ref": "RecommendationItem.schema.json#RecommendationItem" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Recommendation.schema.json", + "title": "Recommendation", + "definitions": { + "Recommendation": { + "$id": "#Recommendation", + "description": "Recommendation API is used to recommend offering quickly based on the history and real-time context of customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omni-channel.", + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "href": { + "type": "string", + "description": "Hypertext Reference of the recommendation" + }, + "id": { + "type": "string", + "description": "Unique identifier of recommendation" + }, + "name": { + "type": "string", + "description": "Name of recommendation" + }, + "recommendationType": { + "type": "string", + "description": "The type of recommendation" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period in which the recommendation is valid" + }, + "order": { + "$ref": "../Customer/ProductOrderRef.schema.json#ProductOrderRef" + }, + "location": { + "$ref": "../Common/GeographicLocationRef.schema.json#GeographicLocationRef", + "description": "The geographic location which the recommendation is related to" + }, + "channel": { + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "category": { + "$ref": "CategoryRef.schema.json#CategoryRef", + "description": "The category for grouping recommendations" + }, + "shoppingCart": { + "$ref": "../Customer/ShoppingCartRef.schema.json#ShoppingCartRef", + "description": "The shopping cart which the recommendation is related to" + }, + "party": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "item": { + "type": "array", + "items": { + "$ref": "RecommendationItem.schema.json#RecommendationItem" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/RecommendationItem.schema.json b/Product/RecommendationItem.schema.json index 28c57915..467837b5 100644 --- a/Product/RecommendationItem.schema.json +++ b/Product/RecommendationItem.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RecommendationItem.schema.json", - "title": "RecommendationItem", - "definitions": { - "RecommendationItem": { - "$id": "#RecommendationItem", - "description": "A list of recommendation items. Every item is a product offering and its rank.", - "type": "object", - "properties": { - "priority": { - "type": "integer", - "description": "The rank of the list of recommended offering." - }, - "offering": { - "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef", - "description": "Recommended product offering" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RecommendationItem.schema.json", + "title": "RecommendationItem", + "definitions": { + "RecommendationItem": { + "$id": "#RecommendationItem", + "description": "A list of recommendation items. Every item is a product offering and its rank.", + "type": "object", + "properties": { + "priority": { + "type": "integer", + "description": "The rank of the list of recommended offering." + }, + "offering": { + "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef", + "description": "Recommended product offering" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/RelatedProductOrderItem.schema.json b/Product/RelatedProductOrderItem.schema.json index bd280a1a..b199678b 100644 --- a/Product/RelatedProductOrderItem.schema.json +++ b/Product/RelatedProductOrderItem.schema.json @@ -1,47 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedProductOrderItem.schema.json", - "title": "RelatedProductOrderItem", - "definitions": { - "RelatedProductOrderItem": { - "$id": "#RelatedProductOrderItem", - "type": "object", - "description": "RelatedProductOrderItem (ProductOrder item) .The product order item which triggered product creation/change/termination.", - "required": [ - "orderItemId", - "productOrderId" - ], - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "productOrderHref": { - "type": "string", - "description": "Reference of the related entity." - }, - "productOrderId": { - "type": "string", - "description": "Unique identifier of a related entity." - }, - "orderItemAction": { - "type": "string", - "description": "Action of the order item for this product" - }, - "orderItemId": { - "type": "string", - "description": "Identifier of the order item where the product was managed" - }, - "role": { - "type": "string", - "description": "role of the product order item for this product" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedProductOrderItem.schema.json", + "title": "RelatedProductOrderItem", + "definitions": { + "RelatedProductOrderItem": { + "$id": "#RelatedProductOrderItem", + "type": "object", + "description": "RelatedProductOrderItem (ProductOrder item) .The product order item which triggered product creation/change/termination.", + "required": [ + "orderItemId", + "productOrderId" + ], + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "productOrderHref": { + "type": "string", + "description": "Reference of the related entity." + }, + "productOrderId": { + "type": "string", + "description": "Unique identifier of a related entity." + }, + "orderItemAction": { + "type": "string", + "description": "Action of the order item for this product" + }, + "orderItemId": { + "type": "string", + "description": "Identifier of the order item where the product was managed" + }, + "role": { + "type": "string", + "description": "role of the product order item for this product" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/TargetProductSchema.schema.json b/Product/TargetProductSchema.schema.json index 533de1bc..f0ef54fa 100644 --- a/Product/TargetProductSchema.schema.json +++ b/Product/TargetProductSchema.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TargetProductSchema.schema.json", - "title": "TargetProductSchema", - "definitions": { - "TargetProductSchema": { - "$id": "#TargetProductSchema", - "type": "object", - "description": "The reference object to the schema and type of target product which is described by product specification", - "properties": { - "@type": { - "type": "string", - "description": "Class type of the target product" - }, - "@schemaLocation": { - "type": "string", - "format": "uri", - "description": "This field provides a link to the schema describing the target product" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TargetProductSchema.schema.json", + "title": "TargetProductSchema", + "definitions": { + "TargetProductSchema": { + "$id": "#TargetProductSchema", + "type": "object", + "description": "The reference object to the schema and type of target product which is described by product specification", + "properties": { + "@type": { + "type": "string", + "description": "Class type of the target product" + }, + "@schemaLocation": { + "type": "string", + "format": "uri", + "description": "This field provides a link to the schema describing the target product" + } + }, + "required": [ + "@type", + "@schemaLocation" + ] } - }, - "required": [ - "@type", - "@schemaLocation" - ] } - } } \ No newline at end of file diff --git a/Product/Usage.schema.json b/Product/Usage.schema.json index 85e6337b..bc1f9a01 100644 --- a/Product/Usage.schema.json +++ b/Product/Usage.schema.json @@ -1,65 +1,65 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Usage.schema.json", - "title": "Usage", - "definitions": { - "Usage": { - "$id": "#Usage", - "description": "An occurrence of employing a Product, Service, or Resource for its intended purpose, which is of interest to the business and can have charges applied to it. It is comprised of characteristics, which represent attributes of usage.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time", - "description": "Date of usage" - }, - "description": { - "type": "string", - "description": "Description of usage" - }, - "href": { - "type": "string", - "description": "Reference of usage" - }, - "id": { - "type": "string", - "description": "Usage unique identifier" - }, - "status": { - "type": "string", - "description": "Status of usage" - }, - "usageType": { - "type": "string", - "description": "Type of usage" - }, - "usageSpecification": { - "$ref": "UsageSpecificationRef.schema.json#UsageSpecificationRef" - }, - "usageCharacteristic": { - "type": "array", - "items": { - "$ref": "UsageCharacteristic.schema.json#UsageCharacteristic" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "ratedProductUsage": { - "type": "array", - "items": { - "$ref": "../Common/RatedProductUsage.schema.json#RatedProductUsage" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Usage.schema.json", + "title": "Usage", + "definitions": { + "Usage": { + "$id": "#Usage", + "description": "An occurrence of employing a Product, Service, or Resource for its intended purpose, which is of interest to the business and can have charges applied to it. It is comprised of characteristics, which represent attributes of usage.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "Date of usage" + }, + "description": { + "type": "string", + "description": "Description of usage" + }, + "href": { + "type": "string", + "description": "Reference of usage" + }, + "id": { + "type": "string", + "description": "Usage unique identifier" + }, + "status": { + "type": "string", + "description": "Status of usage" + }, + "usageType": { + "type": "string", + "description": "Type of usage" + }, + "usageSpecification": { + "$ref": "UsageSpecificationRef.schema.json#UsageSpecificationRef" + }, + "usageCharacteristic": { + "type": "array", + "items": { + "$ref": "UsageCharacteristic.schema.json#UsageCharacteristic" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "ratedProductUsage": { + "type": "array", + "items": { + "$ref": "../Common/RatedProductUsage.schema.json#RatedProductUsage" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/UsageCharacteristic.schema.json b/Product/UsageCharacteristic.schema.json index c4b28229..19f3d891 100644 --- a/Product/UsageCharacteristic.schema.json +++ b/Product/UsageCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageCharacteristic.schema.json", - "title": "UsageCharacteristic", - "definitions": { - "UsageCharacteristic": { - "$id": "#UsageCharacteristic", - "description": "Provides the value of a given characteristic", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the usage characteristic" - }, - "value": { - "type": "string", - "description": "A discrete value that the characteristic can take on" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageCharacteristic.schema.json", + "title": "UsageCharacteristic", + "definitions": { + "UsageCharacteristic": { + "$id": "#UsageCharacteristic", + "description": "Provides the value of a given characteristic", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the usage characteristic" + }, + "value": { + "type": "string", + "description": "A discrete value that the characteristic can take on" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/UsageConsumptionReport.schema.json b/Product/UsageConsumptionReport.schema.json index 7478246c..155d3182 100644 --- a/Product/UsageConsumptionReport.schema.json +++ b/Product/UsageConsumptionReport.schema.json @@ -1,50 +1,50 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageConsumptionReport.schema.json", - "title": "UsageConsumptionReport", - "definitions": { - "UsageConsumptionReport": { - "$id": "#UsageConsumptionReport", - "type": "object", - "description": "An usage consumption report enables to know at a given point the balances and the consumption counters related to various buckets (SMS, Voice, Data for example). It could be calculated for a device identified by a public key (msisdn number for a mobile device for example or PSTN or VOIP number for a fix device), for a subscribed offer or option or for an user.", - "properties": { - "bucket": { - "type": "array", - "description": "Bucket(s) included in the offer or option subscribed.", - "items": { - "$ref": "UsageVolumeProduct.schema.json#UsageVolumeProduct" - } - }, - "description": { - "type": "string", - "description": "Free short text describing the usage consumption report content" - }, - "effectiveDate": { - "type": "string", - "format": "date-time", - "description": "Date and time when the usage consumption report was calculated and generated" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the usage consumption report. The report is calculated at the time of the request by the server. Generally, this report is not recorded by the server. If it is, an unique identifier of the usage consumption report is given by the server" - }, - "id": { - "type": "string", - "description": "The report is calculated at the time of the request by the server. Generally, this report is not recorded by the server. If it is, an unique identifier of the usage consumption report is given by the server" - }, - "name": { - "type": "string", - "description": "Usage consumption report name" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageConsumptionReport.schema.json", + "title": "UsageConsumptionReport", + "definitions": { + "UsageConsumptionReport": { + "$id": "#UsageConsumptionReport", + "type": "object", + "description": "An usage consumption report enables to know at a given point the balances and the consumption counters related to various buckets (SMS, Voice, Data for example). It could be calculated for a device identified by a public key (msisdn number for a mobile device for example or PSTN or VOIP number for a fix device), for a subscribed offer or option or for an user.", + "properties": { + "bucket": { + "type": "array", + "description": "Bucket(s) included in the offer or option subscribed.", + "items": { + "$ref": "UsageVolumeProduct.schema.json#UsageVolumeProduct" + } + }, + "description": { + "type": "string", + "description": "Free short text describing the usage consumption report content" + }, + "effectiveDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the usage consumption report was calculated and generated" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the usage consumption report. The report is calculated at the time of the request by the server. Generally, this report is not recorded by the server. If it is, an unique identifier of the usage consumption report is given by the server" + }, + "id": { + "type": "string", + "description": "The report is calculated at the time of the request by the server. Generally, this report is not recorded by the server. If it is, an unique identifier of the usage consumption report is given by the server" + }, + "name": { + "type": "string", + "description": "Usage consumption report name" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/UsageConsumptionReportRef.schema.json b/Product/UsageConsumptionReportRef.schema.json index a5f7f36d..5fda0c01 100644 --- a/Product/UsageConsumptionReportRef.schema.json +++ b/Product/UsageConsumptionReportRef.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageConsumptionReportRef.schema.json", - "title": "UsageConsumptionReportRef", - "definitions": { - "UsageConsumptionReportRef": { - "$id": "#UsageConsumptionReportRef", - "type": "object", - "description": "Reference of an usage consumption report", - "properties": { - "description": { - "type": "string", - "description": "Free short text describing the usage consumption report content" - }, - "effectiveDate": { - "type": "string", - "format": "date-time", - "description": "Date and time when the usage consumption report was calculated and generated" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the usage consumption report" - }, - "id": { - "type": "string", - "description": "Unique identifier of the usage consumption report given by the server" - }, - "name": { - "type": "string", - "description": "Usage consumption report name" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageConsumptionReportRef.schema.json", + "title": "UsageConsumptionReportRef", + "definitions": { + "UsageConsumptionReportRef": { + "$id": "#UsageConsumptionReportRef", + "type": "object", + "description": "Reference of an usage consumption report", + "properties": { + "description": { + "type": "string", + "description": "Free short text describing the usage consumption report content" + }, + "effectiveDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the usage consumption report was calculated and generated" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the usage consumption report" + }, + "id": { + "type": "string", + "description": "Unique identifier of the usage consumption report given by the server" + }, + "name": { + "type": "string", + "description": "Usage consumption report name" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/UsageConsumptionReportRequest.schema.json b/Product/UsageConsumptionReportRequest.schema.json index 1293af61..5c906e37 100644 --- a/Product/UsageConsumptionReportRequest.schema.json +++ b/Product/UsageConsumptionReportRequest.schema.json @@ -1,62 +1,62 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageConsumptionReportRequest.schema.json", - "title": "UsageConsumptionReportRequest", - "definitions": { - "UsageConsumptionReportRequest": { - "$id": "#UsageConsumptionReportRequest", - "type": "object", - "description": "An UsageConsumptionReportRequest allows to manage the calculation request of an usage consumption report", - "properties": { - "bucket": { - "type": "array", - "description": "Reference of the buckets for which the usage consumption report is requested", - "items": { - "$ref": "UsageVolumeProductRef.schema.json#UsageVolumeProductRef" - } - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the request creation" - }, - "href": { - "type": "string", - "description": "Reference of the usage consumption report request" - }, - "id": { - "type": "string", - "description": "Unique identifier of the usage consumption report request given by the server" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date when the status was last changed" - }, - "product": { - "$ref": "NetworkProductRef.schema.json#NetworkProductRef", - "description": "Network product reference for which the usage consumption report is requested" - }, - "relatedParty": { - "type": "array", - "description": "Reference and role of the related parties for which the usage consumption report is requested", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "status": { - "type": "string", - "description": "Status of the usage consumption report request (InProgress or done)" - }, - "usageConsumptionReport": { - "$ref": "UsageConsumptionReportRef.schema.json#UsageConsumptionReportRef", - "description": "References of the usage consumption report (given when it has been calculated and the status of the request is done)" - }, - "validPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Validity period" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageConsumptionReportRequest.schema.json", + "title": "UsageConsumptionReportRequest", + "definitions": { + "UsageConsumptionReportRequest": { + "$id": "#UsageConsumptionReportRequest", + "type": "object", + "description": "An UsageConsumptionReportRequest allows to manage the calculation request of an usage consumption report", + "properties": { + "bucket": { + "type": "array", + "description": "Reference of the buckets for which the usage consumption report is requested", + "items": { + "$ref": "UsageVolumeProductRef.schema.json#UsageVolumeProductRef" + } + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the request creation" + }, + "href": { + "type": "string", + "description": "Reference of the usage consumption report request" + }, + "id": { + "type": "string", + "description": "Unique identifier of the usage consumption report request given by the server" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date when the status was last changed" + }, + "product": { + "$ref": "NetworkProductRef.schema.json#NetworkProductRef", + "description": "Network product reference for which the usage consumption report is requested" + }, + "relatedParty": { + "type": "array", + "description": "Reference and role of the related parties for which the usage consumption report is requested", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "status": { + "type": "string", + "description": "Status of the usage consumption report request (InProgress or done)" + }, + "usageConsumptionReport": { + "$ref": "UsageConsumptionReportRef.schema.json#UsageConsumptionReportRef", + "description": "References of the usage consumption report (given when it has been calculated and the status of the request is done)" + }, + "validPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Validity period" + } + } } - } } - } } \ No newline at end of file diff --git a/Product/UsageConsumptionReportRequestIn.schema.json b/Product/UsageConsumptionReportRequestIn.schema.json index d5005a92..5e2ce699 100644 --- a/Product/UsageConsumptionReportRequestIn.schema.json +++ b/Product/UsageConsumptionReportRequestIn.schema.json @@ -1,41 +1,41 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageConsumptionReportRequestIn.schema.json", - "title": "UsageConsumptionReportRequestIn", - "definitions": { - "UsageConsumptionReportRequestIn": { - "$id": "#UsageConsumptionReportRequestIn", - "type": "object", - "description": "An UsageConsumptionReportRequest allows to manage the calculation request of an usage consumption report", - "properties": { - "bucket": { - "type": "array", - "description": "Reference of the buckets for which the usage consumption report is requested", - "items": { - "$ref": "UsageVolumeProductRef.schema.json#UsageVolumeProductRef" - } - }, - "product": { - "$ref": "NetworkProductRef.schema.json#NetworkProductRef", - "description": "Network product reference for which the usage consumption report is requested" - }, - "relatedParty": { - "type": "array", - "description": "Reference and role of the related parties for which the usage consumption report is requested", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "validPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Validity period" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageConsumptionReportRequestIn.schema.json", + "title": "UsageConsumptionReportRequestIn", + "definitions": { + "UsageConsumptionReportRequestIn": { + "$id": "#UsageConsumptionReportRequestIn", + "type": "object", + "description": "An UsageConsumptionReportRequest allows to manage the calculation request of an usage consumption report", + "properties": { + "bucket": { + "type": "array", + "description": "Reference of the buckets for which the usage consumption report is requested", + "items": { + "$ref": "UsageVolumeProductRef.schema.json#UsageVolumeProductRef" + } + }, + "product": { + "$ref": "NetworkProductRef.schema.json#NetworkProductRef", + "description": "Network product reference for which the usage consumption report is requested" + }, + "relatedParty": { + "type": "array", + "description": "Reference and role of the related parties for which the usage consumption report is requested", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "validPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Validity period" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/UsageSpecCharacteristic.schema.json b/Product/UsageSpecCharacteristic.schema.json index 5a1f1981..a4af030e 100644 --- a/Product/UsageSpecCharacteristic.schema.json +++ b/Product/UsageSpecCharacteristic.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageSpecCharacteristic.schema.json", - "title": "UsageSpecCharacteristic", - "definitions": { - "UsageSpecCharacteristic": { - "$id": "#UsageSpecCharacteristic", - "description": "A detailed description of an attribute that defines a particular type of usage, described by its name, category, type, presence and a set of allowed values", - "type": "object", - "properties": { - "configurable": { - "type": "boolean", - "description": "Boolean indicating if usageSpecCharacteristic is configurable or not" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the usage specification characteristic is" - }, - "name": { - "type": "string", - "description": "The name of the usage specification characteristic" - }, - "usageSpecCharacteristicValue": { - "type": "array", - "items": { - "$ref": "UsageSpecCharacteristicValue.schema.json#UsageSpecCharacteristicValue" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageSpecCharacteristic.schema.json", + "title": "UsageSpecCharacteristic", + "definitions": { + "UsageSpecCharacteristic": { + "$id": "#UsageSpecCharacteristic", + "description": "A detailed description of an attribute that defines a particular type of usage, described by its name, category, type, presence and a set of allowed values", + "type": "object", + "properties": { + "configurable": { + "type": "boolean", + "description": "Boolean indicating if usageSpecCharacteristic is configurable or not" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the usage specification characteristic is" + }, + "name": { + "type": "string", + "description": "The name of the usage specification characteristic" + }, + "usageSpecCharacteristicValue": { + "type": "array", + "items": { + "$ref": "UsageSpecCharacteristicValue.schema.json#UsageSpecCharacteristicValue" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/UsageSpecCharacteristicValue.schema.json b/Product/UsageSpecCharacteristicValue.schema.json index 12d4781b..39638bff 100644 --- a/Product/UsageSpecCharacteristicValue.schema.json +++ b/Product/UsageSpecCharacteristicValue.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageSpecCharacteristicValue.schema.json", - "title": "UsageSpecCharacteristicValue", - "definitions": { - "UsageSpecCharacteristicValue": { - "$id": "#UsageSpecCharacteristicValue", - "description": "A value that can be assigned to a UsageSpecCharacteristic.", - "type": "object", - "properties": { - "default": { - "type": "boolean", - "description": "If true, this is the default value for a characteristic" - }, - "value": { - "type": "string", - "description": "A narrative that explains in detail what the usage specification characteristic is" - }, - "valueFrom": { - "type": "string", - "description": "The low range value that a characteristic can take on" - }, - "valueTo": { - "type": "string", - "description": "The upper range value that a characteristic can take on" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageSpecCharacteristicValue.schema.json", + "title": "UsageSpecCharacteristicValue", + "definitions": { + "UsageSpecCharacteristicValue": { + "$id": "#UsageSpecCharacteristicValue", + "description": "A value that can be assigned to a UsageSpecCharacteristic.", + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "If true, this is the default value for a characteristic" + }, + "value": { + "type": "string", + "description": "A narrative that explains in detail what the usage specification characteristic is" + }, + "valueFrom": { + "type": "string", + "description": "The low range value that a characteristic can take on" + }, + "valueTo": { + "type": "string", + "description": "The upper range value that a characteristic can take on" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/UsageSpecification.schema.json b/Product/UsageSpecification.schema.json index 51b17d23..a05c59db 100644 --- a/Product/UsageSpecification.schema.json +++ b/Product/UsageSpecification.schema.json @@ -1,45 +1,45 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageSpecification.schema.json", - "title": "UsageSpecification", - "definitions": { - "UsageSpecification": { - "$id": "#UsageSpecification", - "description": "A detailed description of a usage event that are of interest to the business and can have charges applied to it. It is comprised of characteristics, which define all attributes known for a particular type of usage.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail what the usage specification is" - }, - "href": { - "type": "string", - "description": "Reference of usage specification" - }, - "id": { - "type": "string", - "description": "Usage specification unique identifier" - }, - "name": { - "type": "string", - "description": "The name of the usage specification." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the usage specification is valid" - }, - "usageSpecCharacteristic": { - "type": "array", - "items": { - "$ref": "UsageSpecCharacteristic.schema.json#UsageSpecCharacteristic" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageSpecification.schema.json", + "title": "UsageSpecification", + "definitions": { + "UsageSpecification": { + "$id": "#UsageSpecification", + "description": "A detailed description of a usage event that are of interest to the business and can have charges applied to it. It is comprised of characteristics, which define all attributes known for a particular type of usage.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail what the usage specification is" + }, + "href": { + "type": "string", + "description": "Reference of usage specification" + }, + "id": { + "type": "string", + "description": "Usage specification unique identifier" + }, + "name": { + "type": "string", + "description": "The name of the usage specification." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the usage specification is valid" + }, + "usageSpecCharacteristic": { + "type": "array", + "items": { + "$ref": "UsageSpecCharacteristic.schema.json#UsageSpecCharacteristic" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/UsageSpecificationRef.schema.json b/Product/UsageSpecificationRef.schema.json index b1ace416..10191bb4 100644 --- a/Product/UsageSpecificationRef.schema.json +++ b/Product/UsageSpecificationRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageSpecificationRef.schema.json", - "title": "UsageSpecificationRef", - "definitions": { - "UsageSpecificationRef": { - "$id": "#UsageSpecificationRef", - "description": "UsageSpecification reference. UsageSpecification is a detailed description of a usage event that are of interest to the business and can have charges applied to it. It is comprised of characteristics, which define all attributes known for a particular type of usage.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of usage specification" - }, - "id": { - "type": "string", - "description": "Usage specification unique identifier" - }, - "name": { - "type": "string", - "description": "The name of the usage specification" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageSpecificationRef.schema.json", + "title": "UsageSpecificationRef", + "definitions": { + "UsageSpecificationRef": { + "$id": "#UsageSpecificationRef", + "description": "UsageSpecification reference. UsageSpecification is a detailed description of a usage event that are of interest to the business and can have charges applied to it. It is comprised of characteristics, which define all attributes known for a particular type of usage.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of usage specification" + }, + "id": { + "type": "string", + "description": "Usage specification unique identifier" + }, + "name": { + "type": "string", + "description": "The name of the usage specification" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/UsageVolumeBalance.schema.json b/Product/UsageVolumeBalance.schema.json index cd102f30..0315b98b 100644 --- a/Product/UsageVolumeBalance.schema.json +++ b/Product/UsageVolumeBalance.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageVolumeBalance.schema.json", - "title": "UsageVolumeBalance", - "definitions": { - "UsageVolumeBalance": { - "$id": "#UsageVolumeBalance", - "type": "object", - "description": "The balance (called UsageVolumeBalance in the SID model) defines the remaining allowed product usage quantity in terms of volume, time, currency or events. It corresponds to the initial allowed usage quantity minus the usage consumed on the bucket.", - "properties": { - "remainingValue": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "Numeric remaining value for the bucket given in the unit (for example 1.9). This numeric value could be used for calculation for example" - }, - "remainingValueName": { - "type": "string", - "description": "Remaining value in a formatted string for the bucket given in the balance unit (for example 1.9 Gb). This formatted string could be used for display needs for example" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Balance period between a start date time and an end date time. For prepaid bucket, the period of the balance is between the effective date of the usage consumption report generation and the end date of the bucket. For postpaid bucket, the period of the balance is between the effective date of the usage consumption report generation and the next bill date." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageVolumeBalance.schema.json", + "title": "UsageVolumeBalance", + "definitions": { + "UsageVolumeBalance": { + "$id": "#UsageVolumeBalance", + "type": "object", + "description": "The balance (called UsageVolumeBalance in the SID model) defines the remaining allowed product usage quantity in terms of volume, time, currency or events. It corresponds to the initial allowed usage quantity minus the usage consumed on the bucket.", + "properties": { + "remainingValue": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "Numeric remaining value for the bucket given in the unit (for example 1.9). This numeric value could be used for calculation for example" + }, + "remainingValueName": { + "type": "string", + "description": "Remaining value in a formatted string for the bucket given in the balance unit (for example 1.9 Gb). This formatted string could be used for display needs for example" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Balance period between a start date time and an end date time. For prepaid bucket, the period of the balance is between the effective date of the usage consumption report generation and the end date of the bucket. For postpaid bucket, the period of the balance is between the effective date of the usage consumption report generation and the next bill date." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/UsageVolumeProduct.schema.json b/Product/UsageVolumeProduct.schema.json index 5b8f77a7..e9f2cb52 100644 --- a/Product/UsageVolumeProduct.schema.json +++ b/Product/UsageVolumeProduct.schema.json @@ -1,53 +1,53 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageVolumeProduct.schema.json", - "title": "UsageVolumeProduct", - "definitions": { - "UsageVolumeProduct": { - "$id": "#UsageVolumeProduct", - "type": "object", - "description": "A bucket (called UsageVolumeProduct in the SID model) represents a quantity of usage, as 2 hours national calls or 50 sms for example. It could be either a quantity or an amount in a currency (i.e. It could represent a fixed number of SMS, MMS, minutes of calls, quantity of data, number of events as well as a specific amount in a given currency). It requires one or more network products from which usages will debit the bucket.", - "properties": { - "bucketBalance": { - "type": "array", - "items": { - "$ref": "UsageVolumeBalance.schema.json#UsageVolumeBalance" - } - }, - "bucketCounter": { - "type": "array", - "items": { - "$ref": "ConsumptionSummary.schema.json#ConsumptionSummary" - } - }, - "id": { - "type": "string", - "description": "Unique identifier of the bucket" - }, - "isShared": { - "type": "boolean", - "description": "True if the bucket is shared between several devices or users" - }, - "name": { - "type": "string", - "description": "Bucket name" - }, - "product": { - "type": "array", - "items": { - "$ref": "NetworkProduct.schema.json#NetworkProduct" - } - }, - "usageType": { - "type": "string", - "description": "Type of usage concerned by the bucket, such as voice, sms, data" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageVolumeProduct.schema.json", + "title": "UsageVolumeProduct", + "definitions": { + "UsageVolumeProduct": { + "$id": "#UsageVolumeProduct", + "type": "object", + "description": "A bucket (called UsageVolumeProduct in the SID model) represents a quantity of usage, as 2 hours national calls or 50 sms for example. It could be either a quantity or an amount in a currency (i.e. It could represent a fixed number of SMS, MMS, minutes of calls, quantity of data, number of events as well as a specific amount in a given currency). It requires one or more network products from which usages will debit the bucket.", + "properties": { + "bucketBalance": { + "type": "array", + "items": { + "$ref": "UsageVolumeBalance.schema.json#UsageVolumeBalance" + } + }, + "bucketCounter": { + "type": "array", + "items": { + "$ref": "ConsumptionSummary.schema.json#ConsumptionSummary" + } + }, + "id": { + "type": "string", + "description": "Unique identifier of the bucket" + }, + "isShared": { + "type": "boolean", + "description": "True if the bucket is shared between several devices or users" + }, + "name": { + "type": "string", + "description": "Bucket name" + }, + "product": { + "type": "array", + "items": { + "$ref": "NetworkProduct.schema.json#NetworkProduct" + } + }, + "usageType": { + "type": "string", + "description": "Type of usage concerned by the bucket, such as voice, sms, data" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Product/UsageVolumeProductRef.schema.json b/Product/UsageVolumeProductRef.schema.json index a85e1514..ff737a88 100644 --- a/Product/UsageVolumeProductRef.schema.json +++ b/Product/UsageVolumeProductRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageVolumeProductRef.schema.json", - "title": "UsageVolumeProductRef", - "definitions": { - "UsageVolumeProductRef": { - "$id": "#UsageVolumeProductRef", - "type": "object", - "description": "Reference of a bucket", - "properties": { - "@referredType": { - "type": "string", - "description": "Generic attribute indicating the name of the class type of the referred resource entity" - }, - "id": { - "type": "string", - "description": "Unique identifier of the bucket" - }, - "name": { - "type": "string", - "description": "Bucket name" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageVolumeProductRef.schema.json", + "title": "UsageVolumeProductRef", + "definitions": { + "UsageVolumeProductRef": { + "$id": "#UsageVolumeProductRef", + "type": "object", + "description": "Reference of a bucket", + "properties": { + "@referredType": { + "type": "string", + "description": "Generic attribute indicating the name of the class type of the referred resource entity" + }, + "id": { + "type": "string", + "description": "Unique identifier of the bucket" + }, + "name": { + "type": "string", + "description": "Bucket name" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Resource/LogicalResource.schema.json b/Resource/LogicalResource.schema.json index 56b570e9..6a783d2d 100644 --- a/Resource/LogicalResource.schema.json +++ b/Resource/LogicalResource.schema.json @@ -1,94 +1,94 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LogicalResource.schema.json", - "title": "LogicalResource", - "definitions": { - "LogicalResource": { - "$id": "#LogicalResource", - "description": "Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses) in the inventory.", - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "The value of the logical resource, such as: 0044746712345 for an MSISDN" - }, - "category": { - "type": "string", - "description": "Category of the concrete resource, such as: Gold, Silver for MSISDN concrete resource" - }, - "description": { - "type": "string", - "description": "Free-text description of the resource" - }, - "endDate": { - "type": "string", - "format": "date-time", - "description": "The date till the resource is effective" - }, - "href": { - "type": "string", - "description": "The URI for the object itself." - }, - "id": { - "type": "string", - "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type" - }, - "lifecycleState": { - "type": "string", - "description": "The life cycle state of the resource" - }, - "name": { - "type": "string", - "description": "A string used to give a name to the resource" - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "A date time( DateTime). The date from which the resource is effective" - }, - "version": { - "type": "string", - "description": "A field that identifies the specific version of an instance of a resource" - }, - "resourceRelationship": { - "type": "array", - "items": { - "$ref": "ResourceRelationship.schema.json#ResourceRelationship" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "ResourceCharacteristic.schema.json#ResourceCharacteristic" - } - }, - "place": { - "$ref": "../Common/Place.schema.json#Place" - }, - "partyRole": { - "type": "array", - "items": { - "$ref": "../EngagedParty/PartyRoleRef.schema.json#PartyRoleRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LogicalResource.schema.json", + "title": "LogicalResource", + "definitions": { + "LogicalResource": { + "$id": "#LogicalResource", + "description": "Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses) in the inventory.", + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The value of the logical resource, such as: 0044746712345 for an MSISDN" + }, + "category": { + "type": "string", + "description": "Category of the concrete resource, such as: Gold, Silver for MSISDN concrete resource" + }, + "description": { + "type": "string", + "description": "Free-text description of the resource" + }, + "endDate": { + "type": "string", + "format": "date-time", + "description": "The date till the resource is effective" + }, + "href": { + "type": "string", + "description": "The URI for the object itself." + }, + "id": { + "type": "string", + "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type" + }, + "lifecycleState": { + "type": "string", + "description": "The life cycle state of the resource" + }, + "name": { + "type": "string", + "description": "A string used to give a name to the resource" + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "A date time( DateTime). The date from which the resource is effective" + }, + "version": { + "type": "string", + "description": "A field that identifies the specific version of an instance of a resource" + }, + "resourceRelationship": { + "type": "array", + "items": { + "$ref": "ResourceRelationship.schema.json#ResourceRelationship" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "ResourceCharacteristic.schema.json#ResourceCharacteristic" + } + }, + "place": { + "$ref": "../Common/Place.schema.json#Place" + }, + "partyRole": { + "type": "array", + "items": { + "$ref": "../EngagedParty/PartyRoleRef.schema.json#PartyRoleRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Resource/PhysicalResource.schema.json b/Resource/PhysicalResource.schema.json index 318f7f93..8eea0b18 100644 --- a/Resource/PhysicalResource.schema.json +++ b/Resource/PhysicalResource.schema.json @@ -1,107 +1,107 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PhysicalResource.schema.json", - "title": "PhysicalResource", - "definitions": { - "PhysicalResource": { - "$id": "#PhysicalResource", - "description": "Physical resource is a type of resource that describes the common set of attributes shared by all concrete physical resources (e.g. EQUIPMENT) in the inventory.", - "type": "object", - "properties": { - "manufactureDate": { - "type": "string", - "format": "date-time", - "description": "This is a string attribute that defines the date of manufacture of this item in the fixed format \"dd/mm/yyyy\". This is an optional attribute." - }, - "powerState": { - "type": "string", - "description": "This defines the current power status of the hardware item. Values include:\n\n 0: Unknown\n 1: Not Applicable\n 2: No Power Applied\n 3: Full Power Applied\n 4: Power Save - Normal\n 5: Power Save - Degraded\n 6: Power Save - Standby\n 7: Power Save - Critical\n 8: Power Save - Low Power Mode\n 9: Power Save - Unknown\n 10: Power Cycle\n 11: Power Warning\n 12: Power Off" - }, - "serialNumber": { - "type": "string", - "description": "This is a string that represents a manufacturer-allocated number used to identify different instances of the same hardware item. The ModelNumber and PartNumber attributes are used to identify different types of hardware items. This is a REQUIRED attribute." - }, - "versionNumber": { - "type": "string", - "description": "This is a string that identifies the version of this object. This is an optional attribute." - }, - "category": { - "type": "string", - "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" - }, - "description": { - "type": "string", - "description": "free-text description of the resource" - }, - "endDate": { - "type": "string", - "format": "date-time", - "description": "A date time( DateTime). The date till the resource is effective" - }, - "href": { - "type": "string", - "description": "The URI for the object itself." - }, - "id": { - "type": "string", - "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." - }, - "lifecycleState": { - "type": "string", - "description": "The life cycle state of the resource." - }, - "name": { - "type": "string", - "description": "A string used to give a name to the resource" - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "A date time( DateTime). The date from which the resource is effective" - }, - "version": { - "type": "string", - "description": "A field that identifies the specific version of an instance of a resource." - }, - "resourceRelationship": { - "type": "array", - "items": { - "$ref": "ResourceRelationship.schema.json#ResourceRelationship" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "ResourceCharacteristic.schema.json#ResourceCharacteristic" - } - }, - "place": { - "$ref": "../Common/Place.schema.json#Place" - }, - "partyRole": { - "type": "array", - "items": { - "$ref": "../EngagedParty/PartyRoleRef.schema.json#PartyRoleRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PhysicalResource.schema.json", + "title": "PhysicalResource", + "definitions": { + "PhysicalResource": { + "$id": "#PhysicalResource", + "description": "Physical resource is a type of resource that describes the common set of attributes shared by all concrete physical resources (e.g. EQUIPMENT) in the inventory.", + "type": "object", + "properties": { + "manufactureDate": { + "type": "string", + "format": "date-time", + "description": "This is a string attribute that defines the date of manufacture of this item in the fixed format \"dd/mm/yyyy\". This is an optional attribute." + }, + "powerState": { + "type": "string", + "description": "This defines the current power status of the hardware item. Values include:\n\n 0: Unknown\n 1: Not Applicable\n 2: No Power Applied\n 3: Full Power Applied\n 4: Power Save - Normal\n 5: Power Save - Degraded\n 6: Power Save - Standby\n 7: Power Save - Critical\n 8: Power Save - Low Power Mode\n 9: Power Save - Unknown\n 10: Power Cycle\n 11: Power Warning\n 12: Power Off" + }, + "serialNumber": { + "type": "string", + "description": "This is a string that represents a manufacturer-allocated number used to identify different instances of the same hardware item. The ModelNumber and PartNumber attributes are used to identify different types of hardware items. This is a REQUIRED attribute." + }, + "versionNumber": { + "type": "string", + "description": "This is a string that identifies the version of this object. This is an optional attribute." + }, + "category": { + "type": "string", + "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" + }, + "description": { + "type": "string", + "description": "free-text description of the resource" + }, + "endDate": { + "type": "string", + "format": "date-time", + "description": "A date time( DateTime). The date till the resource is effective" + }, + "href": { + "type": "string", + "description": "The URI for the object itself." + }, + "id": { + "type": "string", + "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." + }, + "lifecycleState": { + "type": "string", + "description": "The life cycle state of the resource." + }, + "name": { + "type": "string", + "description": "A string used to give a name to the resource" + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "A date time( DateTime). The date from which the resource is effective" + }, + "version": { + "type": "string", + "description": "A field that identifies the specific version of an instance of a resource." + }, + "resourceRelationship": { + "type": "array", + "items": { + "$ref": "ResourceRelationship.schema.json#ResourceRelationship" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "ResourceCharacteristic.schema.json#ResourceCharacteristic" + } + }, + "place": { + "$ref": "../Common/Place.schema.json#Place" + }, + "partyRole": { + "type": "array", + "items": { + "$ref": "../EngagedParty/PartyRoleRef.schema.json#PartyRoleRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Resource/RealizingResourceRef.schema.json b/Resource/RealizingResourceRef.schema.json index 7b039216..c29576d3 100644 --- a/Resource/RealizingResourceRef.schema.json +++ b/Resource/RealizingResourceRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RealizingResourceRef.schema.json", - "title": "RealizingResourceRef", - "definitions": { - "RealizingResourceRef": { - "$id": "#RealizingResourceRef", - "type": "object", - "description": "RealizingResource reference. RealizingResource is a link to the resource that realizes the product.", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RealizingResourceRef.schema.json", + "title": "RealizingResourceRef", + "definitions": { + "RealizingResourceRef": { + "$id": "#RealizingResourceRef", + "type": "object", + "description": "RealizingResource reference. RealizingResource is a link to the resource that realizes the product.", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - ] } - } } \ No newline at end of file diff --git a/Resource/Resource.schema.json b/Resource/Resource.schema.json index ad158e55..56afb134 100644 --- a/Resource/Resource.schema.json +++ b/Resource/Resource.schema.json @@ -1,90 +1,90 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Resource.schema.json", - "title": "Resource", - "definitions": { - "Resource": { - "$id": "#Resource", - "description": "Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory.", - "type": "object", - "properties": { - "category": { - "type": "string", - "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" - }, - "description": { - "type": "string", - "description": "free-text description of the resource" - }, - "endDate": { - "type": "string", - "format": "date-time", - "description": "A date time( DateTime). The date till the resource is effective" - }, - "href": { - "type": "string", - "description": "The URI for the object itself." - }, - "id": { - "type": "string", - "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." - }, - "lifecycleState": { - "type": "string", - "description": "The life cycle state of the resource." - }, - "name": { - "type": "string", - "description": "A string used to give a name to the resource" - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "A date time( DateTime). The date from which the resource is effective" - }, - "version": { - "type": "string", - "description": "A field that identifies the specific version of an instance of a resource." - }, - "resourceRelationship": { - "type": "array", - "items": { - "$ref": "ResourceRelationship.schema.json#ResourceRelationship" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "ResourceCharacteristic.schema.json#ResourceCharacteristic" - } - }, - "place": { - "$ref": "../Common/Place.schema.json#Place" - }, - "partyRole": { - "type": "array", - "items": { - "$ref": "../EngagedParty/PartyRoleRef.schema.json#PartyRoleRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Resource.schema.json", + "title": "Resource", + "definitions": { + "Resource": { + "$id": "#Resource", + "description": "Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory.", + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" + }, + "description": { + "type": "string", + "description": "free-text description of the resource" + }, + "endDate": { + "type": "string", + "format": "date-time", + "description": "A date time( DateTime). The date till the resource is effective" + }, + "href": { + "type": "string", + "description": "The URI for the object itself." + }, + "id": { + "type": "string", + "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." + }, + "lifecycleState": { + "type": "string", + "description": "The life cycle state of the resource." + }, + "name": { + "type": "string", + "description": "A string used to give a name to the resource" + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "A date time( DateTime). The date from which the resource is effective" + }, + "version": { + "type": "string", + "description": "A field that identifies the specific version of an instance of a resource." + }, + "resourceRelationship": { + "type": "array", + "items": { + "$ref": "ResourceRelationship.schema.json#ResourceRelationship" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "ResourceCharacteristic.schema.json#ResourceCharacteristic" + } + }, + "place": { + "$ref": "../Common/Place.schema.json#Place" + }, + "partyRole": { + "type": "array", + "items": { + "$ref": "../EngagedParty/PartyRoleRef.schema.json#PartyRoleRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Resource/ResourceAlarmRef.schema.json b/Resource/ResourceAlarmRef.schema.json index 006f9c13..88cd3c38 100644 --- a/Resource/ResourceAlarmRef.schema.json +++ b/Resource/ResourceAlarmRef.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceAlarmRef.schema.json", - "title": "ResourceAlarmRef", - "definitions": { - "ResourceAlarmRef": { - "$id": "#ResourceAlarmRef", - "type": "object", - "description": "A set of alarm ids identifying the alarms that are underlying this problem.", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "changeRequest": { - "$ref": "../Common/ChangeRequestRef.schema.json#ChangeRequestRef" - }, - "href": { - "type": "string", - "description": "Reference of the Alarm" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Alarm" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceAlarmRef.schema.json", + "title": "ResourceAlarmRef", + "definitions": { + "ResourceAlarmRef": { + "$id": "#ResourceAlarmRef", + "type": "object", + "description": "A set of alarm ids identifying the alarms that are underlying this problem.", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "changeRequest": { + "$ref": "../Common/ChangeRequestRef.schema.json#ChangeRequestRef" + }, + "href": { + "type": "string", + "description": "Reference of the Alarm" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Alarm" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Resource/ResourceCandidateRef.schema.json b/Resource/ResourceCandidateRef.schema.json index 3755c71e..ccaac58c 100644 --- a/Resource/ResourceCandidateRef.schema.json +++ b/Resource/ResourceCandidateRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceCandidateRef.schema.json", - "title": "ResourceCandidateRef", - "definitions": { - "ResourceCandidateRef": { - "$id": "#ResourceCandidateRef", - "description": "ResourceCandidate reference: A resource candidate is an entity that makes a ResourceSpecification available to a catalog.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the resource candidate" - }, - "id": { - "type": "string", - "description": "Unique identifier of the resource candidate" - }, - "name": { - "type": "string", - "description": "Name of the resource candidate" - }, - "version": { - "type": "string", - "description": "Version of the resource candidate" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceCandidateRef.schema.json", + "title": "ResourceCandidateRef", + "definitions": { + "ResourceCandidateRef": { + "$id": "#ResourceCandidateRef", + "description": "ResourceCandidate reference: A resource candidate is an entity that makes a ResourceSpecification available to a catalog.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the resource candidate" + }, + "id": { + "type": "string", + "description": "Unique identifier of the resource candidate" + }, + "name": { + "type": "string", + "description": "Name of the resource candidate" + }, + "version": { + "type": "string", + "description": "Version of the resource candidate" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Resource/ResourceCharacteristic.schema.json b/Resource/ResourceCharacteristic.schema.json index 8909cbd4..5d2ecdf4 100644 --- a/Resource/ResourceCharacteristic.schema.json +++ b/Resource/ResourceCharacteristic.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceCharacteristic.schema.json", - "title": "ResourceCharacteristic", - "definitions": { - "ResourceCharacteristic": { - "$id": "#ResourceCharacteristic", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "name of the characteristic" - }, - "value": { - "type": "string", - "description": "value of the characteristic" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceCharacteristic.schema.json", + "title": "ResourceCharacteristic", + "definitions": { + "ResourceCharacteristic": { + "$id": "#ResourceCharacteristic", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "name of the characteristic" + }, + "value": { + "type": "string", + "description": "value of the characteristic" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Resource/ResourceOrder.schema.json b/Resource/ResourceOrder.schema.json index c2bd1253..b196bab8 100644 --- a/Resource/ResourceOrder.schema.json +++ b/Resource/ResourceOrder.schema.json @@ -1,93 +1,93 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceOrder.schema.json", - "title": "ResourceOrder", - "definitions": { - "ResourceOrder": { - "$id": "#ResourceOrder", - "description": "A Resource Order is a request to provision a set of Resources (logical and physical) triggered by the request to provision a Service through a Service Order", - "type": "object", - "properties": { - "category": { - "type": "string", - "description": "Used to categorize the order from a business perspective that can be useful for the OM system." - }, - "completionDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order was completed" - }, - "correlationId": { - "type": "string", - "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" - }, - "description": { - "type": "string", - "description": "free-text description of the Resource Order" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the order" - }, - "id": { - "type": "string", - "description": "Identifier of an instance of the Resource Order. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." - }, - "name": { - "type": "string", - "description": "A string used to give a name to the Resource Order" - }, - "orderDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order was created" - }, - "priority": { - "type": "integer", - "description": "A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)" - }, - "requestedCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Requested delivery date from the requestor perspective" - }, - "requestedStartDate": { - "type": "string", - "format": "date-time", - "description": "Order start date wished by the requestor" - }, - "state": { - "type": "string", - "description": "The life cycle state of the resource." - }, - "orderType": { - "type": "string", - "description": "Name of the Resource Order type" - }, - "orderRelationship": { - "type": "array", - "items": { - "$ref": "ResourceOrderRelationship.schema.json#ResourceOrderRelationship" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceOrder.schema.json", + "title": "ResourceOrder", + "definitions": { + "ResourceOrder": { + "$id": "#ResourceOrder", + "description": "A Resource Order is a request to provision a set of Resources (logical and physical) triggered by the request to provision a Service through a Service Order", + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Used to categorize the order from a business perspective that can be useful for the OM system." + }, + "completionDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order was completed" + }, + "correlationId": { + "type": "string", + "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" + }, + "description": { + "type": "string", + "description": "free-text description of the Resource Order" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the order" + }, + "id": { + "type": "string", + "description": "Identifier of an instance of the Resource Order. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." + }, + "name": { + "type": "string", + "description": "A string used to give a name to the Resource Order" + }, + "orderDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order was created" + }, + "priority": { + "type": "integer", + "description": "A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)" + }, + "requestedCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Requested delivery date from the requestor perspective" + }, + "requestedStartDate": { + "type": "string", + "format": "date-time", + "description": "Order start date wished by the requestor" + }, + "state": { + "type": "string", + "description": "The life cycle state of the resource." + }, + "orderType": { + "type": "string", + "description": "Name of the Resource Order type" + }, + "orderRelationship": { + "type": "array", + "items": { + "$ref": "ResourceOrderRelationship.schema.json#ResourceOrderRelationship" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Resource/ResourceOrderItem.schema.json b/Resource/ResourceOrderItem.schema.json index d3ebb348..10e72008 100644 --- a/Resource/ResourceOrderItem.schema.json +++ b/Resource/ResourceOrderItem.schema.json @@ -1,44 +1,44 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceOrderItem.schema.json", - "title": "ResourceOrderItem", - "definitions": { - "ResourceOrderItem": { - "$id": "#ResourceOrderItem", - "description": "An identified part of the order. A resource order is decomposed into one or more order items.", - "type": "object", - "properties": { - "action": { - "type": "string", - "description": "Can be \"add\" / \"modify\" / \"no_change\"/ \"delete\"" - }, - "id": { - "type": "string", - "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" - }, - "quantity": { - "type": "integer", - "description": "Quantity ordered" - }, - "state": { - "type": "string", - "description": "State of the order item : described in the state machine diagram" - }, - "resourceSpecification": { - "$ref": "ResourceSpecificationRef.schema.json#ResourceSpecificationRef" - }, - "orderItemRelationship": { - "type": "array", - "items": { - "$ref": "ResourceOrderItemRelationship.schema.json#ResourceOrderItemRelationship" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceOrderItem.schema.json", + "title": "ResourceOrderItem", + "definitions": { + "ResourceOrderItem": { + "$id": "#ResourceOrderItem", + "description": "An identified part of the order. A resource order is decomposed into one or more order items.", + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "Can be \"add\" / \"modify\" / \"no_change\"/ \"delete\"" + }, + "id": { + "type": "string", + "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" + }, + "quantity": { + "type": "integer", + "description": "Quantity ordered" + }, + "state": { + "type": "string", + "description": "State of the order item : described in the state machine diagram" + }, + "resourceSpecification": { + "$ref": "ResourceSpecificationRef.schema.json#ResourceSpecificationRef" + }, + "orderItemRelationship": { + "type": "array", + "items": { + "$ref": "ResourceOrderItemRelationship.schema.json#ResourceOrderItemRelationship" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Resource/ResourceOrderItemRef.schema.json b/Resource/ResourceOrderItemRef.schema.json index fddef8a5..ea86ff21 100644 --- a/Resource/ResourceOrderItemRef.schema.json +++ b/Resource/ResourceOrderItemRef.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceOrderItemRef.schema.json", - "title": "ResourceOrderItemRef", - "definitions": { - "ResourceOrderItemRef": { - "$id": "#ResourceOrderItemRef", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceOrderItemRef.schema.json", + "title": "ResourceOrderItemRef", + "definitions": { + "ResourceOrderItemRef": { + "$id": "#ResourceOrderItemRef", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Resource/ResourceOrderItemRelationship.schema.json b/Resource/ResourceOrderItemRelationship.schema.json index 5ffeed0e..59b2a6fc 100644 --- a/Resource/ResourceOrderItemRelationship.schema.json +++ b/Resource/ResourceOrderItemRelationship.schema.json @@ -1,25 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceOrderItemRelationship.schema.json", - "title": "ResourceOrderItemRelationship", - "definitions": { - "ResourceOrderItemRelationship": { - "$id": "#ResourceOrderItemRelationship", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of the order item relationship" - }, - "orderItem": { - "$ref": "ResourceOrderItemRef.schema.json#ResourceOrderItemRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceOrderItemRelationship.schema.json", + "title": "ResourceOrderItemRelationship", + "definitions": { + "ResourceOrderItemRelationship": { + "$id": "#ResourceOrderItemRelationship", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of the order item relationship" + }, + "orderItem": { + "$ref": "ResourceOrderItemRef.schema.json#ResourceOrderItemRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Resource/ResourceOrderRef.schema.json b/Resource/ResourceOrderRef.schema.json index 1c9f40df..414cca0c 100644 --- a/Resource/ResourceOrderRef.schema.json +++ b/Resource/ResourceOrderRef.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceOrderRef.schema.json", - "title": "ResourceOrderRef", - "definitions": { - "ResourceOrderRef": { - "$id": "#ResourceOrderRef", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink to access the related Resource Order" - }, - "id": { - "type": "string", - "description": "The unique identifier of the related resource order" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceOrderRef.schema.json", + "title": "ResourceOrderRef", + "definitions": { + "ResourceOrderRef": { + "$id": "#ResourceOrderRef", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink to access the related Resource Order" + }, + "id": { + "type": "string", + "description": "The unique identifier of the related resource order" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Resource/ResourceOrderRelationship.schema.json b/Resource/ResourceOrderRelationship.schema.json index c90ba4de..7a01ed7f 100644 --- a/Resource/ResourceOrderRelationship.schema.json +++ b/Resource/ResourceOrderRelationship.schema.json @@ -1,28 +1,28 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceOrderRelationship.schema.json", - "title": "ResourceOrderRelationship", - "definitions": { - "ResourceOrderRelationship": { - "$id": "#ResourceOrderRelationship", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "The type of related order item, such as [dependency] if the order item needs to be [not started] until another order item is complete; [cross-reference] to keep track of the source order (service order)" - }, - "resourceOrder": { - "$ref": "ResourceOrderRef.schema.json#ResourceOrderRef" - }, - "serviceOrder": { - "$ref": "../Service/ServiceOrderRef.schema.json#ServiceOrderRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceOrderRelationship.schema.json", + "title": "ResourceOrderRelationship", + "definitions": { + "ResourceOrderRelationship": { + "$id": "#ResourceOrderRelationship", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of related order item, such as [dependency] if the order item needs to be [not started] until another order item is complete; [cross-reference] to keep track of the source order (service order)" + }, + "resourceOrder": { + "$ref": "ResourceOrderRef.schema.json#ResourceOrderRef" + }, + "serviceOrder": { + "$ref": "../Service/ServiceOrderRef.schema.json#ServiceOrderRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Resource/ResourceRef.schema.json b/Resource/ResourceRef.schema.json index 808a9ec1..f273d1dd 100644 --- a/Resource/ResourceRef.schema.json +++ b/Resource/ResourceRef.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceRef.schema.json", - "title": "ResourceRef", - "definitions": { - "ResourceRef": { - "$id": "#ResourceRef", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the resource" - }, - "value": { - "type": "string", - "description": "The resource value that can be used to identify a resource with a public key (e.g.: a tel nr, an msisdn)" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceRef.schema.json", + "title": "ResourceRef", + "definitions": { + "ResourceRef": { + "$id": "#ResourceRef", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the resource" + }, + "value": { + "type": "string", + "description": "The resource value that can be used to identify a resource with a public key (e.g.: a tel nr, an msisdn)" + } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] } - } } \ No newline at end of file diff --git a/Resource/ResourceRelationship.schema.json b/Resource/ResourceRelationship.schema.json index c303a048..e04e1e5c 100644 --- a/Resource/ResourceRelationship.schema.json +++ b/Resource/ResourceRelationship.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceRelationship.schema.json", - "title": "ResourceRelationship", - "definitions": { - "ResourceRelationship": { - "$id": "#ResourceRelationship", - "description": "Describes links between resources", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "Semantic of the relationship" - }, - "resource": { - "$ref": "ResourceRef.schema.json#ResourceRef", - "description": "A reference to the resource" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceRelationship.schema.json", + "title": "ResourceRelationship", + "definitions": { + "ResourceRelationship": { + "$id": "#ResourceRelationship", + "description": "Describes links between resources", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "Semantic of the relationship" + }, + "resource": { + "$ref": "ResourceRef.schema.json#ResourceRef", + "description": "A reference to the resource" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Resource/ResourceSpecificationRef.schema.json b/Resource/ResourceSpecificationRef.schema.json index aec367c2..fd6deb93 100644 --- a/Resource/ResourceSpecificationRef.schema.json +++ b/Resource/ResourceSpecificationRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceSpecificationRef.schema.json", - "title": "ResourceSpecificationRef", - "definitions": { - "ResourceSpecificationRef": { - "$id": "#ResourceSpecificationRef", - "description": "Resource Specification reference: The ResourceSpecification is required to realize a ProductSpecification.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the resource specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the resource specification" - }, - "name": { - "type": "string", - "description": "Name of the requiredResourceSpecification" - }, - "version": { - "type": "string", - "description": "Resource specification version" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceSpecificationRef.schema.json", + "title": "ResourceSpecificationRef", + "definitions": { + "ResourceSpecificationRef": { + "$id": "#ResourceSpecificationRef", + "description": "Resource Specification reference: The ResourceSpecification is required to realize a ProductSpecification.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the resource specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the resource specification" + }, + "name": { + "type": "string", + "description": "Name of the requiredResourceSpecification" + }, + "version": { + "type": "string", + "description": "Resource specification version" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Resource/SupportingResource.schema.json b/Resource/SupportingResource.schema.json index c2c594db..25e11577 100644 --- a/Resource/SupportingResource.schema.json +++ b/Resource/SupportingResource.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SupportingResource.schema.json", - "title": "SupportingResource", - "definitions": { - "SupportingResource": { - "$id": "#SupportingResource", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the supporting resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of the supporting resource" - }, - "name": { - "type": "string", - "description": "Name of the resource supporting the service" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SupportingResource.schema.json", + "title": "SupportingResource", + "definitions": { + "SupportingResource": { + "$id": "#SupportingResource", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the supporting resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of the supporting resource" + }, + "name": { + "type": "string", + "description": "Name of the resource supporting the service" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/AlternateServiceProposal.schema.json b/Service/AlternateServiceProposal.schema.json index 96e045d4..11c4e19d 100644 --- a/Service/AlternateServiceProposal.schema.json +++ b/Service/AlternateServiceProposal.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AlternateServiceProposal.schema.json", - "title": "AlternateServiceProposal", - "definitions": { - "AlternateServiceProposal": { - "$id": "#AlternateServiceProposal", - "description": "Alternate service proposal is used when the requested service is not available with characteristic and date asked for. An alternate proposal could be a distinct serviceSpecification close to requested one or same as requested but with a different activation date", - "type": "object", - "properties": { - "id": { - "description": "Identifier of a alternate service proposal", - "type": "string" - }, - "alternateServiceAvailabilityDate": { - "description": "Alternate availability date in case seller is not able to meet requested expected availability date for the service", - "type": "string", - "format": "date-time" - }, - "alternateService": { - "$ref": "ServiceRestriction.schema.json#/definitions/ServiceRestriction" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AlternateServiceProposal.schema.json", + "title": "AlternateServiceProposal", + "definitions": { + "AlternateServiceProposal": { + "$id": "#AlternateServiceProposal", + "description": "Alternate service proposal is used when the requested service is not available with characteristic and date asked for. An alternate proposal could be a distinct serviceSpecification close to requested one or same as requested but with a different activation date", + "type": "object", + "properties": { + "id": { + "description": "Identifier of a alternate service proposal", + "type": "string" + }, + "alternateServiceAvailabilityDate": { + "description": "Alternate availability date in case seller is not able to meet requested expected availability date for the service", + "type": "string", + "format": "date-time" + }, + "alternateService": { + "$ref": "ServiceRestriction.schema.json#/definitions/ServiceRestriction" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/AppliedConsequence.schema.json b/Service/AppliedConsequence.schema.json index d070396b..3e48b5fb 100644 --- a/Service/AppliedConsequence.schema.json +++ b/Service/AppliedConsequence.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppliedConsequence.schema.json", - "title": "AppliedConsequence", - "definitions": { - "AppliedConsequence": { - "$id": "#AppliedConsequence", - "type": "object", - "description": "An Applied Consequence defines the action (prescribed action or notification) to take when a \nMeasureThresholdRuleViolation occurs.", - "properties": { - "appliedAction": { - "type": "string", - "description": "The action for a violated threshold. This could be a hyperlink to \nthe action." - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the consequence is." - }, - "name": { - "type": "string", - "description": "A word, term, or phrase by which Consequence is known and \ndistinguished from other MetricDefMeasureConsequences." - }, - "repeatAction": { - "type": "boolean", - "description": "An indicator used to specify that a consequence should cease \nbeing applied if a value is in the same range as the previous value or continue being applied if a value is in the same range as the previous value. \nIf the repeatAction is True, if the consequence is always applied as soon as the MetricMeasure value is in the range of values and if the repeatAction is False, the consequence is applied only if the previous MetricMeasure value was not in the same range." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppliedConsequence.schema.json", + "title": "AppliedConsequence", + "definitions": { + "AppliedConsequence": { + "$id": "#AppliedConsequence", + "type": "object", + "description": "An Applied Consequence defines the action (prescribed action or notification) to take when a \nMeasureThresholdRuleViolation occurs.", + "properties": { + "appliedAction": { + "type": "string", + "description": "The action for a violated threshold. This could be a hyperlink to \nthe action." + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the consequence is." + }, + "name": { + "type": "string", + "description": "A word, term, or phrase by which Consequence is known and \ndistinguished from other MetricDefMeasureConsequences." + }, + "repeatAction": { + "type": "boolean", + "description": "An indicator used to specify that a consequence should cease \nbeing applied if a value is in the same range as the previous value or continue being applied if a value is in the same range as the previous value. \nIf the repeatAction is True, if the consequence is always applied as soon as the MetricMeasure value is in the range of values and if the repeatAction is False, the consequence is applied only if the previous MetricMeasure value was not in the same range." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/BaseService.schema.json b/Service/BaseService.schema.json index 465ce5f5..c6dd231d 100644 --- a/Service/BaseService.schema.json +++ b/Service/BaseService.schema.json @@ -1,89 +1,89 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BaseService.schema.json", - "title": "BaseService", - "definitions": { - "BaseService": { - "$id": "#BaseService", - "description": "In the context of a service order and depending on the action requested (add/modify/delete/noChange) this data structure captures the configuration to apply to an existing subscribed service or to a new one", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the service", - "type": "string" - }, - "href": { - "description": "Reference of the service", - "type": "string" - }, - "serviceType": { - "description": "Business type of the service", - "type": "string" - }, - "name": { - "description": "Name of the service", - "type": "string" - }, - "state": { - "description": "The life cycle state of the service, such as: [feasibilityChecked], [designed]", - "$ref": "ServiceStateType.schema.json#ServiceStateType" - }, - "category": { - "type": "string", - "description": "Is it a customer facing or resource facing service" - }, - "serviceSpecification": { - "description": "The specification from which this service was instantiated", - "$ref": "ServiceSpecificationRef.schema.json#ServiceSpecificationRef" - }, - "serviceCharacteristic": { - "type": "array", - "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*]) ", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - } - }, - "serviceRelationship": { - "type": "array", - "description": "A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).", - "items": { - "$ref": "ServiceRelationship.schema.json#ServiceRelationship" - } - }, - "supportingService": { - "type": "array", - "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)", - "items": { - "$ref": "ServiceRef.schema.json#ServiceRef" - } - }, - "supportingResource": { - "type": "array", - "description": "A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources", - "items": { - "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" - } - }, - "relatedParty": { - "type": "array", - "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "place": { - "type": "array", - "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a delivery geographical place)", - "items": { - "$ref": "../Common/Place.schema.json#Place" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BaseService.schema.json", + "title": "BaseService", + "definitions": { + "BaseService": { + "$id": "#BaseService", + "description": "In the context of a service order and depending on the action requested (add/modify/delete/noChange) this data structure captures the configuration to apply to an existing subscribed service or to a new one", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service", + "type": "string" + }, + "href": { + "description": "Reference of the service", + "type": "string" + }, + "serviceType": { + "description": "Business type of the service", + "type": "string" + }, + "name": { + "description": "Name of the service", + "type": "string" + }, + "state": { + "description": "The life cycle state of the service, such as: [feasibilityChecked], [designed]", + "$ref": "ServiceStateType.schema.json#ServiceStateType" + }, + "category": { + "type": "string", + "description": "Is it a customer facing or resource facing service" + }, + "serviceSpecification": { + "description": "The specification from which this service was instantiated", + "$ref": "ServiceSpecificationRef.schema.json#ServiceSpecificationRef" + }, + "serviceCharacteristic": { + "type": "array", + "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*]) ", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "serviceRelationship": { + "type": "array", + "description": "A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).", + "items": { + "$ref": "ServiceRelationship.schema.json#ServiceRelationship" + } + }, + "supportingService": { + "type": "array", + "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)", + "items": { + "$ref": "ServiceRef.schema.json#ServiceRef" + } + }, + "supportingResource": { + "type": "array", + "description": "A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources", + "items": { + "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" + } + }, + "relatedParty": { + "type": "array", + "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "place": { + "type": "array", + "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a delivery geographical place)", + "items": { + "$ref": "../Common/Place.schema.json#Place" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/FirstAlert.schema.json b/Service/FirstAlert.schema.json index 7b650a8d..0666bb5f 100644 --- a/Service/FirstAlert.schema.json +++ b/Service/FirstAlert.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "FirstAlert.schema.json", - "title": "FirstAlert", - "definitions": { - "FirstAlert": { - "$id": "#FirstAlert", - "type": "object", - "description": "Indicates what first alerted the system to the problem. It is not the root cause of the Service Problem. Examples: Threshold crossing alert", - "properties": { - "href": { - "type": "string", - "description": "Reference of the object" - }, - "id": { - "type": "string", - "description": "Unique identifier of the object" - }, - "alertType": { - "type": "string", - "description": "Type of the object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "FirstAlert.schema.json", + "title": "FirstAlert", + "definitions": { + "FirstAlert": { + "$id": "#FirstAlert", + "type": "object", + "description": "Indicates what first alerted the system to the problem. It is not the root cause of the Service Problem. Examples: Threshold crossing alert", + "properties": { + "href": { + "type": "string", + "description": "Reference of the object" + }, + "id": { + "type": "string", + "description": "Unique identifier of the object" + }, + "alertType": { + "type": "string", + "description": "Type of the object" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ImpactPattern.schema.json b/Service/ImpactPattern.schema.json index afe5ca63..215ad29c 100644 --- a/Service/ImpactPattern.schema.json +++ b/Service/ImpactPattern.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ImpactPattern.schema.json", - "title": "ImpactPattern", - "definitions": { - "ImpactPattern": { - "$id": "#ImpactPattern", - "type": "object", - "description": "Define the patterns of impact (optional), such as other service characteristics- Used when defining impact through another pattern than the pre-defined attributes", - "properties": { - "description": { - "type": "string", - "description": "Basic description of the impact pattern" - }, - "extensionInfo": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - }, - "description": "A generic list of any type of elements. Used for extensions or loose element encapsulation from other namespaces" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ImpactPattern.schema.json", + "title": "ImpactPattern", + "definitions": { + "ImpactPattern": { + "$id": "#ImpactPattern", + "type": "object", + "description": "Define the patterns of impact (optional), such as other service characteristics- Used when defining impact through another pattern than the pre-defined attributes", + "properties": { + "description": { + "type": "string", + "description": "Basic description of the impact pattern" + }, + "extensionInfo": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + }, + "description": "A generic list of any type of elements. Used for extensions or loose element encapsulation from other namespaces" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/MeasureThresholdRuleViolation.schema.json b/Service/MeasureThresholdRuleViolation.schema.json index f3f351aa..98325ea3 100644 --- a/Service/MeasureThresholdRuleViolation.schema.json +++ b/Service/MeasureThresholdRuleViolation.schema.json @@ -1,62 +1,62 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "MeasureThresholdRuleViolation.schema.json", - "title": "MeasureThresholdRuleViolation", - "definitions": { - "MeasureThresholdRuleViolation": { - "$id": "#MeasureThresholdRuleViolation", - "description": "A measureThresholdRuleViolation is a violation of a rule that defines the in the \nMericDefMeasureThresholdRule.", - "type": "object", - "properties": { - "conformanceComparatorLower": { - "type": "string", - "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetLower." - }, - "conformanceComparatorUpper": { - "type": "string", - "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetUpper." - }, - "conformanceTargetLower": { - "type": "string", - "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the lower limit. The value should be less than the conformanceTargetUpper. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." - }, - "conformanceTargetUpper": { - "type": "string", - "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the Upper limit. The value should be greater than the conformanceTargetLower. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." - }, - "description": { - "type": "string", - "description": "Description for the MetricDefMeasureThresholdRule ." - }, - "name": { - "type": "string", - "description": "Name for the MetricDefMeasureThresholdRule ." - }, - "numberOfAllowedCrossing": { - "type": "integer", - "description": "The number of allowed crossing occurrences in reference to the \ntolerancePeriod without a consequence being initiated." - }, - "thresholdRuleSeverity": { - "type": "string", - "description": "A threshold can be generated in different severity levels. A \ncrossing for each level may require a different condition and possibly trigger a different consequence." - }, - "tolerancePeriod": { - "description": "An interval of time of allowed crossing occurrences before a \nconsequence being initiated.", - "$ref": "../Common/Duration.schema.json#Duration" - }, - "appliedConsequence": { - "type": "array", - "description": "An Applied Consequence defines the action (prescribed action or notification) to take when a MeasureThresholdRuleViolation occurs.", - "items": { - "$ref": "AppliedConsequence.schema.json#AppliedConsequence" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "MeasureThresholdRuleViolation.schema.json", + "title": "MeasureThresholdRuleViolation", + "definitions": { + "MeasureThresholdRuleViolation": { + "$id": "#MeasureThresholdRuleViolation", + "description": "A measureThresholdRuleViolation is a violation of a rule that defines the in the \nMericDefMeasureThresholdRule.", + "type": "object", + "properties": { + "conformanceComparatorLower": { + "type": "string", + "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetLower." + }, + "conformanceComparatorUpper": { + "type": "string", + "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetUpper." + }, + "conformanceTargetLower": { + "type": "string", + "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the lower limit. The value should be less than the conformanceTargetUpper. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." + }, + "conformanceTargetUpper": { + "type": "string", + "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the Upper limit. The value should be greater than the conformanceTargetLower. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." + }, + "description": { + "type": "string", + "description": "Description for the MetricDefMeasureThresholdRule ." + }, + "name": { + "type": "string", + "description": "Name for the MetricDefMeasureThresholdRule ." + }, + "numberOfAllowedCrossing": { + "type": "integer", + "description": "The number of allowed crossing occurrences in reference to the \ntolerancePeriod without a consequence being initiated." + }, + "thresholdRuleSeverity": { + "type": "string", + "description": "A threshold can be generated in different severity levels. A \ncrossing for each level may require a different condition and possibly trigger a different consequence." + }, + "tolerancePeriod": { + "description": "An interval of time of allowed crossing occurrences before a \nconsequence being initiated.", + "$ref": "../Common/Duration.schema.json#Duration" + }, + "appliedConsequence": { + "type": "array", + "description": "An Applied Consequence defines the action (prescribed action or notification) to take when a MeasureThresholdRuleViolation occurs.", + "items": { + "$ref": "AppliedConsequence.schema.json#AppliedConsequence" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/MetricDefMeasureConsequence.schema.json b/Service/MetricDefMeasureConsequence.schema.json index 0a408759..d4368d21 100644 --- a/Service/MetricDefMeasureConsequence.schema.json +++ b/Service/MetricDefMeasureConsequence.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "MetricDefMeasureConsequence.schema.json", - "title": "MetricDefMeasureConsequence", - "definitions": { - "MetricDefMeasureConsequence": { - "$id": "#MetricDefMeasureConsequence", - "description": "A MetricDefMeasureConsequence defines the action (prescribed action or notification) to take when a \nMetricDefMeasureThresholdRule is crossed.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail what the consequence is." - }, - "name": { - "type": "string", - "description": "A word, term, or phrase by which a \nMetricDefMeasureConsequence is known and distinguished from other MetricDefMeasureConsequences." - }, - "prescribeAction": { - "type": "string", - "description": "Recommended remedy for a violated threshold. This could be \nthe hyperlink to the action." - }, - "repeatAction": { - "type": "boolean", - "description": "An indicator used to specify that a consequence should cease \nbeing applied if a value is in the same range as the previous value or continue being applied if a value is in the same range as the previous value. \nIf the repeatAction is True, if the consequence is always applied as soon as the MetricMeasure value is in the range of values and if the repeatAction is False, the consequence is applied only if the previous MetricMeasure value was not in the same range." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "A valid duration of a thing." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "MetricDefMeasureConsequence.schema.json", + "title": "MetricDefMeasureConsequence", + "definitions": { + "MetricDefMeasureConsequence": { + "$id": "#MetricDefMeasureConsequence", + "description": "A MetricDefMeasureConsequence defines the action (prescribed action or notification) to take when a \nMetricDefMeasureThresholdRule is crossed.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail what the consequence is." + }, + "name": { + "type": "string", + "description": "A word, term, or phrase by which a \nMetricDefMeasureConsequence is known and distinguished from other MetricDefMeasureConsequences." + }, + "prescribeAction": { + "type": "string", + "description": "Recommended remedy for a violated threshold. This could be \nthe hyperlink to the action." + }, + "repeatAction": { + "type": "boolean", + "description": "An indicator used to specify that a consequence should cease \nbeing applied if a value is in the same range as the previous value or continue being applied if a value is in the same range as the previous value. \nIf the repeatAction is True, if the consequence is always applied as soon as the MetricMeasure value is in the range of values and if the repeatAction is False, the consequence is applied only if the previous MetricMeasure value was not in the same range." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "A valid duration of a thing." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/MetricDefMeasureThresholdRule.schema.json b/Service/MetricDefMeasureThresholdRule.schema.json index e11bce6d..7e3c3963 100644 --- a/Service/MetricDefMeasureThresholdRule.schema.json +++ b/Service/MetricDefMeasureThresholdRule.schema.json @@ -1,62 +1,62 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "MetricDefMeasureThresholdRule.schema.json", - "title": "MetricDefMeasureThresholdRule", - "definitions": { - "MetricDefMeasureThresholdRule": { - "$id": "#MetricDefMeasureThresholdRule", - "description": "A MetricDefMeasureThresholdRule is a rule that defines the condition (raise or clear) to achieve to apply \nconsequences when a threshold is crossed or ceased to be crossed. It also defines the severity of the \nraise or clear of the threshold.", - "type": "object", - "properties": { - "conformanceComparatorLower": { - "type": "string", - "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to Service Test Management API REST Specification compare with the conformanceTargetLower." - }, - "conformanceComparatorUpper": { - "type": "string", - "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetUpper." - }, - "conformanceTargetLower": { - "type": "string", - "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the lower limit. The value should be less than the conformanceTargetUpper. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." - }, - "conformanceTargetUpper": { - "type": "string", - "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the Upper limit. The value should be greater than the conformanceTargetLower. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." - }, - "consequence": { - "type": "array", - "description": "A list of consequences (actions, notifications) that will arise if the threshold is crossed", - "items": { - "$ref": "MetricDefMeasureConsequence.schema.json#MetricDefMeasureConsequence" - } - }, - "description": { - "type": "string", - "description": "Description for the MetricDefMeasureThresholdRule ." - }, - "name": { - "type": "string", - "description": "Name for the MetricDefMeasureThresholdRule ." - }, - "numberOfAllowedCrossing": { - "type": "integer", - "description": "The number of allowed crossing occurrences in reference to the \ntolerancePeriod without a consequence being initiated." - }, - "thresholdRuleSeverity": { - "type": "string", - "description": "A threshold can be generated in different severity levels. A \ncrossing for each level may require a different condition and possibly trigger a different consequence." - }, - "tolerancePeriod": { - "description": "An interval of time of allowed crossing occurrences before a consequence being initiated.", - "$ref": "../Common/Duration.schema.json#Duration" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "MetricDefMeasureThresholdRule.schema.json", + "title": "MetricDefMeasureThresholdRule", + "definitions": { + "MetricDefMeasureThresholdRule": { + "$id": "#MetricDefMeasureThresholdRule", + "description": "A MetricDefMeasureThresholdRule is a rule that defines the condition (raise or clear) to achieve to apply \nconsequences when a threshold is crossed or ceased to be crossed. It also defines the severity of the \nraise or clear of the threshold.", + "type": "object", + "properties": { + "conformanceComparatorLower": { + "type": "string", + "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to Service Test Management API REST Specification compare with the conformanceTargetLower." + }, + "conformanceComparatorUpper": { + "type": "string", + "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetUpper." + }, + "conformanceTargetLower": { + "type": "string", + "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the lower limit. The value should be less than the conformanceTargetUpper. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." + }, + "conformanceTargetUpper": { + "type": "string", + "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the Upper limit. The value should be greater than the conformanceTargetLower. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." + }, + "consequence": { + "type": "array", + "description": "A list of consequences (actions, notifications) that will arise if the threshold is crossed", + "items": { + "$ref": "MetricDefMeasureConsequence.schema.json#MetricDefMeasureConsequence" + } + }, + "description": { + "type": "string", + "description": "Description for the MetricDefMeasureThresholdRule ." + }, + "name": { + "type": "string", + "description": "Name for the MetricDefMeasureThresholdRule ." + }, + "numberOfAllowedCrossing": { + "type": "integer", + "description": "The number of allowed crossing occurrences in reference to the \ntolerancePeriod without a consequence being initiated." + }, + "thresholdRuleSeverity": { + "type": "string", + "description": "A threshold can be generated in different severity levels. A \ncrossing for each level may require a different condition and possibly trigger a different consequence." + }, + "tolerancePeriod": { + "description": "An interval of time of allowed crossing occurrences before a consequence being initiated.", + "$ref": "../Common/Duration.schema.json#Duration" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ProblemAcknowledgement.schema.json b/Service/ProblemAcknowledgement.schema.json index 953434d3..291dfc8c 100644 --- a/Service/ProblemAcknowledgement.schema.json +++ b/Service/ProblemAcknowledgement.schema.json @@ -1,45 +1,45 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProblemAcknowledgement.schema.json", - "title": "ProblemAcknowledgement", - "definitions": { - "ProblemAcknowledgement": { - "$id": "#ProblemAcknowledgement", - "type": "object", - "description": "Task resource that requests acknowledgement of problems by the problem handler.", - "properties": { - "href": { - "type": "string", - "description": "Reference to this task resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of this task resource" - }, - "problem": { - "description": "The problems to be acknowledged, relevant in the input to this task", - "type": "array", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "ackProblem": { - "description": "The problems that were acknowledged, populated in the output to this task", - "type": "array", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "trackingRecord": { - "description": "A record of the action taken in this acknowledgement", - "$ref": "TrackingRecord.schema.json#TrackingRecord" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProblemAcknowledgement.schema.json", + "title": "ProblemAcknowledgement", + "definitions": { + "ProblemAcknowledgement": { + "$id": "#ProblemAcknowledgement", + "type": "object", + "description": "Task resource that requests acknowledgement of problems by the problem handler.", + "properties": { + "href": { + "type": "string", + "description": "Reference to this task resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of this task resource" + }, + "problem": { + "description": "The problems to be acknowledged, relevant in the input to this task", + "type": "array", + "items": { + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "ackProblem": { + "description": "The problems that were acknowledged, populated in the output to this task", + "type": "array", + "items": { + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "trackingRecord": { + "description": "A record of the action taken in this acknowledgement", + "$ref": "TrackingRecord.schema.json#TrackingRecord" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ProblemGroup.schema.json b/Service/ProblemGroup.schema.json index 5946ee4a..4b117472 100644 --- a/Service/ProblemGroup.schema.json +++ b/Service/ProblemGroup.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProblemGroup.schema.json", - "title": "ProblemGroup", - "definitions": { - "ProblemGroup": { - "$id": "#ProblemGroup", - "description": "Task resource that requests Service Problems to be grouped together into a parent and set of children", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference to this task resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of this task resource" - }, - "childProblem": { - "type": "array", - "description": "List of problems to be grouped under a parent problem", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "parentProblem": { - "description": "The parent problem to which the problems are to be grouped", - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProblemGroup.schema.json", + "title": "ProblemGroup", + "definitions": { + "ProblemGroup": { + "$id": "#ProblemGroup", + "description": "Task resource that requests Service Problems to be grouped together into a parent and set of children", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference to this task resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of this task resource" + }, + "childProblem": { + "type": "array", + "description": "List of problems to be grouped under a parent problem", + "items": { + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "parentProblem": { + "description": "The parent problem to which the problems are to be grouped", + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ProblemUnacknowledgement.schema.json b/Service/ProblemUnacknowledgement.schema.json index 810be1b4..6a8caaef 100644 --- a/Service/ProblemUnacknowledgement.schema.json +++ b/Service/ProblemUnacknowledgement.schema.json @@ -1,45 +1,45 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProblemUnacknowledgement.schema.json", - "title": "ProblemUnacknowledgement", - "definitions": { - "ProblemUnacknowledgement": { - "$id": "#ProblemUnacknowledgement", - "type": "object", - "description": "Task resource that requests unacknowledgement of problems, rolling back the status of the problems from Acknowledged to Submitted.", - "properties": { - "href": { - "type": "string", - "description": "Reference to this task resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of this task resource" - }, - "problem": { - "description": "The problems to be unacknowledged, relevant in the input to this task", - "type": "array", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "unackProblem": { - "description": "The problems that were unacknowledged, populated in the output to this task", - "type": "array", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "trackingRecord": { - "description": "A record of the action taken in this acknowledgement", - "$ref": "TrackingRecord.schema.json#TrackingRecord" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProblemUnacknowledgement.schema.json", + "title": "ProblemUnacknowledgement", + "definitions": { + "ProblemUnacknowledgement": { + "$id": "#ProblemUnacknowledgement", + "type": "object", + "description": "Task resource that requests unacknowledgement of problems, rolling back the status of the problems from Acknowledged to Submitted.", + "properties": { + "href": { + "type": "string", + "description": "Reference to this task resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of this task resource" + }, + "problem": { + "description": "The problems to be unacknowledged, relevant in the input to this task", + "type": "array", + "items": { + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "unackProblem": { + "description": "The problems that were unacknowledged, populated in the output to this task", + "type": "array", + "items": { + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "trackingRecord": { + "description": "A record of the action taken in this acknowledgement", + "$ref": "TrackingRecord.schema.json#TrackingRecord" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ProblemUngroup.schema.json b/Service/ProblemUngroup.schema.json index 19339cf4..e80a7f82 100644 --- a/Service/ProblemUngroup.schema.json +++ b/Service/ProblemUngroup.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProblemUngroup.schema.json", - "title": "ProblemUngroup", - "definitions": { - "ProblemUngroup": { - "$id": "#ProblemUngroup", - "description": "Task resource that requests Service Problems to be ungrouped from a parent", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference to this task resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of this task resource" - }, - "childProblem": { - "type": "array", - "description": "List of problems to be ungrouped from a parent problem", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "parentProblem": { - "description": "The parent problem from which the problems are to be ungrouped", - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProblemUngroup.schema.json", + "title": "ProblemUngroup", + "definitions": { + "ProblemUngroup": { + "$id": "#ProblemUngroup", + "description": "Task resource that requests Service Problems to be ungrouped from a parent", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference to this task resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of this task resource" + }, + "childProblem": { + "type": "array", + "description": "List of problems to be ungrouped from a parent problem", + "items": { + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "parentProblem": { + "description": "The parent problem from which the problems are to be ungrouped", + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/Service.schema.json b/Service/Service.schema.json index a4fdb645..6995cfc2 100644 --- a/Service/Service.schema.json +++ b/Service/Service.schema.json @@ -1,67 +1,67 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Service.schema.json", - "title": "Service", - "definitions": { - "Service": { - "$id": "#Service", - "description": "Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.", - "type": "object", - "properties": { - "description": { - "description": "Free-text description of the service", - "type": "string" - }, - "isServiceEnabled": { - "type": "boolean", - "description": "If FALSE, this particular Service has NOT been enabled for use" - }, - "hasStarted": { - "type": "boolean", - "description": "If TRUE, this Service has already been started" - }, - "startMode": { - "type": "string", - "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above" - }, - "isStateful": { - "type": "boolean", - "description": "If TRUE, this Service can be changed without affecting any other services" - }, - "serviceDate": { - "description": "Date when the service was created (whatever its status).", - "type": "string" - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "Date when the service starts" - }, - "endDate": { - "type": "string", - "format": "date-time", - "description": "Date when the service ends" - }, - "serviceOrder": { - "type": "array", - "description": "A list of service orders related to this service", - "items": { - "$ref": "ServiceOrderRef.schema.json#ServiceOrderRef" - } - }, - "note": { - "type": "array", - "description": "A list of notes made on this service", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Service.schema.json", + "title": "Service", + "definitions": { + "Service": { + "$id": "#Service", + "description": "Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.", + "type": "object", + "properties": { + "description": { + "description": "Free-text description of the service", + "type": "string" + }, + "isServiceEnabled": { + "type": "boolean", + "description": "If FALSE, this particular Service has NOT been enabled for use" + }, + "hasStarted": { + "type": "boolean", + "description": "If TRUE, this Service has already been started" + }, + "startMode": { + "type": "string", + "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above" + }, + "isStateful": { + "type": "boolean", + "description": "If TRUE, this Service can be changed without affecting any other services" + }, + "serviceDate": { + "description": "Date when the service was created (whatever its status).", + "type": "string" + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "Date when the service starts" + }, + "endDate": { + "type": "string", + "format": "date-time", + "description": "Date when the service ends" + }, + "serviceOrder": { + "type": "array", + "description": "A list of service orders related to this service", + "items": { + "$ref": "ServiceOrderRef.schema.json#ServiceOrderRef" + } + }, + "note": { + "type": "array", + "description": "A list of notes made on this service", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + } + }, + "allOf": [ + { + "$ref": "BaseService.schema.json#BaseService" + } + ] } - }, - "allOf": [ - { - "$ref": "BaseService.schema.json#BaseService" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceCandidate.schema.json b/Service/ServiceCandidate.schema.json index 54c72732..60b467ab 100644 --- a/Service/ServiceCandidate.schema.json +++ b/Service/ServiceCandidate.schema.json @@ -1,63 +1,63 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceCandidate.schema.json", - "title": "ServiceCandidate", - "definitions": { - "ServiceCandidate": { - "$id": "#ServiceCandidate", - "description": "ServiceCandidate is an entity that makes a service specification available to a catalog. A\nServiceCandidate and its associated service specification may be published - made visible - in any number of service catalogs, or in none. One service specification can be composed of other service specifications.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of this REST resource" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to this REST resource" - }, - "name": { - "type": "string", - "description": "Name given to this REST resource" - }, - "description": { - "type": "string", - "description": "Description of this REST resource" - }, - "version": { - "type": "string", - "description": "the version of service candidate" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which this REST resource is valid" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update of this REST resource" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status of the service candidate." - }, - "category": { - "type": "array", - "description": "List of categories for this candidate", - "items": { - "$ref": "ServiceCategoryRef.schema.json#ServiceCategoryRef" - } - }, - "serviceSpecification": { - "description": "The service specification implied by this candidate", - "$ref": "ServiceSpecificationRef.schema.json#ServiceSpecificationRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceCandidate.schema.json", + "title": "ServiceCandidate", + "definitions": { + "ServiceCandidate": { + "$id": "#ServiceCandidate", + "description": "ServiceCandidate is an entity that makes a service specification available to a catalog. A\nServiceCandidate and its associated service specification may be published - made visible - in any number of service catalogs, or in none. One service specification can be composed of other service specifications.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of this REST resource" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to this REST resource" + }, + "name": { + "type": "string", + "description": "Name given to this REST resource" + }, + "description": { + "type": "string", + "description": "Description of this REST resource" + }, + "version": { + "type": "string", + "description": "the version of service candidate" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which this REST resource is valid" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update of this REST resource" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status of the service candidate." + }, + "category": { + "type": "array", + "description": "List of categories for this candidate", + "items": { + "$ref": "ServiceCategoryRef.schema.json#ServiceCategoryRef" + } + }, + "serviceSpecification": { + "description": "The service specification implied by this candidate", + "$ref": "ServiceSpecificationRef.schema.json#ServiceSpecificationRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceCandidateRef.schema.json b/Service/ServiceCandidateRef.schema.json index e9d41d4d..33e41567 100644 --- a/Service/ServiceCandidateRef.schema.json +++ b/Service/ServiceCandidateRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceCandidateRef.schema.json", - "title": "ServiceCandidateRef", - "definitions": { - "ServiceCandidateRef": { - "$id": "#ServiceCandidateRef", - "description": "ServiceCandidate reference. ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Unique reference of the service candidate" - }, - "id": { - "type": "string", - "description": "Unique identifier of the service candidate" - }, - "name": { - "type": "string", - "description": "Name of the service candidate" - }, - "version": { - "type": "string", - "description": "Version of the service candidate" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceCandidateRef.schema.json", + "title": "ServiceCandidateRef", + "definitions": { + "ServiceCandidateRef": { + "$id": "#ServiceCandidateRef", + "description": "ServiceCandidate reference. ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Unique reference of the service candidate" + }, + "id": { + "type": "string", + "description": "Unique identifier of the service candidate" + }, + "name": { + "type": "string", + "description": "Name of the service candidate" + }, + "version": { + "type": "string", + "description": "Version of the service candidate" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceCatalog.schema.json b/Service/ServiceCatalog.schema.json index 9d1dc572..94dfe37d 100644 --- a/Service/ServiceCatalog.schema.json +++ b/Service/ServiceCatalog.schema.json @@ -1,66 +1,66 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceCatalog.schema.json", - "title": "ServiceCatalog", - "definitions": { - "ServiceCatalog": { - "$id": "#ServiceCatalog", - "description": "The root entity for service catalog management.\nA service catalog is a group of service specifications made available through service candidates that an organization provides to the consumers (internal consumers like its employees or B2B customers or B2C customers). \nA service catalog typically includes name, description and time period that is valid for. It will have a list of ServiceCandidate catalog items. A ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog.\nA ServiceCandidate and its associated ServiceSpecification may be \"published\" - made visible -in any number of ServiceCatalogs, or in none.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the ServiceCatalog" - }, - "href": { - "type": "string", - "description": "Unique reference of the service catalog" - }, - "name": { - "type": "string", - "description": "Name of the service catalog" - }, - "description": { - "type": "string", - "description": "Description of this catalog" - }, - "version": { - "type": "string", - "description": "ServiceCatalog version" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the service catalog is valid" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "category": { - "type": "array", - "description": "List of service categories associated with this catalog", - "items": { - "$ref": "ServiceCategoryRef.schema.json#ServiceCategoryRef" - } - }, - "relatedParty": { - "type": "array", - "description": "List of parties or party roles related to this category", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceCatalog.schema.json", + "title": "ServiceCatalog", + "definitions": { + "ServiceCatalog": { + "$id": "#ServiceCatalog", + "description": "The root entity for service catalog management.\nA service catalog is a group of service specifications made available through service candidates that an organization provides to the consumers (internal consumers like its employees or B2B customers or B2C customers). \nA service catalog typically includes name, description and time period that is valid for. It will have a list of ServiceCandidate catalog items. A ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog.\nA ServiceCandidate and its associated ServiceSpecification may be \"published\" - made visible -in any number of ServiceCatalogs, or in none.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the ServiceCatalog" + }, + "href": { + "type": "string", + "description": "Unique reference of the service catalog" + }, + "name": { + "type": "string", + "description": "Name of the service catalog" + }, + "description": { + "type": "string", + "description": "Description of this catalog" + }, + "version": { + "type": "string", + "description": "ServiceCatalog version" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the service catalog is valid" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "category": { + "type": "array", + "description": "List of service categories associated with this catalog", + "items": { + "$ref": "ServiceCategoryRef.schema.json#ServiceCategoryRef" + } + }, + "relatedParty": { + "type": "array", + "description": "List of parties or party roles related to this category", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceCategory.schema.json b/Service/ServiceCategory.schema.json index f7309279..17b94dec 100644 --- a/Service/ServiceCategory.schema.json +++ b/Service/ServiceCategory.schema.json @@ -1,74 +1,74 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceCategory.schema.json", - "title": "ServiceCategory", - "definitions": { - "ServiceCategory": { - "$id": "#ServiceCategory", - "description": "The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the category" - }, - "href": { - "type": "string", - "description": "Reference of the category" - }, - "name": { - "type": "string", - "description": "Name of the category" - }, - "description": { - "type": "string", - "description": "Description of the category" - }, - "version": { - "type": "string", - "description": "ServiceCategory version" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the category is valid" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "parentId": { - "type": "string", - "description": "Unique identifier of the parent category" - }, - "isRoot": { - "type": "boolean", - "description": "If true, this Boolean indicates that the category is a root of categories" - }, - "serviceCandidate": { - "type": "array", - "description": "List of service candidates associated with this category", - "items": { - "$ref": "ServiceCandidateRef.schema.json#ServiceCandidateRef" - } - }, - "category": { - "type": "array", - "description": "List of child categories in the tree for in this category", - "items": { - "$ref": "ServiceCategoryRef.schema.json#ServiceCategoryRef" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceCategory.schema.json", + "title": "ServiceCategory", + "definitions": { + "ServiceCategory": { + "$id": "#ServiceCategory", + "description": "The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the category" + }, + "href": { + "type": "string", + "description": "Reference of the category" + }, + "name": { + "type": "string", + "description": "Name of the category" + }, + "description": { + "type": "string", + "description": "Description of the category" + }, + "version": { + "type": "string", + "description": "ServiceCategory version" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the category is valid" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "parentId": { + "type": "string", + "description": "Unique identifier of the parent category" + }, + "isRoot": { + "type": "boolean", + "description": "If true, this Boolean indicates that the category is a root of categories" + }, + "serviceCandidate": { + "type": "array", + "description": "List of service candidates associated with this category", + "items": { + "$ref": "ServiceCandidateRef.schema.json#ServiceCandidateRef" + } + }, + "category": { + "type": "array", + "description": "List of child categories in the tree for in this category", + "items": { + "$ref": "ServiceCategoryRef.schema.json#ServiceCategoryRef" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceCategoryRef.schema.json b/Service/ServiceCategoryRef.schema.json index 38dbfa8f..a65b6bf8 100644 --- a/Service/ServiceCategoryRef.schema.json +++ b/Service/ServiceCategoryRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceCategoryRef.schema.json", - "title": "ServiceCategoryRef", - "definitions": { - "ServiceCategoryRef": { - "$id": "#ServiceCategoryRef", - "description": "The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hypertext Reference of the category" - }, - "id": { - "type": "string", - "description": "Unique identifier of category" - }, - "name": { - "type": "string", - "description": "Name of the category." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceCategoryRef.schema.json", + "title": "ServiceCategoryRef", + "definitions": { + "ServiceCategoryRef": { + "$id": "#ServiceCategoryRef", + "description": "The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hypertext Reference of the category" + }, + "id": { + "type": "string", + "description": "Unique identifier of category" + }, + "name": { + "type": "string", + "description": "Name of the category." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceCharacteristic.schema.json b/Service/ServiceCharacteristic.schema.json index 24e36b3f..2818577f 100644 --- a/Service/ServiceCharacteristic.schema.json +++ b/Service/ServiceCharacteristic.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceCharacteristic.schema.json", - "title": "ServiceCharacteristic", - "definitions": { - "ServiceCharacteristic": { - "$id": "#ServiceCharacteristic", - "description": "is a list of name value pairs that define the service characteristics", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "valueType": { - "type": "string", - "description": "Data type of the characteristic" - }, - "value": { - "description": "Actual value of the characteristio", - "$ref": "../Common/Value.schema.json#Value" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceCharacteristic.schema.json", + "title": "ServiceCharacteristic", + "definitions": { + "ServiceCharacteristic": { + "$id": "#ServiceCharacteristic", + "description": "is a list of name value pairs that define the service characteristics", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "valueType": { + "type": "string", + "description": "Data type of the characteristic" + }, + "value": { + "description": "Actual value of the characteristio", + "$ref": "../Common/Value.schema.json#Value" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceEligibilityUnavailabilityReason.schema.json b/Service/ServiceEligibilityUnavailabilityReason.schema.json index c8d6613d..10238d22 100644 --- a/Service/ServiceEligibilityUnavailabilityReason.schema.json +++ b/Service/ServiceEligibilityUnavailabilityReason.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceEligibilityUnavailabilityReason.schema.json", - "title": "ServiceEligibilityUnavailabilityReason", - "definitions": { - "ServiceEligibilityUnavailabilityReason": { - "$id": "#ServiceEligibilityUnavailabilityReason", - "description": "Reason for eligibility result if the ServiceQualification result is no (meaning the Service is not available)", - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Unavailability reason code" - }, - "label": { - "type": "string", - "description": "Unavailability reason label" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceEligibilityUnavailabilityReason.schema.json", + "title": "ServiceEligibilityUnavailabilityReason", + "definitions": { + "ServiceEligibilityUnavailabilityReason": { + "$id": "#ServiceEligibilityUnavailabilityReason", + "description": "Reason for eligibility result if the ServiceQualification result is no (meaning the Service is not available)", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Unavailability reason code" + }, + "label": { + "type": "string", + "description": "Unavailability reason label" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceLevelObjective.schema.json b/Service/ServiceLevelObjective.schema.json index 43f629ea..d306f02f 100644 --- a/Service/ServiceLevelObjective.schema.json +++ b/Service/ServiceLevelObjective.schema.json @@ -1,74 +1,74 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceLevelObjective.schema.json", - "title": "ServiceLevelObjective", - "definitions": { - "ServiceLevelObjective": { - "$id": "#ServiceLevelObjective", - "description": "Service level objectives are defined in terms of parameters and metrics, thresholds, and tolerances \nassociated with the parameters.", - "type": "object", - "properties": { - "conformanceComparator": { - "type": "string", - "description": "An operator that specifies whether a Service Level Objective is \nviolated above or below the conformanceTarget." - }, - "conformancePeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "An interval of time during which the Conformance Target must be measured." - }, - "conformanceTarget": { - "type": "string", - "description": "A value used to determine if Service Level Objective is met. \nThe data type should be adjusted case by case." - }, - "graceTimes": { - "type": "string", - "description": "The number of times an objective can remain un-updated without \na violation of a Service Level Agreement in reference to a measurement period and/or Service Level Agreement reporting period." - }, - "href": { - "type": "string", - "description": "The hyperlink to access a service level objective." - }, - "id": { - "type": "string", - "description": "The identifier of a service level objectives." - }, - "name": { - "type": "string", - "description": "The name of the service level objectives." - }, - "thresholdTarget": { - "type": "string", - "description": "A value that used to specify when a warning should be used \nthat indicates an objective is danger of not being met. Notice, the data type should be adjusted case by case." - }, - "tolerancePeriod": { - "description": "A value that specifies the allowable time variation of a conformance", - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - }, - "toleranceTarget": { - "type": "string", - "description": "A value that specifies the allowable variation of a conformance \nTarget. The data type should be adjusted case by case." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "A valid duration of a thing." - }, - "serviceLevelSpecParameter": { - "description": "A parameter for this objective", - "$ref": "ServiceLevelSpecParameter.schema.json#ServiceLevelSpecParameter" - }, - "serviceLevelSpecConsequence": { - "type": "array", - "description": "A list of consequences for this objective.", - "items": { - "$ref": "ServiceLevelSpecConsequence.schema.json#ServiceLevelSpecConsequence" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceLevelObjective.schema.json", + "title": "ServiceLevelObjective", + "definitions": { + "ServiceLevelObjective": { + "$id": "#ServiceLevelObjective", + "description": "Service level objectives are defined in terms of parameters and metrics, thresholds, and tolerances \nassociated with the parameters.", + "type": "object", + "properties": { + "conformanceComparator": { + "type": "string", + "description": "An operator that specifies whether a Service Level Objective is \nviolated above or below the conformanceTarget." + }, + "conformancePeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "An interval of time during which the Conformance Target must be measured." + }, + "conformanceTarget": { + "type": "string", + "description": "A value used to determine if Service Level Objective is met. \nThe data type should be adjusted case by case." + }, + "graceTimes": { + "type": "string", + "description": "The number of times an objective can remain un-updated without \na violation of a Service Level Agreement in reference to a measurement period and/or Service Level Agreement reporting period." + }, + "href": { + "type": "string", + "description": "The hyperlink to access a service level objective." + }, + "id": { + "type": "string", + "description": "The identifier of a service level objectives." + }, + "name": { + "type": "string", + "description": "The name of the service level objectives." + }, + "thresholdTarget": { + "type": "string", + "description": "A value that used to specify when a warning should be used \nthat indicates an objective is danger of not being met. Notice, the data type should be adjusted case by case." + }, + "tolerancePeriod": { + "description": "A value that specifies the allowable time variation of a conformance", + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + }, + "toleranceTarget": { + "type": "string", + "description": "A value that specifies the allowable variation of a conformance \nTarget. The data type should be adjusted case by case." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "A valid duration of a thing." + }, + "serviceLevelSpecParameter": { + "description": "A parameter for this objective", + "$ref": "ServiceLevelSpecParameter.schema.json#ServiceLevelSpecParameter" + }, + "serviceLevelSpecConsequence": { + "type": "array", + "description": "A list of consequences for this objective.", + "items": { + "$ref": "ServiceLevelSpecConsequence.schema.json#ServiceLevelSpecConsequence" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceLevelObjectiveRef.schema.json b/Service/ServiceLevelObjectiveRef.schema.json index dc6d3abf..a58dc627 100644 --- a/Service/ServiceLevelObjectiveRef.schema.json +++ b/Service/ServiceLevelObjectiveRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceLevelObjectiveRef.schema.json", - "title": "ServiceLevelObjectiveRef", - "definitions": { - "ServiceLevelObjectiveRef": { - "$id": "#ServiceLevelObjectiveRef", - "description": "A set of Service Level Objectives that are contained in the Service Level Specification.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The hyperlink to access a service level object." - }, - "id": { - "type": "string", - "description": "The identifier of a service level object." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceLevelObjectiveRef.schema.json", + "title": "ServiceLevelObjectiveRef", + "definitions": { + "ServiceLevelObjectiveRef": { + "$id": "#ServiceLevelObjectiveRef", + "description": "A set of Service Level Objectives that are contained in the Service Level Specification.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The hyperlink to access a service level object." + }, + "id": { + "type": "string", + "description": "The identifier of a service level object." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceLevelSpecConsequence.schema.json b/Service/ServiceLevelSpecConsequence.schema.json index 0d9f89d5..6fb476f7 100644 --- a/Service/ServiceLevelSpecConsequence.schema.json +++ b/Service/ServiceLevelSpecConsequence.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceLevelSpecConsequence.schema.json", - "title": "ServiceLevelSpecConsequence", - "definitions": { - "ServiceLevelSpecConsequence": { - "$id": "#ServiceLevelSpecConsequence", - "description": "Some consequences for the provider of the Service are resulted when the service level objective\ndoes not meet.", - "type": "object", - "properties": { - "prescribedAction": { - "type": "string", - "description": "Recommended remedy for a violated Service Level Objective. \nThis could be a hyperlink to the recommended action." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "A valid duration of a thing." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceLevelSpecConsequence.schema.json", + "title": "ServiceLevelSpecConsequence", + "definitions": { + "ServiceLevelSpecConsequence": { + "$id": "#ServiceLevelSpecConsequence", + "description": "Some consequences for the provider of the Service are resulted when the service level objective\ndoes not meet.", + "type": "object", + "properties": { + "prescribedAction": { + "type": "string", + "description": "Recommended remedy for a violated Service Level Objective. \nThis could be a hyperlink to the recommended action." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "A valid duration of a thing." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceLevelSpecParameter.schema.json b/Service/ServiceLevelSpecParameter.schema.json index 4717400c..b10b7a02 100644 --- a/Service/ServiceLevelSpecParameter.schema.json +++ b/Service/ServiceLevelSpecParameter.schema.json @@ -1,50 +1,50 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceLevelSpecParameter.schema.json", - "title": "ServiceLevelSpecParameter", - "definitions": { - "ServiceLevelSpecParameter": { - "$id": "#ServiceLevelSpecParameter", - "description": "Service Level Specification parameters can be one of two types. A Key Quality Indicator (KQI) \nprovides a measurement of a specific aspect of the performance of a Product (i.e., Product \nSpecification, Product Offering, or Product) or a Service (i.e., Service Specification or Service).", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the parameter" - }, - "serviceParmCategory": { - "type": "string", - "description": "A string that specifies whether the Service Level Specification Parameter is technology specific, service specific, or technology/service independent" - }, - "serviceParmPerspective": { - "type": "string", - "description": "A string that specifies whether the Service Level Specification Parameter represents a single user instance parameter or a parameter that represents an aggregation" - }, - "transformationAlgorithmOfKQI": { - "type": "string", - "description": "The description of a logical step-by-step procedure used to calculate the value of a KQI" - }, - "parameterType": { - "type": "string", - "description": "Types of Service Level Specification parameters are KQI or KPI" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "A valid duration of a thing" - }, - "relatedEntity": { - "type": "array", - "description": "A list of entities related to this parameter", - "items": { - "$ref": "../Common/RelatedEntityRef.schema.json#RelatedEntityRef" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceLevelSpecParameter.schema.json", + "title": "ServiceLevelSpecParameter", + "definitions": { + "ServiceLevelSpecParameter": { + "$id": "#ServiceLevelSpecParameter", + "description": "Service Level Specification parameters can be one of two types. A Key Quality Indicator (KQI) \nprovides a measurement of a specific aspect of the performance of a Product (i.e., Product \nSpecification, Product Offering, or Product) or a Service (i.e., Service Specification or Service).", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the parameter" + }, + "serviceParmCategory": { + "type": "string", + "description": "A string that specifies whether the Service Level Specification Parameter is technology specific, service specific, or technology/service independent" + }, + "serviceParmPerspective": { + "type": "string", + "description": "A string that specifies whether the Service Level Specification Parameter represents a single user instance parameter or a parameter that represents an aggregation" + }, + "transformationAlgorithmOfKQI": { + "type": "string", + "description": "The description of a logical step-by-step procedure used to calculate the value of a KQI" + }, + "parameterType": { + "type": "string", + "description": "Types of Service Level Specification parameters are KQI or KPI" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "A valid duration of a thing" + }, + "relatedEntity": { + "type": "array", + "description": "A list of entities related to this parameter", + "items": { + "$ref": "../Common/RelatedEntityRef.schema.json#RelatedEntityRef" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceLevelSpecification.schema.json b/Service/ServiceLevelSpecification.schema.json index ca5e4929..f65e434e 100644 --- a/Service/ServiceLevelSpecification.schema.json +++ b/Service/ServiceLevelSpecification.schema.json @@ -1,46 +1,46 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceLevelSpecification.schema.json", - "title": "ServiceLevelSpecification", - "definitions": { - "ServiceLevelSpecification": { - "$id": "#ServiceLevelSpecification", - "description": "A Service Level Specification represents a pre-defined or negotiated set of Service Level \nObjectives. In addition, certain consequences are associated with not meeting the Service Level \nObjectives. Service Level Agreements are expressed in terms of Service Level Specifications.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A brief introduction of a service level specification." - }, - "href": { - "type": "string", - "description": "The hyperlink to access a service level specification." - }, - "id": { - "type": "string", - "description": "The identifier to a service level specification." - }, - "name": { - "type": "string", - "description": "The name of Service Level Specification" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "A valid duration of a thing." - }, - "relatedServiceLevelObjective": { - "type": "array", - "description": "A list of objectives related to this service level specification", - "items": { - "$ref": "ServiceLevelObjectiveRef.schema.json#ServiceLevelObjectiveRef" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceLevelSpecification.schema.json", + "title": "ServiceLevelSpecification", + "definitions": { + "ServiceLevelSpecification": { + "$id": "#ServiceLevelSpecification", + "description": "A Service Level Specification represents a pre-defined or negotiated set of Service Level \nObjectives. In addition, certain consequences are associated with not meeting the Service Level \nObjectives. Service Level Agreements are expressed in terms of Service Level Specifications.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A brief introduction of a service level specification." + }, + "href": { + "type": "string", + "description": "The hyperlink to access a service level specification." + }, + "id": { + "type": "string", + "description": "The identifier to a service level specification." + }, + "name": { + "type": "string", + "description": "The name of Service Level Specification" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "A valid duration of a thing." + }, + "relatedServiceLevelObjective": { + "type": "array", + "description": "A list of objectives related to this service level specification", + "items": { + "$ref": "ServiceLevelObjectiveRef.schema.json#ServiceLevelObjectiveRef" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceLevelSpecificationRef.schema.json b/Service/ServiceLevelSpecificationRef.schema.json index 9579e1f2..3e139193 100755 --- a/Service/ServiceLevelSpecificationRef.schema.json +++ b/Service/ServiceLevelSpecificationRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceLevelSpecificationRef.schema.json", - "title": "ServiceLevelSpecificationRef", - "definitions": { - "ServiceLevelSpecificationRef": { - "$id": "#ServiceLevelSpecificationRef", - "description": "A Service Level Specification represents a pre-defined or negotiated set of Service Level \nObjectives. In addition, certain consequences are associated with not meeting the Service Level \nObjectives. Service Level Agreements are expressed in terms of Service Level Specifications.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The hyperlink to access a service level specification." - }, - "id": { - "type": "string", - "description": "The identifier to a service level specification." - }, - "name": { - "type": "string", - "description": "The name of Service Level Specification" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceLevelSpecificationRef.schema.json", + "title": "ServiceLevelSpecificationRef", + "definitions": { + "ServiceLevelSpecificationRef": { + "$id": "#ServiceLevelSpecificationRef", + "description": "A Service Level Specification represents a pre-defined or negotiated set of Service Level \nObjectives. In addition, certain consequences are associated with not meeting the Service Level \nObjectives. Service Level Agreements are expressed in terms of Service Level Specifications.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The hyperlink to access a service level specification." + }, + "id": { + "type": "string", + "description": "The identifier to a service level specification." + }, + "name": { + "type": "string", + "description": "The name of Service Level Specification" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceOfferingQualificationRef.schema.json b/Service/ServiceOfferingQualificationRef.schema.json index 30386405..768bd079 100644 --- a/Service/ServiceOfferingQualificationRef.schema.json +++ b/Service/ServiceOfferingQualificationRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOfferingQualificationRef.schema.json", - "title": "ServiceOfferingQualificationRef", - "definitions": { - "ServiceOfferingQualificationRef": { - "$id": "#ServiceOfferingQualificationRef", - "description": "It could be a serviceQualification or a productOfferingQualification that has been executed previously and captured in the productOrder to provide eligibility information", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "href of the qualification" - }, - "id": { - "type": "string", - "description": "Identifier of a pre-existing qualification" - }, - "qualificationItemId": { - "type": "string", - "description": "Id of an item of a qualification" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOfferingQualificationRef.schema.json", + "title": "ServiceOfferingQualificationRef", + "definitions": { + "ServiceOfferingQualificationRef": { + "$id": "#ServiceOfferingQualificationRef", + "description": "It could be a serviceQualification or a productOfferingQualification that has been executed previously and captured in the productOrder to provide eligibility information", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "href of the qualification" + }, + "id": { + "type": "string", + "description": "Identifier of a pre-existing qualification" + }, + "qualificationItemId": { + "type": "string", + "description": "Id of an item of a qualification" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation" + } + }, + "allOf": [ + { + "$ref": "../Common/QualificationRef.schema.json#QualificationRef" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/QualificationRef.schema.json#QualificationRef" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceOrder.schema.json b/Service/ServiceOrder.schema.json index fa3b9757..3ab0e119 100644 --- a/Service/ServiceOrder.schema.json +++ b/Service/ServiceOrder.schema.json @@ -1,108 +1,108 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrder.schema.json", - "title": "ServiceOrder", - "definitions": { - "ServiceOrder": { - "$id": "#ServiceOrder", - "type": "object", - "properties": { - "category": { - "type": "string", - "description": "Used to categorize the order, useful for the OM system, such as: Broadband, TVOption" - }, - "completionDate": { - "type": "string", - "format": "date-time", - "description": "Effective delivery date amended by the provider" - }, - "description": { - "type": "string", - "description": "A free-text description of the service order" - }, - "expectedCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Expected delivery date amended by the provider" - }, - "externalId": { - "type": "string", - "description": "ID given by the consumer to facilitate searches" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the order" - }, - "id": { - "type": "string", - "description": "ID created on repository side" - }, - "note": { - "type": "array", - "description": "Extra-information about the order; e.g. useful to add extra delivery information that could be useful for a human process", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "notificationContact": { - "type": "string", - "description": "Contact attached to the order to send back information regarding this order" - }, - "orderDate": { - "type": "string", - "format": "date-time" - }, - "orderItem": { - "type": "array", - "minItems": 1, - "description": "A list of service order items to be processed by this order", - "items": { - "$ref": "ServiceOrderItem.schema.json#ServiceOrderItem" - } - }, - "orderRelationship": { - "type": "array", - "description": "A list of service orders related to this order (e.g. prerequisite, dependent on)", - "items": { - "$ref": "ServiceOrderRelationship.schema.json#ServiceOrderRelationship" - } - }, - "priority": { - "type": "string", - "description": "Can be used by consumers to prioritize orders in a Service Order Management system" - }, - "relatedParty": { - "type": "array", - "description": "A list of parties which are involved in this order and the role they are playing", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "requestedCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Requested delivery date from the requestors perspective" - }, - "requestedStartDate": { - "type": "string", - "format": "date-time", - "description": "Order start date wished by the requestor" - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order was started for processing" - }, - "state": { - "description": "State of the order: described in the state-machine diagram", - "$ref": "ServiceOrderStateType.schema.json#ServiceOrderStateType" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrder.schema.json", + "title": "ServiceOrder", + "definitions": { + "ServiceOrder": { + "$id": "#ServiceOrder", + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Used to categorize the order, useful for the OM system, such as: Broadband, TVOption" + }, + "completionDate": { + "type": "string", + "format": "date-time", + "description": "Effective delivery date amended by the provider" + }, + "description": { + "type": "string", + "description": "A free-text description of the service order" + }, + "expectedCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Expected delivery date amended by the provider" + }, + "externalId": { + "type": "string", + "description": "ID given by the consumer to facilitate searches" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the order" + }, + "id": { + "type": "string", + "description": "ID created on repository side" + }, + "note": { + "type": "array", + "description": "Extra-information about the order; e.g. useful to add extra delivery information that could be useful for a human process", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "notificationContact": { + "type": "string", + "description": "Contact attached to the order to send back information regarding this order" + }, + "orderDate": { + "type": "string", + "format": "date-time" + }, + "orderItem": { + "type": "array", + "minItems": 1, + "description": "A list of service order items to be processed by this order", + "items": { + "$ref": "ServiceOrderItem.schema.json#ServiceOrderItem" + } + }, + "orderRelationship": { + "type": "array", + "description": "A list of service orders related to this order (e.g. prerequisite, dependent on)", + "items": { + "$ref": "ServiceOrderRelationship.schema.json#ServiceOrderRelationship" + } + }, + "priority": { + "type": "string", + "description": "Can be used by consumers to prioritize orders in a Service Order Management system" + }, + "relatedParty": { + "type": "array", + "description": "A list of parties which are involved in this order and the role they are playing", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "requestedCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Requested delivery date from the requestors perspective" + }, + "requestedStartDate": { + "type": "string", + "format": "date-time", + "description": "Order start date wished by the requestor" + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order was started for processing" + }, + "state": { + "description": "State of the order: described in the state-machine diagram", + "$ref": "ServiceOrderStateType.schema.json#ServiceOrderStateType" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceOrderActionType.schema.json b/Service/ServiceOrderActionType.schema.json index b787995b..eeaf91dd 100644 --- a/Service/ServiceOrderActionType.schema.json +++ b/Service/ServiceOrderActionType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrderActionType.schema.json", - "title": "ServiceOrderActionType", - "definitions": { - "ServiceOrderActionType": { - "$id": "#ServiceOrderActionType", - "description": "string", - "type": "string", - "enum": [ - "add", - "modify", - "delete", - "noChange" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrderActionType.schema.json", + "title": "ServiceOrderActionType", + "definitions": { + "ServiceOrderActionType": { + "$id": "#ServiceOrderActionType", + "description": "string", + "type": "string", + "enum": [ + "add", + "modify", + "delete", + "noChange" + ] + } } - } } \ No newline at end of file diff --git a/Service/ServiceOrderItem.schema.json b/Service/ServiceOrderItem.schema.json index 6ec723f5..c22e232b 100644 --- a/Service/ServiceOrderItem.schema.json +++ b/Service/ServiceOrderItem.schema.json @@ -1,49 +1,49 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrderItem.schema.json", - "title": "ServiceOrderItem", - "definitions": { - "ServiceOrderItem": { - "$id": "#ServiceOrderItem", - "type": "object", - "required": [ - "id", - "action" - ], - "properties": { - "id": { - "type": "string", - "description": "Identifier of the individual line item" - }, - "action": { - "description": "The action to be carried out on the Service. Can be: add, modify, delete, noChange", - "$ref": "ServiceOrderActionType.schema.json#ServiceOrderActionType" - }, - "state": { - "description": "State of the order item: described in the state machine diagram. This is the requested state.", - "$ref": "ServiceOrderStateType.schema.json#ServiceOrderStateType" - }, - "service": { - "description": "The Service to be acted on by the order item", - "$ref": "BaseService.schema.json#BaseService" - }, - "appointment": { - "description": "An appointment that was set up with a related party for this order item", - "$ref": "../Customer/AppointmentRef.schema.json#AppointmentRef" - }, - "serviceOrderItemRelationship": { - "type": "array", - "description": "A list of order items related to this order item", - "items": { - "$ref": "../Customer/OrderItemRelationship.schema.json#OrderItemRelationship" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrderItem.schema.json", + "title": "ServiceOrderItem", + "definitions": { + "ServiceOrderItem": { + "$id": "#ServiceOrderItem", + "type": "object", + "required": [ + "id", + "action" + ], + "properties": { + "id": { + "type": "string", + "description": "Identifier of the individual line item" + }, + "action": { + "description": "The action to be carried out on the Service. Can be: add, modify, delete, noChange", + "$ref": "ServiceOrderActionType.schema.json#ServiceOrderActionType" + }, + "state": { + "description": "State of the order item: described in the state machine diagram. This is the requested state.", + "$ref": "ServiceOrderStateType.schema.json#ServiceOrderStateType" + }, + "service": { + "description": "The Service to be acted on by the order item", + "$ref": "BaseService.schema.json#BaseService" + }, + "appointment": { + "description": "An appointment that was set up with a related party for this order item", + "$ref": "../Customer/AppointmentRef.schema.json#AppointmentRef" + }, + "serviceOrderItemRelationship": { + "type": "array", + "description": "A list of order items related to this order item", + "items": { + "$ref": "../Customer/OrderItemRelationship.schema.json#OrderItemRelationship" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceOrderItemRelationship.schema.json b/Service/ServiceOrderItemRelationship.schema.json index a660637c..8ab0447e 100644 --- a/Service/ServiceOrderItemRelationship.schema.json +++ b/Service/ServiceOrderItemRelationship.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrderItemRelationship.schema.json", - "title": "ServiceOrderItemRelationship", - "definitions": { - "ServiceOrderItemRelationship": { - "$id": "#ServiceOrderItemRelationship", - "type": "object", - "description": "Linked service order item to the one containing this attribute", - "required": [ - "id", - "relationshipType" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of a service order item" - }, - "relationshipType": { - "type": "string", - "description": "The type of related order item, can be: dependency if the order item needs to be not started until another order item is complete" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrderItemRelationship.schema.json", + "title": "ServiceOrderItemRelationship", + "definitions": { + "ServiceOrderItemRelationship": { + "$id": "#ServiceOrderItemRelationship", + "type": "object", + "description": "Linked service order item to the one containing this attribute", + "required": [ + "id", + "relationshipType" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of a service order item" + }, + "relationshipType": { + "type": "string", + "description": "The type of related order item, can be: dependency if the order item needs to be not started until another order item is complete" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceOrderRef.schema.json b/Service/ServiceOrderRef.schema.json index aa3ecf48..de31add9 100644 --- a/Service/ServiceOrderRef.schema.json +++ b/Service/ServiceOrderRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrderRef.schema.json", - "title": "ServiceOrderRef", - "definitions": { - "ServiceOrderRef": { - "$id": "#ServiceOrderRef", - "description": "Service Order reference. Useful to understand the which was the Service order through which the service was instantiated in the service inventory", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the Service Order" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Service Order" - }, - "serviceOrderItemId": { - "type": "string", - "description": "Unique identifier of the Service Order Item within a service order, not populated if this is a reference to a service order" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrderRef.schema.json", + "title": "ServiceOrderRef", + "definitions": { + "ServiceOrderRef": { + "$id": "#ServiceOrderRef", + "description": "Service Order reference. Useful to understand the which was the Service order through which the service was instantiated in the service inventory", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the Service Order" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Service Order" + }, + "serviceOrderItemId": { + "type": "string", + "description": "Unique identifier of the Service Order Item within a service order, not populated if this is a reference to a service order" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceOrderRelationship.schema.json b/Service/ServiceOrderRelationship.schema.json index f9f8b62f..74299712 100644 --- a/Service/ServiceOrderRelationship.schema.json +++ b/Service/ServiceOrderRelationship.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrderRelationship.schema.json", - "title": "ServiceOrderRelationship", - "definitions": { - "ServiceOrderRelationship": { - "$id": "#ServiceOrderRelationship", - "type": "object", - "description": "Linked service order to the one containing this attribute", - "required": [ - "id" - ], - "properties": { - "@referredType": { - "type": "string", - "description": "The entity type of the related order" - }, - "href": { - "type": "string", - "description": "A hyperlink to the related order" - }, - "id": { - "type": "string", - "description": "The id of the related order" - }, - "relationshipType": { - "type": "string", - "description": "The type of related order, such as: [dependency] if the order needs to be [not started] until another order item is complete (a service order in this case) or [cross-ref] to keep track of the source order (a productOrder)" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrderRelationship.schema.json", + "title": "ServiceOrderRelationship", + "definitions": { + "ServiceOrderRelationship": { + "$id": "#ServiceOrderRelationship", + "type": "object", + "description": "Linked service order to the one containing this attribute", + "required": [ + "id" + ], + "properties": { + "@referredType": { + "type": "string", + "description": "The entity type of the related order" + }, + "href": { + "type": "string", + "description": "A hyperlink to the related order" + }, + "id": { + "type": "string", + "description": "The id of the related order" + }, + "relationshipType": { + "type": "string", + "description": "The type of related order, such as: [dependency] if the order needs to be [not started] until another order item is complete (a service order in this case) or [cross-ref] to keep track of the source order (a productOrder)" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceOrderStateType.schema.json b/Service/ServiceOrderStateType.schema.json index e93a0e86..a0f4ac55 100644 --- a/Service/ServiceOrderStateType.schema.json +++ b/Service/ServiceOrderStateType.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrderStateType.schema.json", - "title": "ServiceOrderStateType", - "definitions": { - "ServiceOrderStateType": { - "$id": "#ServiceOrderStateType", - "type": "string", - "description": "Possible values for the state of the order", - "enum": [ - "acknowledged", - "rejected", - "pending", - "held", - "inProgress", - "cancelled", - "completed", - "failed", - "partial" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrderStateType.schema.json", + "title": "ServiceOrderStateType", + "definitions": { + "ServiceOrderStateType": { + "$id": "#ServiceOrderStateType", + "type": "string", + "description": "Possible values for the state of the order", + "enum": [ + "acknowledged", + "rejected", + "pending", + "held", + "inProgress", + "cancelled", + "completed", + "failed", + "partial" + ] + } } - } } \ No newline at end of file diff --git a/Service/ServiceProblem.schema.json b/Service/ServiceProblem.schema.json index 59d85f69..5e2c7bf8 100644 --- a/Service/ServiceProblem.schema.json +++ b/Service/ServiceProblem.schema.json @@ -1,219 +1,219 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceProblem.schema.json", - "title": "ServiceProblem", - "definitions": { - "ServiceProblem": { - "$id": "#ServiceProblem", - "type": "object", - "description": "The problem information for Middle B which is abstracted in the service layer from the issued event information by First B", - "properties": { - "affectedLocation": { - "type": "array", - "description": "A list of the locations affected by the problem. At least one of affectedResource, affectedService or affectedLocation should be present.", - "items": { - "$ref": "../Common/Place.schema.json#Place" - } - }, - "affectedNumberOfServices": { - "type": "integer", - "description": "Number of affected services" - }, - "affectedResource": { - "type": "array", - "description": "A list of the resources affected by the problem. At least one of affectedResource, affectedService or affectedLocation should be present.", - "items": { - "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" - } - }, - "affectedService": { - "type": "array", - "description": "List of affected services. At least one of affectedResource, affectedService or affectedLocation should be present.", - "items": { - "$ref": "ServiceRef.schema.json#ServiceRef" - } - }, - "category": { - "type": "string", - "description": "Classifier for the problem. Settable. For example, this is used for distinguish the category of problem originator in [role].[category] format. Example: serviceProvider.declarer, supplier.originated, system.originated" - }, - "comment": { - "type": "array", - "description": "A list of comments or notes made on the problem", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "correlationId": { - "type": "string", - "description": "Additional identifier coming from an external system" - }, - "description": { - "type": "string", - "description": "Free form text describing the Service Problem" - }, - "extensionInfo": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - }, - "description": "A generic list of any type of elements. Used for vendor Extensions or loose element encapsulation from other namespaces" - }, - "firstAlert": { - "description": "Indicates what first alerted the system to the problem. It is not the root cause of the Service Problem. Examples: Threshold crossing alert", - "$ref": "../Common/RelatedEntityRef.schema.json#RelatedEntityRef" - }, - "href": { - "type": "string", - "description": "Reference to the Service Problem" - }, - "id": { - "type": "string", - "description": "Identifier of the service problem" - }, - "impactImportanceFactor": { - "type": "string", - "description": "Impact Importance is characterized by an Impact Importance Factor: overall importance of the impact of all the affected services, e.g. 0 (zero impact) to 100 (worst impact). The Impact Importance is a calculated field which is set by the OSS determining the impact." - }, - "impactPatterns": { - "description": "Define the patterns of impact (optional)- e.g. other service characteristics- Used when defining impact through another pattern than the predefined attributes.", - "$ref": "ImpactPattern.schema.json#ImpactPattern" - }, - "originatingSystem": { - "type": "string", - "description": "Indicates where the problem was generated" - }, - "parentProblem": { - "type": "array", - "description": "The parent problem to which this problem is attached.", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "priority": { - "type": "integer", - "description": "An indication varying from 1 (highest) to 10 (lowest) of how important it is for the service provider to correct the Service Problem." - }, - "problemEscalation": { - "type": "string", - "description": "Indicates if this service problem has been escalated or not. Possible values are 0 to 10. A value of zero means no escalation. The meanings of values 1-10 are to be determined by the user of the interface, but they show increasing levels of escalation." - }, - "reason": { - "type": "string", - "description": "Free text or optionally structured text. It can be Unknown." - }, - "relatedEvent": { - "type": "array", - "description": "List of events associated to this problem", - "items": { - "$ref": "../Common/EventRef.schema.json#EventRef" - } - }, - "relatedObject": { - "type": "array", - "description": "List of objects associated to this problem", - "items": { - "$ref": "../Common/RelatedEntityRef.schema.json#RelatedEntityRef" - } - }, - "originatorParty": { - "description": "Individual or organization that created the problem", - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "responsibleParty": { - "description": "Individual or organization responsible for handling this problem", - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "relatedParty": { - "type": "array", - "description": "List of parties or party roles playing a role within the service problem", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "rootCauseResource": { - "type": "array", - "description": "Resource(s) that are associated to the underlying service problems that are the Root Cause of this one if any (used only if applicable).", - "items": { - "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" - } - }, - "rootCauseService": { - "type": "array", - "description": "Service(s) that are associated to the underlying service problems that are the Root Cause of this one if any (used only if applicable)", - "items": { - "$ref": "ServiceRef.schema.json#ServiceRef" - } - }, - "resolutionDate": { - "type": "string", - "format": "date-time", - "description": "Time the problem was resolved" - }, - "status": { - "type": "string", - "description": "The current status of the service problem. Possible values are Submitted, Rejected, Acknowledged, In Progress [Held, Pending], Resolved, Closed, and Cancelled." - }, - "statusChangeDate": { - "type": "string", - "format": "date-time", - "description": "Time the problem was last status changed" - }, - "statusChangeReason": { - "type": "string", - "description": "The reason of state change" - }, - "timeChanged": { - "type": "string", - "format": "date-time", - "description": "Time the problem was last changed" - }, - "timeRaised": { - "type": "string", - "format": "date-time", - "description": "Time the problem was raised" - }, - "trackingRecord": { - "type": "array", - "description": "List of tracking records that allow the tracking of modifications on the problem.The tracking records should not be embedded in the problem to allow retrieving the problem without the tracking records", - "items": { - "$ref": "TrackingRecord.schema.json#TrackingRecord" - } - }, - "underlyingAlarm": { - "type": "array", - "description": "A list of alarms underlying this problem.", - "items": { - "$ref": "../Resource/ResourceAlarmRef.schema.json#ResourceAlarmRef" - } - }, - "associatedSLAViolation": { - "type": "array", - "description": "A List of SLA violations associated with this problem.", - "items": { - "$ref": "../EngagedParty/SLAViolationRef.schema.json#SLAViolationRef" - } - }, - "associatedTroubleTicket": { - "type": "array", - "description": "A list of trouble tickets associated with this problem.", - "items": { - "$ref": "../Common/TroubleTicketRef.schema.json#TroubleTicketRef" - } - }, - "underlyingProblem": { - "type": "array", - "description": "A list of underlying problems. Relevant only if this problem is derived from other problems.", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceProblem.schema.json", + "title": "ServiceProblem", + "definitions": { + "ServiceProblem": { + "$id": "#ServiceProblem", + "type": "object", + "description": "The problem information for Middle B which is abstracted in the service layer from the issued event information by First B", + "properties": { + "affectedLocation": { + "type": "array", + "description": "A list of the locations affected by the problem. At least one of affectedResource, affectedService or affectedLocation should be present.", + "items": { + "$ref": "../Common/Place.schema.json#Place" + } + }, + "affectedNumberOfServices": { + "type": "integer", + "description": "Number of affected services" + }, + "affectedResource": { + "type": "array", + "description": "A list of the resources affected by the problem. At least one of affectedResource, affectedService or affectedLocation should be present.", + "items": { + "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" + } + }, + "affectedService": { + "type": "array", + "description": "List of affected services. At least one of affectedResource, affectedService or affectedLocation should be present.", + "items": { + "$ref": "ServiceRef.schema.json#ServiceRef" + } + }, + "category": { + "type": "string", + "description": "Classifier for the problem. Settable. For example, this is used for distinguish the category of problem originator in [role].[category] format. Example: serviceProvider.declarer, supplier.originated, system.originated" + }, + "comment": { + "type": "array", + "description": "A list of comments or notes made on the problem", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "correlationId": { + "type": "string", + "description": "Additional identifier coming from an external system" + }, + "description": { + "type": "string", + "description": "Free form text describing the Service Problem" + }, + "extensionInfo": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + }, + "description": "A generic list of any type of elements. Used for vendor Extensions or loose element encapsulation from other namespaces" + }, + "firstAlert": { + "description": "Indicates what first alerted the system to the problem. It is not the root cause of the Service Problem. Examples: Threshold crossing alert", + "$ref": "../Common/RelatedEntityRef.schema.json#RelatedEntityRef" + }, + "href": { + "type": "string", + "description": "Reference to the Service Problem" + }, + "id": { + "type": "string", + "description": "Identifier of the service problem" + }, + "impactImportanceFactor": { + "type": "string", + "description": "Impact Importance is characterized by an Impact Importance Factor: overall importance of the impact of all the affected services, e.g. 0 (zero impact) to 100 (worst impact). The Impact Importance is a calculated field which is set by the OSS determining the impact." + }, + "impactPatterns": { + "description": "Define the patterns of impact (optional)- e.g. other service characteristics- Used when defining impact through another pattern than the predefined attributes.", + "$ref": "ImpactPattern.schema.json#ImpactPattern" + }, + "originatingSystem": { + "type": "string", + "description": "Indicates where the problem was generated" + }, + "parentProblem": { + "type": "array", + "description": "The parent problem to which this problem is attached.", + "items": { + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "priority": { + "type": "integer", + "description": "An indication varying from 1 (highest) to 10 (lowest) of how important it is for the service provider to correct the Service Problem." + }, + "problemEscalation": { + "type": "string", + "description": "Indicates if this service problem has been escalated or not. Possible values are 0 to 10. A value of zero means no escalation. The meanings of values 1-10 are to be determined by the user of the interface, but they show increasing levels of escalation." + }, + "reason": { + "type": "string", + "description": "Free text or optionally structured text. It can be Unknown." + }, + "relatedEvent": { + "type": "array", + "description": "List of events associated to this problem", + "items": { + "$ref": "../Common/EventRef.schema.json#EventRef" + } + }, + "relatedObject": { + "type": "array", + "description": "List of objects associated to this problem", + "items": { + "$ref": "../Common/RelatedEntityRef.schema.json#RelatedEntityRef" + } + }, + "originatorParty": { + "description": "Individual or organization that created the problem", + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "responsibleParty": { + "description": "Individual or organization responsible for handling this problem", + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "relatedParty": { + "type": "array", + "description": "List of parties or party roles playing a role within the service problem", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "rootCauseResource": { + "type": "array", + "description": "Resource(s) that are associated to the underlying service problems that are the Root Cause of this one if any (used only if applicable).", + "items": { + "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" + } + }, + "rootCauseService": { + "type": "array", + "description": "Service(s) that are associated to the underlying service problems that are the Root Cause of this one if any (used only if applicable)", + "items": { + "$ref": "ServiceRef.schema.json#ServiceRef" + } + }, + "resolutionDate": { + "type": "string", + "format": "date-time", + "description": "Time the problem was resolved" + }, + "status": { + "type": "string", + "description": "The current status of the service problem. Possible values are Submitted, Rejected, Acknowledged, In Progress [Held, Pending], Resolved, Closed, and Cancelled." + }, + "statusChangeDate": { + "type": "string", + "format": "date-time", + "description": "Time the problem was last status changed" + }, + "statusChangeReason": { + "type": "string", + "description": "The reason of state change" + }, + "timeChanged": { + "type": "string", + "format": "date-time", + "description": "Time the problem was last changed" + }, + "timeRaised": { + "type": "string", + "format": "date-time", + "description": "Time the problem was raised" + }, + "trackingRecord": { + "type": "array", + "description": "List of tracking records that allow the tracking of modifications on the problem.The tracking records should not be embedded in the problem to allow retrieving the problem without the tracking records", + "items": { + "$ref": "TrackingRecord.schema.json#TrackingRecord" + } + }, + "underlyingAlarm": { + "type": "array", + "description": "A list of alarms underlying this problem.", + "items": { + "$ref": "../Resource/ResourceAlarmRef.schema.json#ResourceAlarmRef" + } + }, + "associatedSLAViolation": { + "type": "array", + "description": "A List of SLA violations associated with this problem.", + "items": { + "$ref": "../EngagedParty/SLAViolationRef.schema.json#SLAViolationRef" + } + }, + "associatedTroubleTicket": { + "type": "array", + "description": "A list of trouble tickets associated with this problem.", + "items": { + "$ref": "../Common/TroubleTicketRef.schema.json#TroubleTicketRef" + } + }, + "underlyingProblem": { + "type": "array", + "description": "A list of underlying problems. Relevant only if this problem is derived from other problems.", + "items": { + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceProblemEventRecord.schema.json b/Service/ServiceProblemEventRecord.schema.json index 1d3ae1a3..f1cb5b27 100644 --- a/Service/ServiceProblemEventRecord.schema.json +++ b/Service/ServiceProblemEventRecord.schema.json @@ -1,44 +1,44 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceProblemEventRecord.schema.json", - "title": "ServiceProblemEventRecord", - "definitions": { - "ServiceProblemEventRecord": { - "$id": "#ServiceProblemEventRecord", - "type": "object", - "description": "A record of an event (related to a service problem) received from another system", - "properties": { - "eventTime": { - "description": "Time at which the event occurred", - "type": "string", - "format": "date-time" - }, - "eventType": { - "description": "Type of the recorded event", - "type": "string" - }, - "href": { - "description": "reference to this resource", - "type": "string" - }, - "id": { - "description": "Identifier of the service problem event record.", - "type": "string" - }, - "recordTime": { - "description": "Time at which the record was created", - "type": "string", - "format": "date-time" - }, - "serviceProblem": { - "description": "The service problem to which this record applies", - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - }, - "notification": { - "description": "A notification from the possible notifications for Service Problem (such as creation, status change, information required, change)", - "$ref": "../Common/Any.schema.json#Any" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceProblemEventRecord.schema.json", + "title": "ServiceProblemEventRecord", + "definitions": { + "ServiceProblemEventRecord": { + "$id": "#ServiceProblemEventRecord", + "type": "object", + "description": "A record of an event (related to a service problem) received from another system", + "properties": { + "eventTime": { + "description": "Time at which the event occurred", + "type": "string", + "format": "date-time" + }, + "eventType": { + "description": "Type of the recorded event", + "type": "string" + }, + "href": { + "description": "reference to this resource", + "type": "string" + }, + "id": { + "description": "Identifier of the service problem event record.", + "type": "string" + }, + "recordTime": { + "description": "Time at which the record was created", + "type": "string", + "format": "date-time" + }, + "serviceProblem": { + "description": "The service problem to which this record applies", + "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" + }, + "notification": { + "description": "A notification from the possible notifications for Service Problem (such as creation, status change, information required, change)", + "$ref": "../Common/Any.schema.json#Any" + } + } } - } } - } } \ No newline at end of file diff --git a/Service/ServiceProblemRef.schema.json b/Service/ServiceProblemRef.schema.json index dd9faca9..82d231ca 100644 --- a/Service/ServiceProblemRef.schema.json +++ b/Service/ServiceProblemRef.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceProblemRef.schema.json", - "title": "ServiceProblemRef", - "definitions": { - "ServiceProblemRef": { - "$id": "#ServiceProblemRef", - "type": "object", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "correlationId": { - "type": "string", - "description": "Additional identifier coming from an external system" - }, - "href": { - "type": "string", - "description": "Reference of the Problem" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Problem" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceProblemRef.schema.json", + "title": "ServiceProblemRef", + "definitions": { + "ServiceProblemRef": { + "$id": "#ServiceProblemRef", + "type": "object", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "correlationId": { + "type": "string", + "description": "Additional identifier coming from an external system" + }, + "href": { + "type": "string", + "description": "Reference of the Problem" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Problem" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceQualification.schema.json b/Service/ServiceQualification.schema.json index d94aa690..c4f0b66a 100644 --- a/Service/ServiceQualification.schema.json +++ b/Service/ServiceQualification.schema.json @@ -1,95 +1,95 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceQualification.schema.json", - "title": "ServiceQualification", - "definitions": { - "ServiceQualification": { - "$id": "#ServiceQualification", - "type": "object", - "description": "ServiceQualification is used to perform a technical eligibility. It allows to retrieve a list of services that are technically available in the context of the interaction (place, party, service characteristics, ...).", - "properties": { - "description": { - "type": "string", - "description": "Description of the serviceQualification" - }, - "effectiveQualificationDate": { - "type": "string", - "description": "Effective date to serviceQualification completion", - "format": "date-time" - }, - "estimatedResponseDate": { - "type": "string", - "description": "Date when the requester expect to provide an answer for the qualification request.", - "format": "date-time" - }, - "expectedQualificationDate": { - "type": "string", - "description": "A date (DateTime). Deadline date when the requester expected a qualification answer.", - "format": "date-time" - }, - "expirationDate": { - "type": "string", - "description": "Date when the qualification response expires", - "format": "date-time" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the serviceQualification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the serviceQualification resource" - }, - "provideAlternative": { - "type": "boolean", - "description": "When the value is TRUE means that alternative solutions should be provided" - }, - "provideOnlyAvailable": { - "type": "boolean", - "description": "When the value is TRUE means that only available service must be listed in the response" - }, - "provideUnavailabilityReason": { - "type": "boolean", - "description": "When the value is TRUE means that unavailability reason are expected for non available service." - }, - "serviceQualificationDate": { - "type": "string", - "description": "Date when the serviceQualification was submitted", - "format": "date-time" - }, - "state": { - "type": "string", - "description": "State of the serviceQualification (acknowledged, inProgress, terminatedWithError, done)" - }, - "serviceQualificationItem": { - "type": "array", - "description": "A list of service qualification items.", - "minItems": 1, - "items": { - "$ref": "ServiceQualificationItem.schema.json#ServiceQualificationItem" - } - }, - "relatedParty": { - "type": "array", - "description": "A list of related party references, defines party or party role linked to this request.", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "externalId": { - "description": "Identifier provided by the requester", - "type": "string" - }, - "qualificationResult": { - "description": "Qualification result for this serviceQualification. It could be: qualified (all qualification item are qualified), alternate (At least one item alternate and no item with unqualified), unqualified (At least one item unqualified)", - "type": "string" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceQualification.schema.json", + "title": "ServiceQualification", + "definitions": { + "ServiceQualification": { + "$id": "#ServiceQualification", + "type": "object", + "description": "ServiceQualification is used to perform a technical eligibility. It allows to retrieve a list of services that are technically available in the context of the interaction (place, party, service characteristics, ...).", + "properties": { + "description": { + "type": "string", + "description": "Description of the serviceQualification" + }, + "effectiveQualificationDate": { + "type": "string", + "description": "Effective date to serviceQualification completion", + "format": "date-time" + }, + "estimatedResponseDate": { + "type": "string", + "description": "Date when the requester expect to provide an answer for the qualification request.", + "format": "date-time" + }, + "expectedQualificationDate": { + "type": "string", + "description": "A date (DateTime). Deadline date when the requester expected a qualification answer.", + "format": "date-time" + }, + "expirationDate": { + "type": "string", + "description": "Date when the qualification response expires", + "format": "date-time" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the serviceQualification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the serviceQualification resource" + }, + "provideAlternative": { + "type": "boolean", + "description": "When the value is TRUE means that alternative solutions should be provided" + }, + "provideOnlyAvailable": { + "type": "boolean", + "description": "When the value is TRUE means that only available service must be listed in the response" + }, + "provideUnavailabilityReason": { + "type": "boolean", + "description": "When the value is TRUE means that unavailability reason are expected for non available service." + }, + "serviceQualificationDate": { + "type": "string", + "description": "Date when the serviceQualification was submitted", + "format": "date-time" + }, + "state": { + "type": "string", + "description": "State of the serviceQualification (acknowledged, inProgress, terminatedWithError, done)" + }, + "serviceQualificationItem": { + "type": "array", + "description": "A list of service qualification items.", + "minItems": 1, + "items": { + "$ref": "ServiceQualificationItem.schema.json#ServiceQualificationItem" + } + }, + "relatedParty": { + "type": "array", + "description": "A list of related party references, defines party or party role linked to this request.", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "externalId": { + "description": "Identifier provided by the requester", + "type": "string" + }, + "qualificationResult": { + "description": "Qualification result for this serviceQualification. It could be: qualified (all qualification item are qualified), alternate (At least one item alternate and no item with unqualified), unqualified (At least one item unqualified)", + "type": "string" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceQualificationItem.schema.json b/Service/ServiceQualificationItem.schema.json index 43d48d33..4e52de16 100644 --- a/Service/ServiceQualificationItem.schema.json +++ b/Service/ServiceQualificationItem.schema.json @@ -1,89 +1,89 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceQualificationItem.schema.json", - "title": "ServiceQualificationItem", - "definitions": { - "ServiceQualificationItem": { - "$id": "#ServiceQualificationItem", - "description": "A ServiceQualificationItem relates to a specific service being checked in a qualification operation.", - "type": "object", - "properties": { - "expectedActivationDate": { - "type": "string", - "description": "The date when the service is expected to be activated", - "format": "date-time" - }, - "id": { - "type": "string", - "description": "Id of the Service Qualification Item" - }, - "qualificationResult": { - "type": "string", - "description": "Qualification result for serviceQualification item. It could be: - qualified (request service are available), - unqualified (requested not available and not alternate available), - alternate (requested not available but proposal available)" - }, - "state": { - "type": "string", - "description": "State of the serviceQualification item (acknowledged, inProgress, terminatedWithError, done)" - }, - "service": { - "description": "Configure the service characteristics (only configurable characteristics and necessary only if a non default value is selected) and/or identify the service that needs to be modified/deleted.", - "$ref": "ServiceRestriction.schema.json#/definitions/ServiceRestriction" - }, - "qualificationRelationship": { - "type": "array", - "description": "Structure used to describe relationship between serviceQualification item from the same serviceQualification.", - "items": { - "$ref": "ServiceQualificationRelationship.schema.json#ServiceQualificationRelationship" - } - }, - "expectedServiceAvailabilityDate": { - "description": "Date when the requester looks for service availability", - "type": "string", - "format": "date-time" - }, - "expirationDate": { - "description": "Date when the qualification item response expires", - "type": "string", - "format": "date-time" - }, - "eligibilityUnavailabilityReason": { - "type": "array", - "description": "A list of eligibility unavailability reasons (EligibilityUnavailabilityReason [*]). Reason for eligibility result if the serviceQualification result is no (meaning the service is not available).", - "items": { - "$ref": "ServiceEligibilityUnavailabilityReason.schema.json#ServiceEligibilityUnavailabilityReason" - } - }, - "category": { - "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.", - "$ref": "ServiceCategoryRef.schema.json#ServiceCategoryRef" - }, - "qualificationItemRelationship": { - "type": "array", - "description": "A list of qualification item relationships used to describe relationship between serviceQualification item from the same serviceQualification.", - "items": { - "$ref": "ServiceQualificationItemRelationship.schema.json#ServiceQualificationItemRelationship" - } - }, - "terminationError": { - "type": "array", - "description": "If qualificationItem has not been done properly this lists the error(s) that caused termination of the qualification.", - "items": { - "$ref": "TerminationError.schema.json#TerminationError" - } - }, - "alternateServiceProposal": { - "type": "array", - "description": "Alternate service proposal is used when the requested service is not available with characteristic and date asked for. An alternate proposal could be a distinct service Spec close to requested one or same as requested but with a different availability date.", - "items": { - "$ref": "AlternateServiceProposal.schema.json#AlternateServiceProposal" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceQualificationItem.schema.json", + "title": "ServiceQualificationItem", + "definitions": { + "ServiceQualificationItem": { + "$id": "#ServiceQualificationItem", + "description": "A ServiceQualificationItem relates to a specific service being checked in a qualification operation.", + "type": "object", + "properties": { + "expectedActivationDate": { + "type": "string", + "description": "The date when the service is expected to be activated", + "format": "date-time" + }, + "id": { + "type": "string", + "description": "Id of the Service Qualification Item" + }, + "qualificationResult": { + "type": "string", + "description": "Qualification result for serviceQualification item. It could be: - qualified (request service are available), - unqualified (requested not available and not alternate available), - alternate (requested not available but proposal available)" + }, + "state": { + "type": "string", + "description": "State of the serviceQualification item (acknowledged, inProgress, terminatedWithError, done)" + }, + "service": { + "description": "Configure the service characteristics (only configurable characteristics and necessary only if a non default value is selected) and/or identify the service that needs to be modified/deleted.", + "$ref": "ServiceRestriction.schema.json#/definitions/ServiceRestriction" + }, + "qualificationRelationship": { + "type": "array", + "description": "Structure used to describe relationship between serviceQualification item from the same serviceQualification.", + "items": { + "$ref": "ServiceQualificationRelationship.schema.json#ServiceQualificationRelationship" + } + }, + "expectedServiceAvailabilityDate": { + "description": "Date when the requester looks for service availability", + "type": "string", + "format": "date-time" + }, + "expirationDate": { + "description": "Date when the qualification item response expires", + "type": "string", + "format": "date-time" + }, + "eligibilityUnavailabilityReason": { + "type": "array", + "description": "A list of eligibility unavailability reasons (EligibilityUnavailabilityReason [*]). Reason for eligibility result if the serviceQualification result is no (meaning the service is not available).", + "items": { + "$ref": "ServiceEligibilityUnavailabilityReason.schema.json#ServiceEligibilityUnavailabilityReason" + } + }, + "category": { + "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.", + "$ref": "ServiceCategoryRef.schema.json#ServiceCategoryRef" + }, + "qualificationItemRelationship": { + "type": "array", + "description": "A list of qualification item relationships used to describe relationship between serviceQualification item from the same serviceQualification.", + "items": { + "$ref": "ServiceQualificationItemRelationship.schema.json#ServiceQualificationItemRelationship" + } + }, + "terminationError": { + "type": "array", + "description": "If qualificationItem has not been done properly this lists the error(s) that caused termination of the qualification.", + "items": { + "$ref": "TerminationError.schema.json#TerminationError" + } + }, + "alternateServiceProposal": { + "type": "array", + "description": "Alternate service proposal is used when the requested service is not available with characteristic and date asked for. An alternate proposal could be a distinct service Spec close to requested one or same as requested but with a different availability date.", + "items": { + "$ref": "AlternateServiceProposal.schema.json#AlternateServiceProposal" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceQualificationItemRelationship.schema.json b/Service/ServiceQualificationItemRelationship.schema.json index 77ac2cf7..dfa4ecd0 100644 --- a/Service/ServiceQualificationItemRelationship.schema.json +++ b/Service/ServiceQualificationItemRelationship.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceQualificationItemRelationship.schema.json", - "title": "ServiceQualificationItemRelationship", - "definitions": { - "ServiceQualificationItemRelationship": { - "$id": "#ServiceQualificationItemRelationship", - "description": "Structure used to describe relationship between serviceQualification items from the same serviceQualification.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Id of the serviceQualificationItem (from the same serviceQualificationItem)." - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship (ex: reliesOn, connectedTo, etc...)" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceQualificationItemRelationship.schema.json", + "title": "ServiceQualificationItemRelationship", + "definitions": { + "ServiceQualificationItemRelationship": { + "$id": "#ServiceQualificationItemRelationship", + "description": "Structure used to describe relationship between serviceQualification items from the same serviceQualification.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Id of the serviceQualificationItem (from the same serviceQualificationItem)." + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship (ex: reliesOn, connectedTo, etc...)" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceQualificationRelationship.schema.json b/Service/ServiceQualificationRelationship.schema.json index 3f820f46..a967b3e8 100644 --- a/Service/ServiceQualificationRelationship.schema.json +++ b/Service/ServiceQualificationRelationship.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceQualificationRelationship.schema.json", - "title": "ServiceQualificationRelationship", - "definitions": { - "ServiceQualificationRelationship": { - "$id": "#ServiceQualificationRelationship", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The id of the target qualification pointed to by this relationship" - }, - "relationshipType": { - "type": "string", - "description": "The type of relationship" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceQualificationRelationship.schema.json", + "title": "ServiceQualificationRelationship", + "definitions": { + "ServiceQualificationRelationship": { + "$id": "#ServiceQualificationRelationship", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The id of the target qualification pointed to by this relationship" + }, + "relationshipType": { + "type": "string", + "description": "The type of relationship" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceRef.schema.json b/Service/ServiceRef.schema.json index 9120523c..cbbc7e6c 100644 --- a/Service/ServiceRef.schema.json +++ b/Service/ServiceRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceRef.schema.json", - "title": "ServiceRef", - "definitions": { - "ServiceRef": { - "$id": "#ServiceRef", - "description": "Service reference, for when Service is used by other entities", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceRef.schema.json", + "title": "ServiceRef", + "definitions": { + "ServiceRef": { + "$id": "#ServiceRef", + "description": "Service reference, for when Service is used by other entities", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceRelationship.schema.json b/Service/ServiceRelationship.schema.json index 5be86018..f22b3074 100644 --- a/Service/ServiceRelationship.schema.json +++ b/Service/ServiceRelationship.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceRelationship.schema.json", - "title": "ServiceRelationship", - "definitions": { - "ServiceRelationship": { - "$id": "#ServiceRelationship", - "description": "Describes links with services of the same category (useful for bundled services)", - "type": "object", - "required": [ - "relationshipType", - "service" - ], - "properties": { - "relationshipType": { - "type": "string", - "description": "The type of relationship (e.g. depends on, enables)" - }, - "service": { - "description": "The service being referred to", - "$ref": "ServiceRef.schema.json#ServiceRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceRelationship.schema.json", + "title": "ServiceRelationship", + "definitions": { + "ServiceRelationship": { + "$id": "#ServiceRelationship", + "description": "Describes links with services of the same category (useful for bundled services)", + "type": "object", + "required": [ + "relationshipType", + "service" + ], + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of relationship (e.g. depends on, enables)" + }, + "service": { + "description": "The service being referred to", + "$ref": "ServiceRef.schema.json#ServiceRef" + } + } } - } } - } } \ No newline at end of file diff --git a/Service/ServiceSpecCharRelationship.schema.json b/Service/ServiceSpecCharRelationship.schema.json index 81694b4d..6d751a5d 100644 --- a/Service/ServiceSpecCharRelationship.schema.json +++ b/Service/ServiceSpecCharRelationship.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceSpecCharRelationship.schema.json", - "title": "ServiceSpecCharRelationship", - "definitions": { - "ServiceSpecCharRelationship": { - "$id": "#ServiceSpecCharRelationship", - "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among serviceSpecCharacteristics.", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" - }, - "role": { - "type": "string", - "description": "The association role for this service specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the target specification" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to the target specification" - }, - "name": { - "type": "string", - "description": "Name of the target characteristic" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the serviceSpecCharRelationship is valid" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceSpecCharRelationship.schema.json", + "title": "ServiceSpecCharRelationship", + "definitions": { + "ServiceSpecCharRelationship": { + "$id": "#ServiceSpecCharRelationship", + "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among serviceSpecCharacteristics.", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" + }, + "role": { + "type": "string", + "description": "The association role for this service specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the target specification" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to the target specification" + }, + "name": { + "type": "string", + "description": "Name of the target characteristic" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the serviceSpecCharRelationship is valid" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceSpecCharacteristic.schema.json b/Service/ServiceSpecCharacteristic.schema.json index 04f255ea..47f8a4f6 100644 --- a/Service/ServiceSpecCharacteristic.schema.json +++ b/Service/ServiceSpecCharacteristic.schema.json @@ -1,77 +1,77 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceSpecCharacteristic.schema.json", - "title": "ServiceSpecCharacteristic", - "definitions": { - "ServiceSpecCharacteristic": { - "$id": "#ServiceSpecCharacteristic", - "description": "This class represents the key features of this service specification. For example, bandwidth is a characteristic of many different types of services; if bandwidth is a relevant characteristic (e.g., from the point-of-view of a Customer obtaining this Service via a Product) then bandwidth would be a ServiceSpecCharacteristic for that particular Service.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications." - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the serviceSpecCharacteristic is" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" - }, - "configurable": { - "type": "boolean", - "description": "If true, the Boolean indicates that the serviceSpecCharacteristic is configurable" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the serviceSpecCharacteristic is valid" - }, - "@valueSchemaLocation": { - "type": "string", - "description": "This (optional) field provides a link to the schema describing the value type." - }, - "minCardinality": { - "type": "integer", - "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality." - }, - "maxCardinality": { - "type": "integer", - "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality." - }, - "isUnique": { - "type": "boolean", - "description": "An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"" - }, - "regex": { - "type": "string", - "description": "A rule or principle represented in regular expression used to derive the value of a characteristic value." - }, - "extensible": { - "type": "boolean", - "description": "An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for an Entity." - }, - "serviceSpecCharacteristicValue": { - "type": "array", - "description": "A list of service spec characteristic values (ServiceSpecCharacteristicValue [*]). A ServiceSpecCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ServiceSpecCharacteristic object. The values of the attributes in the ServiceSpecCharacteristicValue object describe the values of the attributes that a corresponding ServiceSpecCharacteristic object can take on.", - "items": { - "$ref": "ServiceSpecCharacteristicValue.schema.json#ServiceSpecCharacteristicValue" - } - }, - "serviceSpecCharRelationship": { - "type": "array", - "description": "A list of service spec char relationships (ServiceSpecCharRelationship [*]). An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.", - "items": { - "$ref": "ServiceSpecCharRelationship.schema.json#ServiceSpecCharRelationship" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceSpecCharacteristic.schema.json", + "title": "ServiceSpecCharacteristic", + "definitions": { + "ServiceSpecCharacteristic": { + "$id": "#ServiceSpecCharacteristic", + "description": "This class represents the key features of this service specification. For example, bandwidth is a characteristic of many different types of services; if bandwidth is a relevant characteristic (e.g., from the point-of-view of a Customer obtaining this Service via a Product) then bandwidth would be a ServiceSpecCharacteristic for that particular Service.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications." + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the serviceSpecCharacteristic is" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" + }, + "configurable": { + "type": "boolean", + "description": "If true, the Boolean indicates that the serviceSpecCharacteristic is configurable" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the serviceSpecCharacteristic is valid" + }, + "@valueSchemaLocation": { + "type": "string", + "description": "This (optional) field provides a link to the schema describing the value type." + }, + "minCardinality": { + "type": "integer", + "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality." + }, + "maxCardinality": { + "type": "integer", + "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality." + }, + "isUnique": { + "type": "boolean", + "description": "An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"" + }, + "regex": { + "type": "string", + "description": "A rule or principle represented in regular expression used to derive the value of a characteristic value." + }, + "extensible": { + "type": "boolean", + "description": "An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for an Entity." + }, + "serviceSpecCharacteristicValue": { + "type": "array", + "description": "A list of service spec characteristic values (ServiceSpecCharacteristicValue [*]). A ServiceSpecCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ServiceSpecCharacteristic object. The values of the attributes in the ServiceSpecCharacteristicValue object describe the values of the attributes that a corresponding ServiceSpecCharacteristic object can take on.", + "items": { + "$ref": "ServiceSpecCharacteristicValue.schema.json#ServiceSpecCharacteristicValue" + } + }, + "serviceSpecCharRelationship": { + "type": "array", + "description": "A list of service spec char relationships (ServiceSpecCharRelationship [*]). An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.", + "items": { + "$ref": "ServiceSpecCharRelationship.schema.json#ServiceSpecCharRelationship" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceSpecCharacteristicValue.schema.json b/Service/ServiceSpecCharacteristicValue.schema.json index f2ec1fd7..f2bf3aea 100644 --- a/Service/ServiceSpecCharacteristicValue.schema.json +++ b/Service/ServiceSpecCharacteristicValue.schema.json @@ -1,55 +1,55 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceSpecCharacteristicValue.schema.json", - "title": "ServiceSpecCharacteristicValue", - "definitions": { - "ServiceSpecCharacteristicValue": { - "$id": "#ServiceSpecCharacteristicValue", - "description": "A ServiceSpecCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ServiceSpecCharacteristic object. The values of the attributes in the ServiceSpecCharacteristicValue object describe the values of the attributes that a corresponding ServiceSpecCharacteristic object can take on.", - "type": "object", - "properties": { - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" - }, - "isDefault": { - "type": "boolean", - "description": "Indicates if the value is the default value for a characteristic" - }, - "value": { - "$ref": "../Common/Any.schema.json#Any", - "description": "A discrete value that the characteristic can take on, or the actual value of the characteristic" - }, - "unitOfMeasure": { - "type": "string", - "description": "A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period of time for which a value is applicable" - }, - "valueFrom": { - "type": "integer", - "description": "The low range value that a characteristic can take on" - }, - "valueTo": { - "type": "integer", - "description": "The upper range value that a characteristic can take on" - }, - "rangeInterval": { - "type": "string", - "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." - }, - "regex": { - "type": "string", - "description": "A regular expression constraint for given value" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceSpecCharacteristicValue.schema.json", + "title": "ServiceSpecCharacteristicValue", + "definitions": { + "ServiceSpecCharacteristicValue": { + "$id": "#ServiceSpecCharacteristicValue", + "description": "A ServiceSpecCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ServiceSpecCharacteristic object. The values of the attributes in the ServiceSpecCharacteristicValue object describe the values of the attributes that a corresponding ServiceSpecCharacteristic object can take on.", + "type": "object", + "properties": { + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" + }, + "isDefault": { + "type": "boolean", + "description": "Indicates if the value is the default value for a characteristic" + }, + "value": { + "$ref": "../Common/Any.schema.json#Any", + "description": "A discrete value that the characteristic can take on, or the actual value of the characteristic" + }, + "unitOfMeasure": { + "type": "string", + "description": "A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period of time for which a value is applicable" + }, + "valueFrom": { + "type": "integer", + "description": "The low range value that a characteristic can take on" + }, + "valueTo": { + "type": "integer", + "description": "The upper range value that a characteristic can take on" + }, + "rangeInterval": { + "type": "string", + "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." + }, + "regex": { + "type": "string", + "description": "A regular expression constraint for given value" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceSpecRelationship.schema.json b/Service/ServiceSpecRelationship.schema.json index bc8473c9..8300d6c2 100644 --- a/Service/ServiceSpecRelationship.schema.json +++ b/Service/ServiceSpecRelationship.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceSpecRelationship.schema.json", - "title": "ServiceSpecRelationship", - "definitions": { - "ServiceSpecRelationship": { - "$id": "#ServiceSpecRelationship", - "description": "A migration, substitution, dependency or exclusivity relationship between/among service specifications.", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of relationship such as migration, substitution, dependency, exclusivity" - }, - "role": { - "type": "string", - "description": "The association role for this service specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the target serviceSpecification" - }, - "href": { - "type": "string", - "description": "Reference of the target serviceSpecification" - }, - "name": { - "type": "string", - "description": "The name given to the target service specification instance" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the serviceSpecRelationship is valid" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceSpecRelationship.schema.json", + "title": "ServiceSpecRelationship", + "definitions": { + "ServiceSpecRelationship": { + "$id": "#ServiceSpecRelationship", + "description": "A migration, substitution, dependency or exclusivity relationship between/among service specifications.", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of relationship such as migration, substitution, dependency, exclusivity" + }, + "role": { + "type": "string", + "description": "The association role for this service specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the target serviceSpecification" + }, + "href": { + "type": "string", + "description": "Reference of the target serviceSpecification" + }, + "name": { + "type": "string", + "description": "The name given to the target service specification instance" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the serviceSpecRelationship is valid" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceSpecification.schema.json b/Service/ServiceSpecification.schema.json index b9dd5529..f8060c27 100644 --- a/Service/ServiceSpecification.schema.json +++ b/Service/ServiceSpecification.schema.json @@ -1,102 +1,102 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceSpecification.schema.json", - "title": "ServiceSpecification", - "definitions": { - "ServiceSpecification": { - "$id": "#ServiceSpecification", - "description": "ServiceSpecification is a class that offers characteristics to describe a type of service.\nFunctionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the service specification" - }, - "href": { - "type": "string", - "description": "Reference of the service specification" - }, - "name": { - "type": "string", - "description": "Name of the service specification" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the service specification is" - }, - "version": { - "type": "string", - "description": "Service specification version" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the service specification is valid" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update of the service specification" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status of the service specification" - }, - "isBundle": { - "type": "boolean", - "description": "isBundle determines whether a ServiceSpecification represents a single ServiceSpecification (false), or a bundle of ServiceSpecification (true)." - }, - "resourceSpecification": { - "type": "array", - "description": "A list of resource specification references (ResourceSpecificationRef [*]). The ResourceSpecification is required for a service specification with type ResourceFacingServiceSpecification (RFSS).", - "items": { - "$ref": "../Resource/ResourceSpecificationRef.schema.json#ResourceSpecificationRef" - } - }, - "attachment": { - "type": "array", - "description": "A list of attachments (Attachment [*]). Complements the description of the specification through video, pictures...", - "items": { - "$ref": "../Common/AttachmentRef.schema.json#AttachmentRef" - } - }, - "serviceSpecCharacteristic": { - "type": "array", - "description": "A list of service spec characteristics (ServiceSpecCharacteristic [*]). This class represents the key features of this service specification.", - "items": { - "$ref": "ServiceSpecCharacteristic.schema.json#ServiceSpecCharacteristic" - } - }, - "relatedParty": { - "type": "array", - "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity.", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "serviceSpecRelationship": { - "type": "array", - "description": "A list of service specifications related to this specification, e.g. migration, substitution, dependency or exclusivity relationship", - "items": { - "$ref": "ServiceSpecRelationship.schema.json#ServiceSpecRelationship" - } - }, - "serviceLevelSpecification": { - "type": "array", - "description": "A list of service level specifications related to this service specification, and which will need to be satisifiable for corresponding service instances; e.g. Gold, Platinum", - "items": { - "$ref": "ServiceLevelSpecificationRef.schema.json#ServiceLevelSpecificationRef" - } - }, - "targetServiceSchema": { - "description": "A target service schema reference (TargetServiceSchemaRef). The reference object to the schema and type of target service which is described by service specification.", - "$ref": "TargetServiceSchema.schema.json#TargetServiceSchema" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceSpecification.schema.json", + "title": "ServiceSpecification", + "definitions": { + "ServiceSpecification": { + "$id": "#ServiceSpecification", + "description": "ServiceSpecification is a class that offers characteristics to describe a type of service.\nFunctionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the service specification" + }, + "href": { + "type": "string", + "description": "Reference of the service specification" + }, + "name": { + "type": "string", + "description": "Name of the service specification" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the service specification is" + }, + "version": { + "type": "string", + "description": "Service specification version" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the service specification is valid" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update of the service specification" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status of the service specification" + }, + "isBundle": { + "type": "boolean", + "description": "isBundle determines whether a ServiceSpecification represents a single ServiceSpecification (false), or a bundle of ServiceSpecification (true)." + }, + "resourceSpecification": { + "type": "array", + "description": "A list of resource specification references (ResourceSpecificationRef [*]). The ResourceSpecification is required for a service specification with type ResourceFacingServiceSpecification (RFSS).", + "items": { + "$ref": "../Resource/ResourceSpecificationRef.schema.json#ResourceSpecificationRef" + } + }, + "attachment": { + "type": "array", + "description": "A list of attachments (Attachment [*]). Complements the description of the specification through video, pictures...", + "items": { + "$ref": "../Common/AttachmentRef.schema.json#AttachmentRef" + } + }, + "serviceSpecCharacteristic": { + "type": "array", + "description": "A list of service spec characteristics (ServiceSpecCharacteristic [*]). This class represents the key features of this service specification.", + "items": { + "$ref": "ServiceSpecCharacteristic.schema.json#ServiceSpecCharacteristic" + } + }, + "relatedParty": { + "type": "array", + "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity.", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "serviceSpecRelationship": { + "type": "array", + "description": "A list of service specifications related to this specification, e.g. migration, substitution, dependency or exclusivity relationship", + "items": { + "$ref": "ServiceSpecRelationship.schema.json#ServiceSpecRelationship" + } + }, + "serviceLevelSpecification": { + "type": "array", + "description": "A list of service level specifications related to this service specification, and which will need to be satisifiable for corresponding service instances; e.g. Gold, Platinum", + "items": { + "$ref": "ServiceLevelSpecificationRef.schema.json#ServiceLevelSpecificationRef" + } + }, + "targetServiceSchema": { + "description": "A target service schema reference (TargetServiceSchemaRef). The reference object to the schema and type of target service which is described by service specification.", + "$ref": "TargetServiceSchema.schema.json#TargetServiceSchema" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceSpecificationRef.schema.json b/Service/ServiceSpecificationRef.schema.json index 0cba4b88..87871da4 100644 --- a/Service/ServiceSpecificationRef.schema.json +++ b/Service/ServiceSpecificationRef.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceSpecificationRef.schema.json", - "title": "ServiceSpecificationRef", - "definitions": { - "ServiceSpecificationRef": { - "$id": "#ServiceSpecificationRef", - "description": "Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the service specification" - }, - "href": { - "type": "string", - "description": "Reference of the serviceSpecification" - }, - "name": { - "type": "string", - "description": "Name of the requiredServiceSpecification" - }, - "version": { - "type": "string", - "description": "Service specification version" - }, - "targetServiceSchema": { - "description": "A target service schema reference (TargetServiceSchemaRef). The reference object to the schema and type of target service which is described by service specification.", - "$ref": "TargetServiceSchema.schema.json#TargetServiceSchema" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceSpecificationRef.schema.json", + "title": "ServiceSpecificationRef", + "definitions": { + "ServiceSpecificationRef": { + "$id": "#ServiceSpecificationRef", + "description": "Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the service specification" + }, + "href": { + "type": "string", + "description": "Reference of the serviceSpecification" + }, + "name": { + "type": "string", + "description": "Name of the requiredServiceSpecification" + }, + "version": { + "type": "string", + "description": "Service specification version" + }, + "targetServiceSchema": { + "description": "A target service schema reference (TargetServiceSchemaRef). The reference object to the schema and type of target service which is described by service specification.", + "$ref": "TargetServiceSchema.schema.json#TargetServiceSchema" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceStateType.schema.json b/Service/ServiceStateType.schema.json index f67c7b6d..054e418e 100644 --- a/Service/ServiceStateType.schema.json +++ b/Service/ServiceStateType.schema.json @@ -1,20 +1,20 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceStateType.schema.json", - "title": "ServiceStateType", - "definitions": { - "ServiceStateType": { - "$id": "#ServiceStateType", - "type": "string", - "description": "Valid values for the lifecycle state of the service", - "enum": [ - "feasibilityChecked", - "designed", - "reserved", - "inactive", - "active", - "terminated" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceStateType.schema.json", + "title": "ServiceStateType", + "definitions": { + "ServiceStateType": { + "$id": "#ServiceStateType", + "type": "string", + "description": "Valid values for the lifecycle state of the service", + "enum": [ + "feasibilityChecked", + "designed", + "reserved", + "inactive", + "active", + "terminated" + ] + } } - } } \ No newline at end of file diff --git a/Service/ServiceTest.schema.json b/Service/ServiceTest.schema.json index e4a3b548..0f393cba 100644 --- a/Service/ServiceTest.schema.json +++ b/Service/ServiceTest.schema.json @@ -1,75 +1,75 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceTest.schema.json", - "title": "ServiceTest", - "definitions": { - "ServiceTest": { - "$id": "#ServiceTest", - "description": "A service test is an entity that exists for a controlled test invocation on a service. The service \ntest is executed according to a schedule and contains service test configuration parameters that are to be \napplied at execution time, and service test measures that result.", - "type": "object", - "properties": { - "characteristic": { - "type": "array", - "description": "List of characteristics with values that define the test run", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - } - }, - "description": { - "type": "string", - "description": "Description of the service test" - }, - "endDateTime": { - "type": "string", - "format": "date-time", - "description": "The end date and time of the service test" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the service test" - }, - "id": { - "type": "string", - "description": "The identifier of the service test" - }, - "mode": { - "type": "string", - "description": "An indication of whether the service test is running in \n\"PROACTIVE\" or \"ONDEMAND\" mode" - }, - "name": { - "type": "string", - "description": "The name of the service test" - }, - "relatedService": { - "description": "The actual service being tested", - "$ref": "ServiceRef.schema.json#ServiceRef" - }, - "startDateTime": { - "type": "string", - "format": "date-time", - "description": "The start date and time of the service test." - }, - "state": { - "type": "string", - "description": "The actual state the service test is in" - }, - "testMeasure": { - "type": "array", - "description": "The results of the test in terms of the measured metrics", - "items": { - "$ref": "TestMeasure.schema.json#TestMeasure" - } - }, - "testSpecification": { - "description": "The specification for this test", - "$ref": "ServiceTestSpecificationRef.schema.json#ServiceTestSpecificationRef" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceTest.schema.json", + "title": "ServiceTest", + "definitions": { + "ServiceTest": { + "$id": "#ServiceTest", + "description": "A service test is an entity that exists for a controlled test invocation on a service. The service \ntest is executed according to a schedule and contains service test configuration parameters that are to be \napplied at execution time, and service test measures that result.", + "type": "object", + "properties": { + "characteristic": { + "type": "array", + "description": "List of characteristics with values that define the test run", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "description": { + "type": "string", + "description": "Description of the service test" + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "The end date and time of the service test" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the service test" + }, + "id": { + "type": "string", + "description": "The identifier of the service test" + }, + "mode": { + "type": "string", + "description": "An indication of whether the service test is running in \n\"PROACTIVE\" or \"ONDEMAND\" mode" + }, + "name": { + "type": "string", + "description": "The name of the service test" + }, + "relatedService": { + "description": "The actual service being tested", + "$ref": "ServiceRef.schema.json#ServiceRef" + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "The start date and time of the service test." + }, + "state": { + "type": "string", + "description": "The actual state the service test is in" + }, + "testMeasure": { + "type": "array", + "description": "The results of the test in terms of the measured metrics", + "items": { + "$ref": "TestMeasure.schema.json#TestMeasure" + } + }, + "testSpecification": { + "description": "The specification for this test", + "$ref": "ServiceTestSpecificationRef.schema.json#ServiceTestSpecificationRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceTestCharacteristic.schema.json b/Service/ServiceTestCharacteristic.schema.json index 3387366f..24d8ee3d 100644 --- a/Service/ServiceTestCharacteristic.schema.json +++ b/Service/ServiceTestCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceTestCharacteristic.schema.json", - "title": "ServiceTestCharacteristic", - "definitions": { - "ServiceTestCharacteristic": { - "$id": "#ServiceTestCharacteristic", - "description": "The configuration of the service test is set by the service test characteristic.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the characteristic." - }, - "value": { - "type": "string", - "description": "The value of characteristic." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceTestCharacteristic.schema.json", + "title": "ServiceTestCharacteristic", + "definitions": { + "ServiceTestCharacteristic": { + "$id": "#ServiceTestCharacteristic", + "description": "The configuration of the service test is set by the service test characteristic.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the characteristic." + }, + "value": { + "type": "string", + "description": "The value of characteristic." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceTestSpecification.schema.json b/Service/ServiceTestSpecification.schema.json index 6365502d..8c3c392d 100644 --- a/Service/ServiceTestSpecification.schema.json +++ b/Service/ServiceTestSpecification.schema.json @@ -1,54 +1,54 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceTestSpecification.schema.json", - "title": "ServiceTestSpecification", - "definitions": { - "ServiceTestSpecification": { - "$id": "#ServiceTestSpecification", - "description": "The service test specification describes the service test in terms of parameters to be configured and \nmeasures to be taken.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of a service test specification." - }, - "href": { - "type": "string", - "description": "Hyperlink to access a service test specification." - }, - "id": { - "type": "string", - "description": "Identifier of a service test specification." - }, - "version": { - "type": "string", - "description": "Version of a service test specification " - }, - "name": { - "type": "string", - "description": "Name of a service test specification." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period of time for which this specification is valid" - }, - "testMeasureDefinition": { - "type": "array", - "description": "A list of definitions for the measurements for the test defined by this specification", - "items": { - "$ref": "TestMeasureDefinition.schema.json#TestMeasureDefinition" - } - }, - "relatedServiceSpecification": { - "$ref": "ServiceSpecificationRef.schema.json#ServiceSpecificationRef", - "description": "The related service specification." + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceTestSpecification.schema.json", + "title": "ServiceTestSpecification", + "definitions": { + "ServiceTestSpecification": { + "$id": "#ServiceTestSpecification", + "description": "The service test specification describes the service test in terms of parameters to be configured and \nmeasures to be taken.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of a service test specification." + }, + "href": { + "type": "string", + "description": "Hyperlink to access a service test specification." + }, + "id": { + "type": "string", + "description": "Identifier of a service test specification." + }, + "version": { + "type": "string", + "description": "Version of a service test specification " + }, + "name": { + "type": "string", + "description": "Name of a service test specification." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period of time for which this specification is valid" + }, + "testMeasureDefinition": { + "type": "array", + "description": "A list of definitions for the measurements for the test defined by this specification", + "items": { + "$ref": "TestMeasureDefinition.schema.json#TestMeasureDefinition" + } + }, + "relatedServiceSpecification": { + "$ref": "ServiceSpecificationRef.schema.json#ServiceSpecificationRef", + "description": "The related service specification." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/ServiceTestSpecificationRef.schema.json b/Service/ServiceTestSpecificationRef.schema.json index 2ad03dae..98b2eceb 100644 --- a/Service/ServiceTestSpecificationRef.schema.json +++ b/Service/ServiceTestSpecificationRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceTestSpecificationRef.schema.json", - "title": "ServiceTestSpecificationRef", - "definitions": { - "ServiceTestSpecificationRef": { - "$id": "#ServiceTestSpecificationRef", - "type": "object", - "description": "The service test specification used by the service test.", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "href": { - "type": "string", - "description": "Hyperlink to access a service test specification." - }, - "id": { - "type": "string", - "description": "Identifier of a service test specification." - }, - "version": { - "type": "string", - "description": "Version of a service test specification " + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceTestSpecificationRef.schema.json", + "title": "ServiceTestSpecificationRef", + "definitions": { + "ServiceTestSpecificationRef": { + "$id": "#ServiceTestSpecificationRef", + "type": "object", + "description": "The service test specification used by the service test.", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "href": { + "type": "string", + "description": "Hyperlink to access a service test specification." + }, + "id": { + "type": "string", + "description": "Identifier of a service test specification." + }, + "version": { + "type": "string", + "description": "Version of a service test specification " + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/SupportingService.schema.json b/Service/SupportingService.schema.json index 6642e4b9..275d0aff 100644 --- a/Service/SupportingService.schema.json +++ b/Service/SupportingService.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SupportingService.schema.json", - "title": "SupportingService", - "definitions": { - "SupportingService": { - "$id": "#SupportingService", - "description": "A collection of services that support this service (links between CFS -> RFS)", - "type": "object", - "properties": { - "category": { - "type": "string", - "description": "Category of the supporting service" - }, - "href": { - "type": "string", - "description": "Reference of the supporting service" - }, - "id": { - "type": "string", - "description": "Unique identifier of the supporting service" - }, - "name": { - "type": "string", - "description": "Name of the supporting service" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SupportingService.schema.json", + "title": "SupportingService", + "definitions": { + "SupportingService": { + "$id": "#SupportingService", + "description": "A collection of services that support this service (links between CFS -> RFS)", + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Category of the supporting service" + }, + "href": { + "type": "string", + "description": "Reference of the supporting service" + }, + "id": { + "type": "string", + "description": "Unique identifier of the supporting service" + }, + "name": { + "type": "string", + "description": "Name of the supporting service" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/TargetServiceSchema.schema.json b/Service/TargetServiceSchema.schema.json index b89c4851..30d0595f 100644 --- a/Service/TargetServiceSchema.schema.json +++ b/Service/TargetServiceSchema.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TargetServiceSchema.schema.json", - "title": "TargetServiceSchema", - "definitions": { - "TargetServiceSchema": { - "$id": "#TargetServiceSchema", - "type": "object", - "description": "The reference object to the schema and type of target service which is described by service specification", - "properties": { - "@type": { - "type": "string", - "description": "Class type of the target service" - }, - "@schemaLocation": { - "type": "string", - "description": "This field provides a link to the schema describing the target service" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TargetServiceSchema.schema.json", + "title": "TargetServiceSchema", + "definitions": { + "TargetServiceSchema": { + "$id": "#TargetServiceSchema", + "type": "object", + "description": "The reference object to the schema and type of target service which is described by service specification", + "properties": { + "@type": { + "type": "string", + "description": "Class type of the target service" + }, + "@schemaLocation": { + "type": "string", + "description": "This field provides a link to the schema describing the target service" + } + }, + "required": [ + "@type", + "@schemaLocation" + ] } - }, - "required": [ - "@type", - "@schemaLocation" - ] } - } } \ No newline at end of file diff --git a/Service/TerminationError.schema.json b/Service/TerminationError.schema.json index 3badf03b..238d7278 100644 --- a/Service/TerminationError.schema.json +++ b/Service/TerminationError.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TerminationError.schema.json", - "title": "TerminationError", - "definitions": { - "TerminationError": { - "$id": "#TerminationError", - "description": "This indicates an error that caused a qualificationItem to be terminated.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the termination error" - }, - "value": { - "type": "string", - "description": "Text to describe the termination error - for example: Unable to proceed to qualification because incomplete information provided" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TerminationError.schema.json", + "title": "TerminationError", + "definitions": { + "TerminationError": { + "$id": "#TerminationError", + "description": "This indicates an error that caused a qualificationItem to be terminated.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the termination error" + }, + "value": { + "type": "string", + "description": "Text to describe the termination error - for example: Unable to proceed to qualification because incomplete information provided" + } + } } - } } - } } \ No newline at end of file diff --git a/Service/TestMeasure.schema.json b/Service/TestMeasure.schema.json index 2fa3f4b4..860a643a 100644 --- a/Service/TestMeasure.schema.json +++ b/Service/TestMeasure.schema.json @@ -1,60 +1,60 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TestMeasure.schema.json", - "title": "TestMeasure", - "definitions": { - "TestMeasure": { - "$id": "#TestMeasure", - "description": "A TestMeasure specifies a measure of a specific aspect of a product, service, or resource test, such as lost packets or connectivity status", - "type": "object", - "properties": { - "accuracy": { - "type": "number", - "format": "float", - "description": "The number of digits of accuracy captured for associated Metrics" - }, - "captureDateTime": { - "type": "string", - "format": "date-time", - "description": "The date and time that the metric was captured" - }, - "captureMethod": { - "type": "string", - "description": "The method used to capture the Metrics (This may be replaced by a set of entities similar to the Performance Monitoring Ref)" - }, - "metricDescription": { - "type": "string", - "description": "Brief description of the metric" - }, - "metricHref": { - "type": "string", - "description": "Hyperlink to access a metric for detail information" - }, - "metricName": { - "type": "string", - "description": "The name of the metric" - }, - "ruleViolation": { - "type": "array", - "description": "A list of rules that were violated in this test measure", - "items": { - "$ref": "MeasureThresholdRuleViolation.schema.json#MeasureThresholdRuleViolation" - } - }, - "unitOfMeasure": { - "type": "string", - "description": "The unit of measure for the metric values, such as meters, cubic yards, kilograms [ISO 1000]." - }, - "value": { - "description": "The value of Metric in the test. This also could be a document to record all values captured during the service test", - "$ref": "../Common/Characteristic.schema.json#Characteristic" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TestMeasure.schema.json", + "title": "TestMeasure", + "definitions": { + "TestMeasure": { + "$id": "#TestMeasure", + "description": "A TestMeasure specifies a measure of a specific aspect of a product, service, or resource test, such as lost packets or connectivity status", + "type": "object", + "properties": { + "accuracy": { + "type": "number", + "format": "float", + "description": "The number of digits of accuracy captured for associated Metrics" + }, + "captureDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time that the metric was captured" + }, + "captureMethod": { + "type": "string", + "description": "The method used to capture the Metrics (This may be replaced by a set of entities similar to the Performance Monitoring Ref)" + }, + "metricDescription": { + "type": "string", + "description": "Brief description of the metric" + }, + "metricHref": { + "type": "string", + "description": "Hyperlink to access a metric for detail information" + }, + "metricName": { + "type": "string", + "description": "The name of the metric" + }, + "ruleViolation": { + "type": "array", + "description": "A list of rules that were violated in this test measure", + "items": { + "$ref": "MeasureThresholdRuleViolation.schema.json#MeasureThresholdRuleViolation" + } + }, + "unitOfMeasure": { + "type": "string", + "description": "The unit of measure for the metric values, such as meters, cubic yards, kilograms [ISO 1000]." + }, + "value": { + "description": "The value of Metric in the test. This also could be a document to record all values captured during the service test", + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/TestMeasureDefinition.schema.json b/Service/TestMeasureDefinition.schema.json index 9efa7396..76777c34 100644 --- a/Service/TestMeasureDefinition.schema.json +++ b/Service/TestMeasureDefinition.schema.json @@ -1,66 +1,66 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TestMeasureDefinition.schema.json", - "title": "TestMeasureDefinition", - "definitions": { - "TestMeasureDefinition": { - "$id": "#TestMeasureDefinition", - "description": "A TestMeasureDefinition specifies a measure of a specific aspect of a product, service, or resource test, such as lost packets or connectivity status", - "type": "object", - "properties": { - "captureFrequency": { - "type": "string", - "description": "The frequency of capture for the metric. Note: This may be replaced by a set of entities similar to the Performance Monitoring" - }, - "captureMethod": { - "type": "string", - "description": "The method used to capture the Metric. Note: This may be replaced by a set of entities similar to the Performance Monitoring" - }, - "capturePeriod": { - "$ref": "../Common/Duration.schema.json#Duration", - "description": "A period of the capture" - }, - "metricDescription": { - "type": "string", - "description": "Brief description of the metric" - }, - "metricHref": { - "type": "string", - "description": "Hyperlink to access a metric for detail information" - }, - "metricName": { - "type": "string", - "description": "The name of a metric that in the test measure" - }, - "name": { - "type": "string", - "description": "The name of the TestMeasureDefinition" - }, - "unitOfMeasure": { - "type": "string", - "description": "Name of a service test specification" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The time period for which this definition is valid" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the Metric value can take on, such as numeric, text, and so forth" - }, - "thresholdRule": { - "type": "array", - "description": "The rule(s) associated with the measure threshold", - "items": { - "$ref": "MetricDefMeasureThresholdRule.schema.json#MetricDefMeasureThresholdRule" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TestMeasureDefinition.schema.json", + "title": "TestMeasureDefinition", + "definitions": { + "TestMeasureDefinition": { + "$id": "#TestMeasureDefinition", + "description": "A TestMeasureDefinition specifies a measure of a specific aspect of a product, service, or resource test, such as lost packets or connectivity status", + "type": "object", + "properties": { + "captureFrequency": { + "type": "string", + "description": "The frequency of capture for the metric. Note: This may be replaced by a set of entities similar to the Performance Monitoring" + }, + "captureMethod": { + "type": "string", + "description": "The method used to capture the Metric. Note: This may be replaced by a set of entities similar to the Performance Monitoring" + }, + "capturePeriod": { + "$ref": "../Common/Duration.schema.json#Duration", + "description": "A period of the capture" + }, + "metricDescription": { + "type": "string", + "description": "Brief description of the metric" + }, + "metricHref": { + "type": "string", + "description": "Hyperlink to access a metric for detail information" + }, + "metricName": { + "type": "string", + "description": "The name of a metric that in the test measure" + }, + "name": { + "type": "string", + "description": "The name of the TestMeasureDefinition" + }, + "unitOfMeasure": { + "type": "string", + "description": "Name of a service test specification" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The time period for which this definition is valid" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the Metric value can take on, such as numeric, text, and so forth" + }, + "thresholdRule": { + "type": "array", + "description": "The rule(s) associated with the measure threshold", + "items": { + "$ref": "MetricDefMeasureThresholdRule.schema.json#MetricDefMeasureThresholdRule" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file diff --git a/Service/TrackingRecord.schema.json b/Service/TrackingRecord.schema.json index d791636c..535bed61 100644 --- a/Service/TrackingRecord.schema.json +++ b/Service/TrackingRecord.schema.json @@ -1,47 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TrackingRecord.schema.json", - "title": "TrackingRecord", - "definitions": { - "TrackingRecord": { - "$id": "#TrackingRecord", - "type": "object", - "description": "Tracking records allow the tracking of modifications on the problem. The tracking records should not be embedded in the problem to allow retrieving the problem without the tracking records", - "properties": { - "description": { - "type": "string", - "description": "Describes the action being done, such as: ack, clear" - }, - "extensionInfo": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - }, - "description": "A generic list of any type of elements. Used for vendor Extensions or loose element encapsulation from other namespaces" - }, - "id": { - "type": "string", - "description": "Identifier of the TrackingRecord" - }, - "systemId": { - "type": "string", - "description": "Describes the system Id from which the action was done" - }, - "time": { - "type": "string", - "format": "date-time", - "description": "Describes the time at which the action was done" - }, - "user": { - "type": "string", - "description": "Describes the user doing the action" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TrackingRecord.schema.json", + "title": "TrackingRecord", + "definitions": { + "TrackingRecord": { + "$id": "#TrackingRecord", + "type": "object", + "description": "Tracking records allow the tracking of modifications on the problem. The tracking records should not be embedded in the problem to allow retrieving the problem without the tracking records", + "properties": { + "description": { + "type": "string", + "description": "Describes the action being done, such as: ack, clear" + }, + "extensionInfo": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + }, + "description": "A generic list of any type of elements. Used for vendor Extensions or loose element encapsulation from other namespaces" + }, + "id": { + "type": "string", + "description": "Identifier of the TrackingRecord" + }, + "systemId": { + "type": "string", + "description": "Describes the system Id from which the action was done" + }, + "time": { + "type": "string", + "format": "date-time", + "description": "Describes the time at which the action was done" + }, + "user": { + "type": "string", + "description": "Describes the user doing the action" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] } - } } \ No newline at end of file From c0fc89778d1d80d41fb3bc2a9cfad798a20b45e3 Mon Sep 17 00:00:00 2001 From: Schema validation Bot Date: Mon, 15 Jul 2019 13:42:36 +0000 Subject: [PATCH 07/11] Validation result with ERRORS [skip ci] --- .../validation-20190715T134236Z.txt | 1065 +++++++++++++++++ 1 file changed, 1065 insertions(+) create mode 100644 .circleci/validation_results/validation-20190715T134236Z.txt diff --git a/.circleci/validation_results/validation-20190715T134236Z.txt b/.circleci/validation_results/validation-20190715T134236Z.txt new file mode 100644 index 00000000..f018e560 --- /dev/null +++ b/.circleci/validation_results/validation-20190715T134236Z.txt @@ -0,0 +1,1065 @@ +SCHEMA VALIDATION +================= +# schemas : 489 files processed +# errors : 15 +# validate ok : 474 +# issues : 213 files / 574 issues + +total time: 5.97 seconds + + +ERROR - schemas with error(s): +... Common/Entity.schema.json +... ... discriminator (@type) defined but not included in 'required' property + +... Common/RelatedGeographicAddressRefOrValue.schema.json +... ... discriminator (isRef) defined but not included in 'required' property + +... Common/RelatedGeographicLocationRefOrValue.schema.json +... ... discriminator (isRef) defined but not included in 'required' property + +... Common/RelatedPlaceRefOrValue.schema.json +... ... discriminator (isRef) defined but no isRef property defined +... ... discriminator (isRef) defined but not included in 'required' property + +... Customer/BalanceTopupStatus.schema.json +... ... BalanceTopupStatus requires property "type" +... ... BalanceTopupStatus requires property "$id" + +... Customer/ProductOfferingQualificationItemRef.schema.json +... ... ProductOfferingQualificationItemRef requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/EntityRef.schema.json' + +... EngagedParty/PartyRole.schema.json +... ... required additionalProperty "0" exists in instance when not allowed +... ... required additionalProperty "1" exists in instance when not allowed + +... EngagedParty/RelatedPartyRefOrValue.schema.json +... ... isRef property defined, but not included in required +... ... discriminator (isRef) defined but not included in 'required' property + +... MarketingSales/SalesLead.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'MarketingSales/SalesLeadStateType.schema.json' + +... Product/BaseProductRefOrValue.schema.json +... ... isRef property defined, but not included in required + +... Product/CancelProductOrder.schema.json +... ... de-reference check: Token "#CancelOrderRef" does not exist. + +... Product/LoyaltyExecutionPoint.schema.json +... ... LoyaltyAccount additionalProperty "title" exists in instance when not allowed +... ... schema mismatch with title (LoyaltyExecutionPoint) and definitions (LoyaltyAccount) + +... Service/AlternateServiceProposal.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/ServiceRestriction.schema.json' + +... Service/ServiceQualification.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/ServiceRestriction.schema.json' + +... Service/ServiceQualificationItem.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/ServiceRestriction.schema.json' + + +ISSUES - schemas with issue(s): +... Common/AlternateGeographicAddress.schema.json +... ... geographicLocation :: no description value +... ... geographicSubAddress :: no description value + +... Common/AssociationRoleSpec.schema.json +... ... aggregation :: no description value +... ... defaultQuantity :: no description value +... ... entityType :: no description value +... ... isNavigable :: no description value +... ... isSource :: no description value +... ... maxQuantity :: no description value +... ... minQuantity :: no description value +... ... role :: no description value + +... Common/AssociationSpecification.schema.json +... ... constraint :: no description value +... ... associationRoleSpec :: no description value + +... Common/BusinessInteraction.schema.json +... ... interactionData :: no description value +... ... interactionDataComplete :: no description value +... ... interactionDataStatus :: no description value + +... Common/CalendarEventRef.schema.json +... ... CalendarEventRef :: no properties defined + +... Common/CalendarPeriod.schema.json +... ... timeZone :: recommend to add format +... ... hourPeriod :: no description value + +... Common/ChangeRequest.schema.json +... ... workLog :: no description value +... ... incident :: no description value +... ... changeRequestSpecification :: no description value +... ... impactEntity :: no description value +... ... changeRequestCharacteristic :: no description value +... ... targetEntity :: no description value +... ... resolution :: no description value +... ... sla :: no description value +... ... relateChangeRequest :: no description value +... ... category :: no description value +... ... note :: no description value + +... Common/ChangeRequestSpecification.schema.json +... ... validFor :: no description value + +... Common/Channel.schema.json +... ... Channel :: should be renamed as ChannelRef if this is a reference entity + +... Common/CommonComponents.schema.json +... ... Failing to check for issues: TypeError: Cannot read property 'properties' of undefined + +... Common/CommunicationMessage.schema.json +... ... logFlag :: no description value +... ... tryTimes :: recommend to add format + +... Common/Document.schema.json +... ... binaryAttachment :: no description value +... ... category :: no description value +... ... documentRelationship :: no description value +... ... relatedObject :: no description value + +... Common/DocumentCharacteristic.schema.json +... ... value :: no description value + +... Common/DocumentRelationship.schema.json +... ... documentRef :: no description value + +... Common/EntitySpecRelationship.schema.json +... ... associationSpec :: no description value + +... Common/EntitySpecification.schema.json +... ... attachment :: no description value +... ... entitySchema :: no description value +... ... specCharacteristic :: no description value +... ... relatedParty :: no description value + +... Common/ExternalReference.schema.json +... ... ExternalReference :: should be renamed as ExternalReferenceRef if this is a reference entity + +... Common/GeographicAddress.schema.json +... ... geographicLocation :: no description value +... ... geographicSubAddress :: no description value + +... Common/GeographicAddressValidation.schema.json +... ... validAddress :: no description value +... ... alternateGeographicAddress :: no description value + +... Common/GeographicLocation.schema.json +... ... accuracy :: no description value +... ... spatialRef :: no description value +... ... geometry :: no description value + +... Common/GeographicLocationRef.schema.json +... ... GeographicLocationRef :: no properties defined + +... Common/GeographicSite.schema.json +... ... relatedParty :: no description value +... ... calendar :: no description value +... ... geographicLocation :: no description value +... ... address :: no description value +... ... siteRelationship :: no description value + +... Common/Incident.schema.json +... ... Incident :: should be renamed as IncidentRef if this is a reference entity + +... Common/LocationCharacteristic.schema.json +... ... value :: no description value + +... Common/NetworkFunction.schema.json +... ... NetworkFunction :: should be renamed as NetworkFunctionRef if this is a reference entity + +... Common/Object.schema.json +... ... uri :: no description value + +... Common/Place.schema.json +... ... Place :: should be renamed as PlaceRef if this is a reference entity + +... Common/PlaceRef.schema.json +... ... PlaceRef :: no properties defined + +... Common/Receiver.schema.json +... ... party :: no description value + +... Common/Resolution.schema.json +... ... task :: no description value + +... Common/RetrieveGeographicLocation.schema.json +... ... requestedAccuracy :: no description value +... ... status :: no description value +... ... time :: no description value +... ... geographicLocation :: no description value +... ... thing :: no description value + +... Common/RetrieveLocationRelation.schema.json +... ... distance :: no description value +... ... status :: no description value +... ... time :: no description value +... ... intersection :: no description value +... ... location :: no description value + +... Common/Sender.schema.json +... ... party :: no description value + +... Common/SpecCharacteristic.schema.json +... ... specCharacteristicValue :: no description value +... ... specCharRelationship :: no description value + +... Common/Street.schema.json +... ... characteristic :: no description value +... ... address :: no description value + +... Common/StreetSegment.schema.json +... ... address :: no description value + +... Common/TicketRelationship.schema.json +... ... product :: no description value + +... Common/TroubleTicketRef.schema.json +... ... TroubleTicketRef :: no properties defined + +... Common/TroubleTicketRelationship.schema.json +... ... troubleTicket :: no description value + +... Common/Value.schema.json +... ... Value :: no properties defined + +... Common/WorkLog.schema.json +... ... lastUpdateDateTime :: recommend to add format +... ... lastUpdateDateTime :: recommend to add format +... ... record :: no description value + +... Customer/AppliedBillingRate.schema.json +... ... appliedTax :: no description value +... ... bill :: no description value +... ... characteristic :: no description value + +... Customer/AppliedCustomerBillingRate.schema.json +... ... appliedTax :: no description value +... ... bill :: no description value +... ... characteristic :: no description value + +... Customer/AppliedPartyBillingRate.schema.json +... ... appliedTax :: no description value +... ... bill :: no description value +... ... characteristic :: no description value + +... Customer/Appointment.schema.json +... ... attachment :: no description value +... ... contactMedium :: no description value +... ... note :: no description value +... ... relatedEntity :: no description value +... ... relatedParty :: no description value +... ... status :: no description value +... ... validFor :: no description value + +... Customer/Authorization.schema.json +... ... approver :: no description value + +... Customer/BalanceActivity.schema.json +... ... date :: recommend to add format +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceAdjustmentBody.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceAdjustmentRequest.schema.json +... ... requestedDate :: recommend to add format + +... Customer/BalanceDeduct.schema.json +... ... relatedParty :: no description value +... ... product :: no description value +... ... balanceReserve :: no description value +... ... requestor :: no description value +... ... partyAccount :: no description value + +... Customer/BalanceDeductRollback.schema.json +... ... relatedParty :: no description value +... ... product :: no description value +... ... partyAccount :: no description value +... ... balanceDeduct :: no description value +... ... requestor :: no description value + +... Customer/BalanceReserve.schema.json +... ... requestor :: no description value +... ... product :: no description value +... ... relatedParty :: no description value +... ... partyAccount :: no description value + +... Customer/BalanceTopupBody.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceTopupRequest.schema.json +... ... confirmationDate :: recommend to add format +... ... requestedDate :: recommend to add format + +... Customer/BalanceTopupStatusTypeModify.schema.json +... ... BalanceTopupStatusTypeModify :: should be renamed as BalanceTopupStatusTypeModifyRef if this is a reference entity + +... Customer/BalanceTransferBody.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceTransferRequest.schema.json +... ... confirmationDate :: recommend to add format +... ... requestedDate :: recommend to add format + +... Customer/BalanceTransferStatusTypeModify.schema.json +... ... BalanceTransferStatusTypeModify :: should be renamed as BalanceTransferStatusTypeModifyRef if this is a reference entity +... ... status :: no description value + +... Customer/BalanceUnreserve.schema.json +... ... balanceReserve :: no description value +... ... relatedParty :: no description value +... ... requestor :: no description value +... ... product :: no description value + +... Customer/BankCardMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/Bill.schema.json +... ... billingAccount :: no description value +... ... taxItem :: no description value +... ... paymentMethod :: no description value +... ... relatedParty :: no description value +... ... financialAccount :: no description value + +... Customer/BillFormat.schema.json +... ... BillFormat :: should be renamed as BillFormatRef if this is a reference entity + +... Customer/BillFormatRefOrValue.schema.json +... ... isRef :: no description value + +... Customer/BillPresentationMedia.schema.json +... ... BillPresentationMedia :: should be renamed as BillPresentationMediaRef if this is a reference entity + +... Customer/BillPresentationMediaRefOrValue.schema.json +... ... isRef :: no description value + +... Customer/BillStructure.schema.json +... ... presentationMedia :: no description value +... ... format :: no description value +... ... cycleSpecification :: no description value + +... Customer/BillingAccount.schema.json +... ... BillingAccount :: no properties defined + +... Customer/BillingCycleSpecification.schema.json +... ... billingDateShift :: recommend to add format +... ... chargeDateOffset :: recommend to add format +... ... creditDateOffset :: recommend to add format +... ... mailingDateOffset :: recommend to add format +... ... paymentDueDateOffset :: recommend to add format + +... Customer/BillingCycleSpecificationRef.schema.json +... ... dateShift :: recommend to add format + +... Customer/BillingCycleSpecificationRefOrValue.schema.json +... ... isRef :: no description value + +... Customer/CartItem.schema.json +... ... itemTerm :: no description value +... ... cartItem :: no description value +... ... note :: no description value +... ... ItemTotalPrice :: no description value +... ... product :: no description value +... ... itemPrice :: no description value +... ... productOffering :: no description value +... ... cartItemRelationship :: no description value + +... Customer/CartItemRelationship.schema.json +... ... cartItem :: no description value + +... Customer/CartPrice.schema.json +... ... price :: no description value +... ... priceAlteration :: no description value + +... Customer/CartTerm.schema.json +... ... description :: no description value +... ... duration :: no description value + +... Customer/CashDetails.schema.json +... ... CashDetails :: no properties defined + +... Customer/CashMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/CheckMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/Customer.schema.json +... ... engagedParty :: no description value +... ... roleType :: no description value +... ... account :: no description value +... ... paymentMethod :: no description value +... ... contactMedium :: no description value +... ... creditProfile :: no description value +... ... agreement :: no description value +... ... relatedParty :: no description value + +... Customer/CustomerBill.schema.json +... ... billingAccount :: no description value +... ... taxItem :: no description value +... ... paymentMethod :: no description value +... ... relatedParty :: no description value +... ... financialAccount :: no description value + +... Customer/DigitalWalletMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/Disability.schema.json +... ... validFor :: no description value + +... Customer/OrderItem.schema.json +... ... appointment :: no description value +... ... billingAccount :: no description value +... ... itemPrice :: no description value +... ... orderItem :: no description value +... ... orderItemRelationship :: no description value +... ... itemTotalPrice :: no description value +... ... payment :: no description value +... ... productOffering :: no description value +... ... product :: no description value +... ... qualification :: no description value +... ... itemTerm :: no description value + +... Customer/OrderItemPrice.schema.json +... ... productOfferingPrice :: no description value +... ... billingAccount :: no description value +... ... price :: no description value +... ... priceAlteration :: no description value + +... Customer/OrderItemRelationship.schema.json +... ... OrderItemRelationship :: should be renamed as OrderItemRelationshipRef if this is a reference entity + +... Customer/OrderRelationship.schema.json +... ... OrderRelationship :: should be renamed as OrderRelationshipRef if this is a reference entity + +... Customer/PaymentItem.schema.json +... ... payment :: no description value + +... Customer/PaymentMethod.schema.json +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/PaymentMethodRefOrValue.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/PaymentPlan.schema.json +... ... paymentMethod :: no description value + +... Customer/ProductOrder.schema.json +... ... billingAccount :: no description value +... ... channel :: no description value +... ... note :: no description value +... ... orderTotalPrice :: no description value +... ... payment :: no description value +... ... productOfferingQualification :: no description value +... ... quote :: no description value +... ... productOrderItem :: no description value +... ... relatedParty :: no description value + +... Customer/ProductOrderItem.schema.json +... ... appointment :: no description value +... ... billingAccount :: no description value +... ... itemPrice :: no description value +... ... itemTerm :: no description value +... ... itemTotalPrice :: no description value +... ... payment :: no description value +... ... product :: no description value +... ... productOffering :: no description value +... ... productOfferingQualificationItem :: no description value +... ... quoteItem :: no description value +... ... productOrderItem :: no description value +... ... productOrderItemRelationship :: no description value +... ... qualification :: no description value + +... Customer/ProductOrderRef.schema.json +... ... ProductOrderRef :: no properties defined + +... Customer/QuoteItem.schema.json +... ... product :: no description value +... ... productOffering :: no description value + +... Customer/QuoteItemRelationship.schema.json +... ... QuoteItemRelationship :: should be renamed as QuoteItemRelationshipRef if this is a reference entity + +... Customer/QuotePrice.schema.json +... ... priceAlteration :: no description value +... ... price :: no description value + +... Customer/QuoteRef.schema.json +... ... QuoteRef :: no properties defined + +... Customer/SearchTimeSlot.schema.json +... ... requestedTimeSlot :: no description value +... ... requestedTimeSlot :: recommend to add format +... ... availableTimeSlot :: no description value +... ... availableTimeSlot :: recommend to add format +... ... relatedEntity :: no description value + +... Customer/SettlementNoteAdvice.schema.json +... ... settlementMethod :: no description value +... ... settlementNoteImage :: no description value +... ... receiver :: no description value +... ... taxItem :: no description value +... ... issuer :: no description value +... ... settlementNoteItem :: no description value + +... Customer/SettlementNoteImage.schema.json +... ... imageFileURL :: recommend to add format + +... Customer/SettlementNoteItem.schema.json +... ... period :: no description value +... ... taxItem :: no description value + +... Customer/ShoppingCart.schema.json +... ... contactMedium :: no description value +... ... cartItem :: no description value +... ... relatedParty :: no description value + +... Customer/TokenizedCardMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/VoucherMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/Account.schema.json +... ... relatedParty :: no description value +... ... taxExemption :: no description value +... ... contact :: no description value +... ... accountBalance :: no description value +... ... accountRelationship :: no description value + +... EngagedParty/AccountDirectDetails.schema.json +... ... AccountDirectDetails :: should be renamed as AccountDirectDetailsRef if this is a reference entity +... ... account :: no description value + +... EngagedParty/AccountDirectMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/AccountRelationship.schema.json +... ... account :: no description value + +... EngagedParty/AccountTaxExemption.schema.json +... ... issuingJurisdiction :: recommend to add format + +... EngagedParty/Agreement.schema.json +... ... completionDate :: recommend to add format +... ... agreementSpecification :: no description value +... ... agreementItem :: no description value +... ... engagedPartyRole :: no description value +... ... agreementAuthorization :: no description value +... ... characteristic :: no description value +... ... associatedAgreement :: no description value + +... EngagedParty/AgreementItem.schema.json +... ... productOffering :: no description value +... ... termOrCondition :: no description value + +... EngagedParty/AgreementSpecCharacteristic.schema.json +... ... specCharacteristicValue :: no description value + +... EngagedParty/AgreementSpecification.schema.json +... ... serviceCategory :: no description value +... ... specificationCharacteristic :: no description value +... ... relatedParty :: no description value +... ... attachment :: no description value +... ... specificationRelationship :: no description value + +... EngagedParty/BankAccountDebitMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/BankAccountTransferMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/Contact.schema.json +... ... contactMedium :: no description value +... ... relatedParty :: no description value + +... EngagedParty/FinancialAccount.schema.json +... ... FinancialAccount :: no properties defined + +... EngagedParty/FinancialAccountRef.schema.json +... ... accountBalance :: no description value + +... EngagedParty/Individual.schema.json +... ... otherName :: no description value +... ... individualIdentification :: no description value +... ... disability :: no description value +... ... languageAbility :: no description value +... ... skill :: no description value + +... EngagedParty/IndividualIdentification.schema.json +... ... attachment :: no description value + +... EngagedParty/LanguageAbility.schema.json +... ... isFavouriteLanguage :: recommend to add format +... ... validFor :: no description value + +... EngagedParty/Organization.schema.json +... ... existsDuring :: no description value +... ... existsDuring :: recommend to add format +... ... otherName :: no description value +... ... organizationIdentification :: no description value +... ... organizationChildRelationship :: no description value +... ... organizationParentRelationship :: no description value + +... EngagedParty/OrganizationChildRelationship.schema.json +... ... organization :: no description value + +... EngagedParty/OrganizationIdentification.schema.json +... ... attachment :: no description value + +... EngagedParty/OrganizationParentRelationship.schema.json +... ... organization :: no description value + +... EngagedParty/OrganizationRef.schema.json +... ... OrganizationRef :: no properties defined + +... EngagedParty/OtherNameIndividual.schema.json +... ... validFor :: no description value + +... EngagedParty/OtherNameOrganization.schema.json +... ... validFor :: no description value + +... EngagedParty/PartnershipType.schema.json +... ... roleType :: no description value + +... EngagedParty/Party.schema.json +... ... externalReference :: no description value +... ... partyCharacteristic :: no description value +... ... taxExemptionCertificate :: no description value +... ... creditRating :: no description value +... ... relatedParty :: no description value +... ... contactMedium :: no description value + +... EngagedParty/PartyAccount.schema.json +... ... billStructure :: no description value +... ... paymentPlan :: no description value +... ... financialAccount :: no description value +... ... defaultPaymentMethod :: no description value + +... EngagedParty/PartyBill.schema.json +... ... billingAccount :: no description value +... ... taxItem :: no description value +... ... paymentMethod :: no description value +... ... relatedParty :: no description value +... ... financialAccount :: no description value + +... EngagedParty/PartyCreditProfile.schema.json +... ... validFor :: no description value + +... EngagedParty/PartyRef.schema.json +... ... PartyRef :: no properties defined + +... EngagedParty/RoleType.schema.json +... ... agreementSpecification :: no description value + +... EngagedParty/Rule.schema.json +... ... consequence :: no description value +... ... metric :: no description value +... ... operator :: no description value +... ... referenceValue :: no description value +... ... tolerance :: no description value +... ... unit :: no description value + +... EngagedParty/RuleRef.schema.json +... ... description :: no description value + +... EngagedParty/SLA.schema.json +... ... approvalDate :: no description value +... ... approved :: no description value +... ... rule :: no description value +... ... relatedParty :: no description value +... ... template :: no description value + +... EngagedParty/SLAViolation.schema.json +... ... date :: no description value +... ... relatedParty :: no description value +... ... violation :: no description value +... ... sla :: no description value + +... EngagedParty/SettlementAccount.schema.json +... ... SettlementAccount :: no properties defined + +... EngagedParty/Skill.schema.json +... ... validFor :: no description value + +... EngagedParty/TaxExemptionCertificate.schema.json +... ... taxDefinition :: no description value +... ... validFor :: no description value +... ... attachment :: no description value + +... EngagedParty/TemplateRef.schema.json +... ... description :: no description value + +... EngagedParty/Violation.schema.json +... ... actualValue :: no description value +... ... comment :: no description value +... ... consequence :: no description value +... ... operator :: no description value +... ... referenceValue :: no description value +... ... tolerance :: no description value +... ... unit :: no description value +... ... violationAverage :: no description value +... ... attachment :: no description value +... ... rule :: no description value + +... MarketingSales/MarketingCampaignRef.schema.json +... ... MarketingCampaignRef :: no properties defined + +... MarketingSales/SalesOpportunityRef.schema.json +... ... SalesOpportunityRef :: no properties defined + +... Product/BundledProductOfferingPriceRelationship.schema.json +... ... BundledProductOfferingPriceRelationship :: should be renamed as BundledProductOfferingPriceRelationshipRef if this is a reference entity + +... Product/BundledProductSpecification.schema.json +... ... BundledProductSpecification :: should be renamed as BundledProductSpecificationRef if this is a reference entity + +... Product/LoyaltyAccount.schema.json +... ... LoyaltyAccount :: should be renamed as LoyaltyAccountRef if this is a reference entity +... ... loyaltyProgramProduct :: no description value + +... Product/LoyaltyAction.schema.json +... ... type :: rename to avoid conflict with @type + +... Product/LoyaltyEvent.schema.json +... ... eventId :: no description value +... ... eventTime :: recommend to add format + +... Product/LoyaltyEventType.schema.json +... ... LoyaltyEventType :: should be renamed as LoyaltyEventTypeRef if this is a reference entity + +... Product/LoyaltyProgramProduct.schema.json +... ... loyaltyProgramProductSpec :: no description value +... ... loyaltyAccount :: no description value +... ... validFor :: no description value + +... Product/LoyaltyProgramProductSpec.schema.json +... ... productNumber :: no description value +... ... ValidFor :: no description value + +... Product/LoyaltyRuleAction.schema.json +... ... LoyaltyRuleAction :: should be renamed as LoyaltyRuleActionRef if this is a reference entity + +... Product/LoyaltyRuleCondition.schema.json +... ... LoyaltyRuleCondition :: should be renamed as LoyaltyRuleConditionRef if this is a reference entity + +... Product/LoyaltyRuleEventType.schema.json +... ... LoyaltyRuleEventType :: should be renamed as LoyaltyRuleEventTypeRef if this is a reference entity + +... Product/PriceAlteration.schema.json +... ... productOfferingPrice :: no description value +... ... price :: no description value + +... Product/Product.schema.json +... ... agreement :: no description value +... ... billingAccount :: no description value +... ... productCharacteristic :: no description value +... ... productOffering :: no description value +... ... productOrderItem :: no description value +... ... product :: no description value +... ... productPrice :: no description value +... ... productRelationship :: no description value +... ... productSpecification :: no description value +... ... productTerm :: no description value +... ... realizingResource :: no description value +... ... realizingService :: no description value +... ... relatedParty :: no description value +... ... place :: no description value + +... Product/ProductInventoryRelationship.schema.json +... ... product :: no description value + +... Product/ProductOffering.schema.json +... ... serviceCandidate :: recommend to add format +... ... resourceCandidate :: recommend to add format + +... Product/ProductOfferingPriceRef.schema.json +... ... ProductOfferingPriceRef :: no properties defined + +... Product/ProductOfferingPriceRelationship.schema.json +... ... ProductOfferingPriceRelationship :: should be renamed as ProductOfferingPriceRelationshipRef if this is a reference entity + +... Product/ProductOfferingQualificationItem.schema.json +... ... eligibilityUnavailabilityReason :: no description value +... ... category :: no description value +... ... qualificationItemRelationship :: no description value +... ... note :: no description value +... ... product :: no description value +... ... terminationError :: no description value +... ... productOffering :: no description value +... ... alternateProductOfferingProposal :: no description value + +... Product/ProductOfferingQualificationRef.schema.json +... ... ProductOfferingQualificationRef :: no properties defined + +... Product/ProductOfferingRef.schema.json +... ... ProductOfferingRef :: no properties defined + +... Product/ProductPrice.schema.json +... ... productOfferingPrice :: no description value +... ... billingAccount :: no description value +... ... productPriceAlteration :: no description value +... ... price :: no description value + +... Product/ProductRef.schema.json +... ... ProductRef :: no properties defined + +... Product/ProductRefOrValue.schema.json +... ... ProductRefOrValue :: no properties defined + +... Product/ProductRelationship.schema.json +... ... product :: no description value + +... Product/ProductRequest.schema.json +... ... referredProduct :: no description value +... ... realizingService :: no description value +... ... billingAccount :: no description value +... ... productOffering :: no description value +... ... agreement :: no description value +... ... characteristic :: no description value +... ... productRelationship :: no description value +... ... realizingResource :: no description value +... ... relatedParty :: no description value +... ... productPrice :: no description value +... ... productSpecification :: no description value +... ... place :: no description value + +... Product/ProductRestriction.schema.json +... ... productCharacteristic :: no description value +... ... productRelationship :: no description value +... ... relatedParty :: no description value +... ... productSpecification :: no description value +... ... relatedPlace :: no description value + +... Product/ProductSpecCharacteristic.schema.json +... ... productSpecCharRelationship :: no description value +... ... productSpecCharacteristicValue :: no description value + +... Product/Promotion.schema.json +... ... pattern :: no description value + +... Product/PromotionCriteriaGroup.schema.json +... ... criteria :: no description value + +... Product/PromotionPattern.schema.json +... ... action :: no description value +... ... criteriaGroup :: no description value + +... Product/QualificationItemRelationship.schema.json +... ... QualificationItemRelationship :: should be renamed as QualificationItemRelationshipRef if this is a reference entity + +... Product/Recommendation.schema.json +... ... description :: no description value +... ... order :: no description value +... ... channel :: no description value +... ... party :: no description value +... ... item :: no description value + +... Product/Usage.schema.json +... ... usageSpecification :: no description value +... ... usageCharacteristic :: no description value +... ... relatedParty :: no description value +... ... ratedProductUsage :: no description value + +... Product/UsageConsumptionReport.schema.json +... ... relatedParty :: no description value + +... Product/UsageSpecCharacteristic.schema.json +... ... usageSpecCharacteristicValue :: no description value + +... Product/UsageSpecification.schema.json +... ... usageSpecCharacteristic :: no description value + +... Product/UsageVolumeProduct.schema.json +... ... bucketBalance :: no description value +... ... bucketCounter :: no description value +... ... product :: no description value + +... Resource/LogicalResource.schema.json +... ... resourceRelationship :: no description value +... ... characteristic :: no description value +... ... place :: no description value +... ... partyRole :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/PhysicalResource.schema.json +... ... resourceRelationship :: no description value +... ... characteristic :: no description value +... ... place :: no description value +... ... partyRole :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/RealizingResourceRef.schema.json +... ... RealizingResourceRef :: no properties defined + +... Resource/Resource.schema.json +... ... resourceRelationship :: no description value +... ... characteristic :: no description value +... ... place :: no description value +... ... partyRole :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/ResourceAlarmRef.schema.json +... ... changeRequest :: no description value + +... Resource/ResourceOrder.schema.json +... ... orderRelationship :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/ResourceOrderItem.schema.json +... ... resourceSpecification :: no description value +... ... orderItemRelationship :: no description value + +... Resource/ResourceOrderItemRelationship.schema.json +... ... orderItem :: no description value + +... Resource/ResourceOrderRelationship.schema.json +... ... resourceOrder :: no description value +... ... serviceOrder :: no description value + +... Resource/SupportingResource.schema.json +... ... SupportingResource :: should be renamed as SupportingResourceRef if this is a reference entity + +... Service/FirstAlert.schema.json +... ... FirstAlert :: should be renamed as FirstAlertRef if this is a reference entity + +... Service/Service.schema.json +... ... serviceDate :: recommend to add format + +... Service/ServiceCategory.schema.json +... ... serviceCandidate :: recommend to add format + +... Service/ServiceLevelObjective.schema.json +... ... graceTimes :: recommend to add format + +... Service/ServiceOrder.schema.json +... ... orderDate :: no description value + +... Service/ServiceOrderItemRelationship.schema.json +... ... ServiceOrderItemRelationship :: should be renamed as ServiceOrderItemRelationshipRef if this is a reference entity + +... Service/ServiceQualificationItemRelationship.schema.json +... ... ServiceQualificationItemRelationship :: should be renamed as ServiceQualificationItemRelationshipRef if this is a reference entity + +... Service/ServiceQualificationRelationship.schema.json +... ... ServiceQualificationRelationship :: should be renamed as ServiceQualificationRelationshipRef if this is a reference entity + +... Service/ServiceRef.schema.json +... ... ServiceRef :: no properties defined + +... Service/SupportingService.schema.json +... ... SupportingService :: should be renamed as SupportingServiceRef if this is a reference entity + +... Common/RelatedGeographicAddressRefOrValue.schema.json +... ... isRef :: no description value +... ... role :: no description value + +... Common/RelatedGeographicLocationRefOrValue.schema.json +... ... isRef :: no description value +... ... role :: no description value + +... Common/RelatedPlaceRefOrValue.schema.json +... ... role :: no description value + +... Customer/BalanceTopupStatus.schema.json +... ... BalanceTopupStatus :: should be renamed as BalanceTopupStatusRef if this is a reference entity +... ... statusChangeDate :: recommend to add format + +... EngagedParty/PartyRole.schema.json +... ... engagedParty :: no description value +... ... roleType :: no description value +... ... account :: no description value +... ... paymentMethod :: no description value +... ... contactMedium :: no description value +... ... creditProfile :: no description value +... ... agreement :: no description value +... ... relatedParty :: no description value + +... EngagedParty/RelatedPartyRefOrValue.schema.json +... ... isRef :: no description value +... ... role :: no description value + +... MarketingSales/SalesLead.schema.json +... ... status :: no description value +... ... type :: rename to avoid conflict with @type +... ... priority :: no description value +... ... channel :: no description value +... ... productOffering :: no description value +... ... relatedParty :: no description value +... ... prospectContact :: no description value +... ... productSpecification :: no description value +... ... category :: no description value +... ... salesOpportunity :: no description value +... ... product :: no description value +... ... note :: no description value + +... Product/BaseProductRefOrValue.schema.json +... ... productCharacteristic :: no description value +... ... realizingResource :: no description value +... ... realizingService :: no description value +... ... productRelationship :: no description value +... ... relatedParty :: no description value +... ... productSpecification :: no description value +... ... relatedPlace :: no description value + +... Product/CancelProductOrder.schema.json +... ... CancelProductOrder :: should be renamed as CancelProductOrderRef if this is a reference entity +... ... productOrder :: no description value + +... Product/LoyaltyExecutionPoint.schema.json +... ... Failing to check for issues: TypeError: Cannot read property 'properties' of undefined + +... Service/AlternateServiceProposal.schema.json +... ... alternateService :: no description value + +error: TypeError: fd must be a file descriptor From 12bf574ad7936a4147a4d59e2f261e91edc0be5c Mon Sep 17 00:00:00 2001 From: Test results Date: Mon, 15 Jul 2019 15:49:13 +0200 Subject: [PATCH 08/11] Log file with the automated corrections --- automated-fixes-log.txt | 732 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 732 insertions(+) create mode 100644 automated-fixes-log.txt diff --git a/automated-fixes-log.txt b/automated-fixes-log.txt new file mode 100644 index 00000000..ae279276 --- /dev/null +++ b/automated-fixes-log.txt @@ -0,0 +1,732 @@ +... schema loaded +... #schemas = 489 +... keys polymorphicPattern len=1 +... keys BalanceTopupStatusType len=1 +... keys LoyaltyAccount len=1 +... schemas processed +... fixes +... AddressRef.schema.json +... ... replaced schema $ref=Entity.schema.json#EntityRef with EntityRef.schema.json#EntityRef + +... Any.schema.json +... ... added $id for Any +... ... added missing type (object) for Any + +... Attachment.schema.json +... ... replaced schema $ref=../Common/Quantity.schema.json#Quantity with Quantity.schema.json#Quantity +... ... replaced schema $ref=../Common/TimePeriod.schema.json#TimePeriod with TimePeriod.schema.json#TimePeriod + +... AttachmentRefOrValue.schema.json +... ... added $id for AttachmentRefOrValue + +... CalendarEventRef.schema.json +... ... replaced schema $ref=../Common/EntityRef.schema.json#EntityRef with EntityRef.schema.json#EntityRef + +... Channel.schema.json +... ... replaced schema $ref=../Common/Entity.schema.json#Entity with Entity.schema.json#Entity + +... ChannelRef.schema.json +... ... added $id for ChannelRef + +... Characteristic.schema.json +... ... replaced schema $ref=Any.schema.json#/definitions/Any with Any.schema.json#Any + +... ExportJob.schema.json +... ... replaced schema $ref=JobStateType.schema.json#/definitions/JobStateType with JobStateType.schema.json#JobStateType + +... ExternalReference.schema.json +... ... added $id for ExternalReference + +... ImportJob.schema.json +... ... replaced schema $ref=JobStateType.schema.json#/definitions/JobStateType with JobStateType.schema.json#JobStateType + +... MediumCharacteristic.schema.json +... ... added $id for MediumCharacteristic +... ... replaced schema $ref=Entity.schema.json#/Entity with Entity.schema.json#Entity + +... Monitor.schema.json +... ... replaced schema $ref=Request.schema.json#/definitions/Request with Request.schema.json#Request +... ... replaced schema $ref=Response.schema.json#/definitions/Response with Response.schema.json#Response + +... ProcessFlow.schema.json +... ... added $id for ProcessFlow +... ... replaced schema $ref=ChannelRef.schema.json#/definitions/ChannelRef with ChannelRef.schema.json#ChannelRef +... ... replaced schema $ref=Characteristic.schema.json#/definitions/Characteristic with Characteristic.schema.json#Characteristic +... ... replaced schema $ref=RelatedEntity.schema.json#/definitions/RelatedEntity with RelatedEntity.schema.json#RelatedEntity +... ... replaced schema $ref=RelatedParty.schema.json#/definitions/RelatedParty with ../EngagedParty/RelatedParty.schema.json#RelatedParty +... ... replaced schema $ref=ProcessFlowStateType.schema.json#/definitions/ProcessFlowStateType with ProcessFlowStateType.schema.json#ProcessFlowStateType +... ... replaced schema $ref=TaskFlowRef.schema.json#/definitions/TaskFlowRef with TaskFlowRef.schema.json#TaskFlowRef +... ... replaced schema $ref=Entity.schema.json#/Entity with Entity.schema.json#Entity + +... ProcessFlowRef.schema.json +... ... replaced schema $ref=ProcessFlowStateType.schema.json#/definitions/ProcessFlowStateType with ProcessFlowStateType.schema.json#ProcessFlowStateType +... ... replaced schema $ref=../Common/EntityRef.schema.json#EntityRef with EntityRef.schema.json#EntityRef + +... QualificationRef.schema.json +... ... added $id for QualificationRef +... ... replaced schema $ref=EntityRef.schema.json#/EntityRef with EntityRef.schema.json#EntityRef + +... QuantityType.schema.json +... ... added $id for QuantityType +... ... added missing type (object) for QuantityType + +... RelatedChannel.schema.json +... ... added $id for RelatedChannel +... ... replaced schema $ref=../Common/EntityRef.schema.json#/EntityRef with EntityRef.schema.json#EntityRef + +... Request.schema.json +... ... replaced schema $ref=HeaderItem.schema.json#/definitions/HeaderItem with HeaderItem.schema.json#HeaderItem + +... Response.schema.json +... ... replaced schema $ref=HeaderItem.schema.json#/definitions/HeaderItem with HeaderItem.schema.json#HeaderItem + +... StatusChange.schema.json +... ... added $id for StatusChange +... ... replaced schema $ref=Entity.schema.json#/Entity with Entity.schema.json#Entity + +... TaskFlow.schema.json +... ... added $id for TaskFlow +... ... replaced schema $ref=ChannelRef.schema.json#/definitions/ChannelRef with ChannelRef.schema.json#ChannelRef +... ... replaced schema $ref=Characteristic.schema.json#/definitions/Characteristic with Characteristic.schema.json#Characteristic +... ... replaced schema $ref=RelatedEntity.schema.json#/definitions/RelatedEntity with RelatedEntity.schema.json#RelatedEntity +... ... replaced schema $ref=RelatedParty.schema.json#/definitions/RelatedParty with ../EngagedParty/RelatedParty.schema.json#RelatedParty +... ... replaced schema $ref=TaskFlowStateType.schema.json#/definitions/TaskFlowStateType with TaskFlowStateType.schema.json#TaskFlowStateType +... ... replaced schema $ref=TaskFlowRelationship.schema.json#/definitions/TaskFlowRelationship with TaskFlowRelationship.schema.json#TaskFlowRelationship +... ... replaced schema $ref=Entity.schema.json#/Entity with Entity.schema.json#Entity + +... TaskFlowRef.schema.json +... ... added $id for TaskFlowRef +... ... replaced schema $ref=Entity.schema.json#/Entity with Entity.schema.json#Entity + +... TaxDefinition.schema.json +... ... added $id for TaxDefinition +... ... replaced schema $ref=Entity.schema.json#/Entity with Entity.schema.json#Entity + +... TicketRelationship.schema.json +... ... added $id for TicketRelationship +... ... replaced schema $ref=Entity.schema.json#/Entity with Entity.schema.json#Entity + +... TimePeriodType.schema.json +... ... added $id for TimePeriodType +... ... added missing type (object) for TimePeriodType + +... TroubleTicket.schema.json +... ... added $id for TroubleTicket +... ... replaced schema $ref=AttachmentRefOrValue.schema.json#/definitions/AttachmentRefOrValue with AttachmentRefOrValue.schema.json#AttachmentRefOrValue +... ... replaced schema $ref=ChannelRef.schema.json#/definitions/ChannelRef with ChannelRef.schema.json#ChannelRef +... ... replaced schema $ref=Note.schema.json#/definitions/Note with Note.schema.json#Note +... ... replaced schema $ref=RelatedEntity.schema.json#/definitions/RelatedEntity with RelatedEntity.schema.json#RelatedEntity +... ... replaced schema $ref=RelatedParty.schema.json#/definitions/RelatedParty with ../EngagedParty/RelatedParty.schema.json#RelatedParty +... ... replaced schema $ref=TroubleTicketStatusType.schema.json#/definitions/TroubleTicketStatusType with TroubleTicketStatusType.schema.json#TroubleTicketStatusType +... ... replaced schema $ref=StatusChange.schema.json#/definitions/StatusChange with StatusChange.schema.json#StatusChange +... ... replaced schema $ref=TroubleTicketRelationship.schema.json#/definitions/TroubleTicketRelationship with TroubleTicketRelationship.schema.json#TroubleTicketRelationship +... ... replaced schema $ref=Entity.schema.json#/Entity with Entity.schema.json#Entity + +... TroubleTicketRef.schema.json +... ... replaced schema $ref=../Common/EntityRef.schema.json#EntityRef with EntityRef.schema.json#EntityRef + +... TroubleTicketRelationship.schema.json +... ... added $id for TroubleTicketRelationship +... ... replaced schema $ref=TroubleTicketRef.schema.json#/definitions/TroubleTicketRef with TroubleTicketRef.schema.json#TroubleTicketRef +... ... replaced schema $ref=Entity.schema.json#/Entity with Entity.schema.json#Entity + +... AccumulatedBalance.schema.json +... ... added $id for AccumulatedBalance +... ... added missing type (object) for AccumulatedBalance +... ... replaced schema $ref=BucketBalanceRef.schema.json#/definitions/BucketBalanceRef with BucketBalanceRef.schema.json#BucketBalanceRef +... ... replaced schema $ref=PartyAccountRef.schema.json#/definitions/PartyAccountRef with ../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef +... ... replaced schema $ref=ProductRef.schema.json#/definitions/ProductRef with ../Product/ProductRef.schema.json#ProductRef +... ... replaced schema $ref=RelatedParty.schema.json#/definitions/RelatedParty with ../EngagedParty/RelatedParty.schema.json#RelatedParty +... ... replaced schema $ref=QuantityType.schema.json#/definitions/QuantityType with ../Common/QuantityType.schema.json#QuantityType + +... Appointment.schema.json +... ... added $id for Appointment +... ... replaced schema $ref=AppointmentStateType.schema.json#/definitions/AppointmentStateType with AppointmentStateType.schema.json#AppointmentStateType + +... AppointmentStateValues.schema.json +... ... added $id for AppointmentStateValues + +... BalanceActionRequestRef.schema.json +... ... added $id for BalanceActionRequestRef +... ... added missing type (object) for BalanceActionRequestRef + +... BalanceActivity.schema.json +... ... added $id for BalanceActivity +... ... added missing type (object) for BalanceActivity +... ... replaced schema $ref=BalanceActionRequestRef.schema.json#/definitions/BalanceActionRequestRef with BalanceActionRequestRef.schema.json#BalanceActionRequestRef +... ... replaced schema $ref=QuantityType.schema.json#/definitions/QuantityType with ../Common/QuantityType.schema.json#QuantityType +... ... replaced schema $ref=QuantityType.schema.json#/definitions/QuantityType with ../Common/QuantityType.schema.json#QuantityType +... ... replaced schema $ref=QuantityType.schema.json#/definitions/QuantityType with ../Common/QuantityType.schema.json#QuantityType +... ... replaced schema $ref=BucketBalanceRef.schema.json#/definitions/BucketBalanceRef with BucketBalanceRef.schema.json#BucketBalanceRef +... ... replaced schema $ref=PartyAccountRef.schema.json#/definitions/PartyAccountRef with ../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef +... ... replaced schema $ref=ProductRef.schema.json#/definitions/ProductRef with ../Product/ProductRef.schema.json#ProductRef +... ... replaced schema $ref=RelatedPartyRef.schema.json#/definitions/RelatedPartyRef with ../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef + +... BalanceAdjustment.schema.json +... ... added $id for BalanceAdjustment +... ... added missing type (object) for BalanceAdjustment + +... BalanceAdjustmentBody.schema.json +... ... added $id for BalanceAdjustmentBody +... ... added missing type (object) for BalanceAdjustmentBody +... ... replaced schema $ref=QuantityType.schema.json#/definitions/QuantityType with ../Common/QuantityType.schema.json#QuantityType +... ... replaced schema $ref=ProductRef.schema.json#/definitions/ProductRef with ../Product/ProductRef.schema.json#ProductRef + +... BalanceAdjustmentRequest.schema.json +... ... added $id for BalanceAdjustmentRequest +... ... added missing type (object) for BalanceAdjustmentRequest +... ... replaced schema $ref=BucketBalanceRef.schema.json#/definitions/BucketBalanceRef with BucketBalanceRef.schema.json#BucketBalanceRef +... ... replaced schema $ref=PartyAccountRef.schema.json#/definitions/PartyAccountRef with ../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef +... ... replaced schema $ref=RelatedPartyRef.schema.json#/definitions/RelatedPartyRef with ../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef +... ... replaced schema $ref=RelatedPartyRef.schema.json#/definitions/RelatedPartyRef with ../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef +... ... replaced schema $ref=TimePeriodType.schema.json#/definitions/TimePeriodType with ../Common/TimePeriodType.schema.json#TimePeriodType +... ... replaced schema $ref=BalanceAdjustmentBody.schema.json#/definitions/BalanceAdjustmentBody with BalanceAdjustmentBody.schema.json#BalanceAdjustmentBody + +... BalanceTopup.schema.json +... ... added $id for BalanceTopup +... ... added missing type (object) for BalanceTopup + +... BalanceTopupBody.schema.json +... ... added $id for BalanceTopupBody +... ... added missing type (object) for BalanceTopupBody +... ... replaced schema $ref=QuantityType.schema.json#/definitions/QuantityType with ../Common/QuantityType.schema.json#QuantityType +... ... replaced schema $ref=ChannelRef.schema.json#/definitions/ChannelRef with ../Common/ChannelRef.schema.json#ChannelRef +... ... replaced schema $ref=ProductRef.schema.json#/definitions/ProductRef with ../Product/ProductRef.schema.json#ProductRef + +... BalanceTopupRequest.schema.json +... ... added $id for BalanceTopupRequest +... ... added missing type (object) for BalanceTopupRequest +... ... replaced schema $ref=BucketBalanceRef.schema.json#/definitions/BucketBalanceRef with BucketBalanceRef.schema.json#BucketBalanceRef +... ... replaced schema $ref=PartyAccountRef.schema.json#/definitions/PartyAccountRef with ../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef +... ... replaced schema $ref=PaymentMethodRefOrValue.schema.json#/definitions/PaymentMethodRefOrValue with PaymentMethodRefOrValue.schema.json#PaymentMethodRefOrValue +... ... replaced schema $ref=RelatedPartyRef.schema.json#/definitions/RelatedPartyRef with ../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef +... ... replaced schema $ref=RelatedPartyRef.schema.json#/definitions/RelatedPartyRef with ../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef +... ... replaced schema $ref=TimePeriodType.schema.json#/definitions/TimePeriodType with ../Common/TimePeriodType.schema.json#TimePeriodType +... ... replaced schema $ref=BalanceTopupBody.schema.json#/definitions/BalanceTopupBody with BalanceTopupBody.schema.json#BalanceTopupBody + +... BalanceTopupStatusTypeModify.schema.json +... ... added $id for BalanceTopupStatusTypeModify +... ... added missing type (object) for BalanceTopupStatusTypeModify + +... BalanceTransfer.schema.json +... ... added $id for BalanceTransfer +... ... added missing type (object) for BalanceTransfer + +... BalanceTransferBody.schema.json +... ... added $id for BalanceTransferBody +... ... added missing type (object) for BalanceTransferBody +... ... replaced schema $ref=QuantityType.schema.json#/definitions/QuantityType with ../Common/QuantityType.schema.json#QuantityType +... ... replaced schema $ref=ChannelRef.schema.json#/definitions/ChannelRef with ../Common/ChannelRef.schema.json#ChannelRef +... ... replaced schema $ref=ProductRef.schema.json#/definitions/ProductRef with ../Product/ProductRef.schema.json#ProductRef + +... BalanceTransferRequest.schema.json +... ... added $id for BalanceTransferRequest +... ... added missing type (object) for BalanceTransferRequest +... ... replaced schema $ref=BucketBalanceRef.schema.json#/definitions/BucketBalanceRef with BucketBalanceRef.schema.json#BucketBalanceRef +... ... replaced schema $ref=PartyAccountRef.schema.json#/definitions/PartyAccountRef with ../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef +... ... replaced schema $ref=RelatedPartyRef.schema.json#/definitions/RelatedPartyRef with ../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef +... ... replaced schema $ref=RelatedPartyRef.schema.json#/definitions/RelatedPartyRef with ../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef +... ... replaced schema $ref=RelatedPartyRef.schema.json#/definitions/RelatedPartyRef with ../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef +... ... replaced schema $ref=QuantityType.schema.json#/definitions/QuantityType with ../Common/QuantityType.schema.json#QuantityType +... ... replaced schema $ref=BalanceTransferBody.schema.json#/definitions/BalanceTransferBody with BalanceTransferBody.schema.json#BalanceTransferBody + +... BalanceTransferStatusTypeModify.schema.json +... ... added $id for BalanceTransferStatusTypeModify +... ... added missing type (object) for BalanceTransferStatusTypeModify + +... BillingAccount.schema.json +... ... replaced schema $ref=../Common/PartyAccount.schema.json#PartyAccount with ../EngagedParty/PartyAccount.schema.json#PartyAccount + +... Bucket.schema.json +... ... added $id for Bucket +... ... added missing type (object) for Bucket +... ... replaced schema $ref=BucketBalance.schema.json#/definitions/BucketBalance with BucketBalance.schema.json#BucketBalance + +... BucketBalance.schema.json +... ... added $id for BucketBalance +... ... added missing type (object) for BucketBalance +... ... replaced schema $ref=PartyAccountRef.schema.json#/definitions/PartyAccountRef with ../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef +... ... replaced schema $ref=ProductRef.schema.json#/definitions/ProductRef with ../Product/ProductRef.schema.json#ProductRef +... ... replaced schema $ref=ResourceRef.schema.json#/definitions/ResourceRef with ../Resource/ResourceRef.schema.json#ResourceRef +... ... replaced schema $ref=RelatedParty.schema.json#/definitions/RelatedParty with ../EngagedParty/RelatedParty.schema.json#RelatedParty +... ... replaced schema $ref=QuantityType.schema.json#/definitions/QuantityType with ../Common/QuantityType.schema.json#QuantityType +... ... replaced schema $ref=QuantityType.schema.json#/definitions/QuantityType with ../Common/QuantityType.schema.json#QuantityType +... ... replaced schema $ref=TimePeriodType.schema.json#/definitions/TimePeriodType with ../Common/TimePeriodType.schema.json#TimePeriodType + +... BucketBalanceRef.schema.json +... ... added $id for BucketBalanceRef +... ... added missing type (object) for BucketBalanceRef + +... CartItem.schema.json +... ... replaced schema $ref=CartItemActionType.schema.json#/definitions/CartItemActionType with CartItemActionType.schema.json#CartItemActionType +... ... replaced schema $ref=CartItemStatusType.schema.json#/definitions/CartItemStatusType with CartItemStatusType.schema.json#CartItemStatusType + +... CartPrice.schema.json +... ... replaced schema $ref=PriceAlteration.schema.json#PriceAlteration with ../Product/PriceAlteration.schema.json#PriceAlteration + +... Customer.schema.json +... ... replaced schema $ref=../Customer/PaymentMethodRef.schema.json#PaymentMethodRef with PaymentMethodRef.schema.json#PaymentMethodRef +... ... replaced schema $ref=../Customer/CreditProfile.schema.json#CreditProfile with CreditProfile.schema.json#CreditProfile + +... Disability.schema.json +... ... added $id for Disability +... ... replaced schema $ref=TimePeriod.schema.json#/definitions/TimePeriod with ../Common/TimePeriod.schema.json#TimePeriod +... ... replaced schema $ref=Entity.schema.json#Entity with ../Common/Entity.schema.json#Entity + +... OrderItemPrice.schema.json +... ... replaced schema $ref=PriceAlteration.schema.json#PriceAlteration with ../Product/PriceAlteration.schema.json#PriceAlteration + +... OrderPrice.schema.json +... ... replaced schema $ref=PriceAlteration.schema.json#PriceAlteration with ../Product/PriceAlteration.schema.json#PriceAlteration + +... PaymentMethodRefOrValue.schema.json +... ... added $id for PaymentMethodRefOrValue +... ... added missing type (object) for PaymentMethodRefOrValue +... ... replaced schema $ref=RelatedPartyRef.schema.json#/definitions/RelatedPartyRef with ../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef + +... PaymentRef.schema.json +... ... added $id for PaymentRef +... ... replaced schema $ref=../Common/EntityRef.schema.json#/EntityRef with ../Common/EntityRef.schema.json#EntityRef + +... ProductOfferingQualificationItemRef.schema.json +... ... added $id for ProductOfferingQualificationItemRef +... ... replaced schema $ref=../Common/Entity.schema.json#/Entity with ../Common/Entity.schema.json#Entity + +... ProductOrder.schema.json +... ... added $id for ProductOrder +... ... replaced schema $ref=AgreementRef.schema.json#/definitions/AgreementRef with ../EngagedParty/AgreementRef.schema.json#AgreementRef +... ... replaced schema $ref=BillingAccountRef.schema.json#/definitions/BillingAccountRef with BillingAccountRef.schema.json#BillingAccountRef +... ... replaced schema $ref=RelatedChannel.schema.json#/definitions/RelatedChannel with ../Common/RelatedChannel.schema.json#RelatedChannel +... ... replaced schema $ref=Note.schema.json#/definitions/Note with ../Common/Note.schema.json#Note +... ... replaced schema $ref=OrderPrice.schema.json#/definitions/OrderPrice with OrderPrice.schema.json#OrderPrice +... ... replaced schema $ref=PaymentRef.schema.json#/definitions/PaymentRef with PaymentRef.schema.json#PaymentRef +... ... replaced schema $ref=ProductOfferingQualificationRef.schema.json#/definitions/ProductOfferingQualificationRef with ../Product/ProductOfferingQualificationRef.schema.json#ProductOfferingQualificationRef +... ... replaced schema $ref=QuoteRef.schema.json#/definitions/QuoteRef with QuoteRef.schema.json#QuoteRef +... ... replaced schema $ref=ProductOrderItem.schema.json#/definitions/ProductOrderItem with ProductOrderItem.schema.json#ProductOrderItem +... ... replaced schema $ref=RelatedParty.schema.json#/definitions/RelatedParty with ../EngagedParty/RelatedParty.schema.json#RelatedParty +... ... replaced schema $ref=ProductOrderStateType.schema.json#/definitions/ProductOrderStateType with ProductOrderStateType.schema.json#ProductOrderStateType +... ... replaced schema $ref=Entity.schema.json#/Entity with ../Common/Entity.schema.json#Entity + +... ProductOrderItem.schema.json +... ... added $id for ProductOrderItem +... ... replaced schema $ref=OrderItemActionType.schema.json#/definitions/OrderItemActionType with OrderItemActionType.schema.json#OrderItemActionType +... ... replaced schema $ref=AppointmentRef.schema.json#/definitions/AppointmentRef with AppointmentRef.schema.json#AppointmentRef +... ... replaced schema $ref=BillingAccountRef.schema.json#/definitions/BillingAccountRef with BillingAccountRef.schema.json#BillingAccountRef +... ... replaced schema $ref=OrderPrice.schema.json#/definitions/OrderPrice with OrderPrice.schema.json#OrderPrice +... ... replaced schema $ref=OrderTerm.schema.json#/definitions/OrderTerm with OrderTerm.schema.json#OrderTerm +... ... replaced schema $ref=OrderPrice.schema.json#/definitions/OrderPrice with OrderPrice.schema.json#OrderPrice +... ... replaced schema $ref=PaymentRef.schema.json#/definitions/PaymentRef with PaymentRef.schema.json#PaymentRef +... ... replaced schema $ref=ProductRefOrValue.schema.json#/definitions/ProductRefOrValue with ../Product/ProductRefOrValue.schema.json#ProductRefOrValue +... ... replaced schema $ref=ProductOfferingRef.schema.json#/definitions/ProductOfferingRef with ../Product/ProductOfferingRef.schema.json#ProductOfferingRef +... ... replaced schema $ref=ProductOfferingQualificationItemRef.schema.json#/definitions/ProductOfferingQualificationItemRef with ../Product/ProductOfferingQualificationItemRef.schema.json#ProductOfferingQualificationItemRef +... ... replaced schema $ref=QuoteItemRef.schema.json#/definitions/QuoteItemRef with QuoteItemRef.schema.json#QuoteItemRef +... ... replaced schema $ref=ProductOrderItem.schema.json#/definitions/ProductOrderItem with ProductOrderItem.schema.json#ProductOrderItem +... ... replaced schema $ref=OrderItemRelationship.schema.json#/definitions/OrderItemRelationship with OrderItemRelationship.schema.json#OrderItemRelationship +... ... replaced schema $ref=ProductOfferingQualificationRef.schema.json#/definitions/ProductOfferingQualificationRef with ../Product/ProductOfferingQualificationRef.schema.json#ProductOfferingQualificationRef +... ... replaced schema $ref=ProductOrderItemStateType.schema.json#/definitions/ProductOrderItemStateType with ProductOrderItemStateType.schema.json#ProductOrderItemStateType +... ... replaced schema $ref=Entity.schema.json#/Entity with ../Common/Entity.schema.json#Entity + +... Quote.schema.json +... ... added $id for Quote +... ... replaced schema $ref=AgreementRef.schema.json#/definitions/AgreementRef with ../EngagedParty/AgreementRef.schema.json#AgreementRef +... ... replaced schema $ref=BillingAccountRef.schema.json#/definitions/BillingAccountRef with BillingAccountRef.schema.json#BillingAccountRef +... ... replaced schema $ref=ContactMedium.schema.json#/definitions/ContactMedium with ../Common/ContactMedium.schema.json#ContactMedium +... ... replaced schema $ref=Note.schema.json#/definitions/Note with ../Common/Note.schema.json#Note +... ... replaced schema $ref=Authorization.schema.json#/definitions/Authorization with Authorization.schema.json#Authorization +... ... replaced schema $ref=QuoteItem.schema.json#/definitions/QuoteItem with QuoteItem.schema.json#QuoteItem +... ... replaced schema $ref=QuotePrice.schema.json#/definitions/QuotePrice with QuotePrice.schema.json#QuotePrice +... ... replaced schema $ref=RelatedParty.schema.json#/definitions/RelatedParty with ../EngagedParty/RelatedParty.schema.json#RelatedParty +... ... replaced schema $ref=ProductOfferingQualificationRef.schema.json#/definitions/ProductOfferingQualificationRef with ../Product/ProductOfferingQualificationRef.schema.json#ProductOfferingQualificationRef +... ... replaced schema $ref=QuoteStateType.schema.json#/definitions/QuoteStateType with ../Product/QuoteStateType.schema.json#QuoteStateType +... ... replaced schema $ref=TimePeriod.schema.json#/definitions/TimePeriod with ../Common/TimePeriod.schema.json#TimePeriod +... ... replaced schema $ref=Entity.schema.json#/Entity with ../Common/Entity.schema.json#Entity + +... QuoteItem.schema.json +... ... added $id for QuoteItem +... ... replaced schema $ref=AppointmentRef.schema.json#/definitions/AppointmentRef with AppointmentRef.schema.json#AppointmentRef +... ... replaced schema $ref=AttachmentRefOrValue.schema.json#/definitions/AttachmentRefOrValue with ../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue +... ... replaced schema $ref=Note.schema.json#/definitions/Note with ../Common/Note.schema.json#Note +... ... replaced schema $ref=ProductRefOrValue.schema.json#/definitions/ProductRefOrValue with ../Product/ProductRefOrValue.schema.json#ProductRefOrValue +... ... replaced schema $ref=ProductOfferingRef.schema.json#/definitions/ProductOfferingRef with ../Product/ProductOfferingRef.schema.json#ProductOfferingRef +... ... replaced schema $ref=QuoteItem.schema.json#/definitions/QuoteItem with QuoteItem.schema.json#QuoteItem +... ... replaced schema $ref=Authorization.schema.json#/definitions/Authorization with Authorization.schema.json#Authorization +... ... replaced schema $ref=QuotePrice.schema.json#/definitions/QuotePrice with QuotePrice.schema.json#QuotePrice +... ... replaced schema $ref=QuoteItemRelationship.schema.json#/definitions/QuoteItemRelationship with QuoteItemRelationship.schema.json#QuoteItemRelationship +... ... replaced schema $ref=ProductOfferingQualificationItemRef.schema.json#/definitions/ProductOfferingQualificationItemRef with ../Product/ProductOfferingQualificationItemRef.schema.json#ProductOfferingQualificationItemRef +... ... replaced schema $ref=RelatedParty.schema.json#/definitions/RelatedParty with ../EngagedParty/RelatedParty.schema.json#RelatedParty +... ... replaced schema $ref=Entity.schema.json#/Entity with ../Common/Entity.schema.json#Entity + +... QuoteItemRef.schema.json +... ... added $id for QuoteItemRef +... ... replaced schema $ref=../Common/EntityRef.schema.json#/EntityRef with ../Common/EntityRef.schema.json#EntityRef + +... QuotePrice.schema.json +... ... replaced schema $ref=PriceAlteration.schema.json#PriceAlteration with ../Product/PriceAlteration.schema.json#PriceAlteration + +... QuoteRef.schema.json +... ... added $id for QuoteRef +... ... replaced schema $ref=../Common/EntityRef.schema.json#/EntityRef with ../Common/EntityRef.schema.json#EntityRef + +... SearchTimeSlot.schema.json +... ... added $id for SearchTimeSlot +... ... replaced schema $ref=TimeSlot.schema.json#/definitions/TimeSlot with TimeSlot.schema.json#TimeSlot +... ... replaced schema $ref=TimeSlot.schema.json#/definitions/TimeSlot with TimeSlot.schema.json#TimeSlot + +... AccountDirectMethod.schema.json +... ... replaced schema $ref=../EngagedParty/RelatedParty.schema.json#RelatedParty with RelatedParty.schema.json#RelatedParty +... ... replaced schema $ref=../EngagedParty/AccountRef.schema.json#AccountRef with AccountRef.schema.json#AccountRef + +... AgreementSpecification.schema.json +... ... replaced schema $ref=AttachmentRefOrValue.schema.json#AttachmentRefOrValue with ../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue + +... BankAccountDebitMethod.schema.json +... ... replaced schema $ref=../EngagedParty/RelatedParty.schema.json#RelatedParty with RelatedParty.schema.json#RelatedParty +... ... replaced schema $ref=../EngagedParty/AccountRef.schema.json#AccountRef with AccountRef.schema.json#AccountRef + +... BankAccountTransferMethod.schema.json +... ... replaced schema $ref=../EngagedParty/RelatedParty.schema.json#RelatedParty with RelatedParty.schema.json#RelatedParty +... ... replaced schema $ref=../EngagedParty/AccountRef.schema.json#AccountRef with AccountRef.schema.json#AccountRef + +... FinancialAccount.schema.json +... ... replaced schema $ref=../Common/Account.schema.json#Account with Account.schema.json#Account + +... Individual.schema.json +... ... added $id for Individual +... ... replaced schema $ref=IndividualStateType.schema.json#/definitions/IndividualStateType with IndividualStateType.schema.json#IndividualStateType +... ... replaced schema $ref=OtherNameIndividual.schema.json#/definitions/OtherNameIndividual with OtherNameIndividual.schema.json#OtherNameIndividual +... ... replaced schema $ref=IndividualIdentification.schema.json#/definitions/IndividualIdentification with IndividualIdentification.schema.json#IndividualIdentification +... ... replaced schema $ref=Disability.schema.json#/definitions/Disability with ../Customer/Disability.schema.json#Disability +... ... replaced schema $ref=LanguageAbility.schema.json#/definitions/LanguageAbility with LanguageAbility.schema.json#LanguageAbility +... ... replaced schema $ref=Skill.schema.json#/definitions/Skill with Skill.schema.json#Skill +... ... replaced schema $ref=Entity.schema.json#Entity with ../Common/Entity.schema.json#Entity + +... IndividualIdentification.schema.json +... ... replaced schema $ref=AttachmentRefOrValue.schema.json#/definitions/AttachmentRefOrValue with ../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue + +... LanguageAbility.schema.json +... ... added $id for LanguageAbility +... ... replaced schema $ref=TimePeriod.schema.json#/definitions/TimePeriod with ../Common/TimePeriod.schema.json#TimePeriod +... ... replaced schema $ref=Entity.schema.json#Entity with ../Common/Entity.schema.json#Entity + +... Organization.schema.json +... ... added $id for Organization +... ... replaced schema $ref=TimePeriod.schema.json#/definitions/TimePeriod with ../Common/TimePeriod.schema.json#TimePeriod +... ... replaced schema $ref=OrganizationStateType.schema.json#/definitions/OrganizationStateType with OrganizationStateType.schema.json#OrganizationStateType +... ... replaced schema $ref=OtherNameOrganization.schema.json#/definitions/OtherNameOrganization with OtherNameOrganization.schema.json#OtherNameOrganization +... ... replaced schema $ref=OrganizationIdentification.schema.json#/definitions/OrganizationIdentification with OrganizationIdentification.schema.json#OrganizationIdentification +... ... replaced schema $ref=OrganizationChildRelationship.schema.json#/definitions/OrganizationChildRelationship with OrganizationChildRelationship.schema.json#OrganizationChildRelationship +... ... replaced schema $ref=OrganizationParentRelationship.schema.json#/definitions/OrganizationParentRelationship with OrganizationParentRelationship.schema.json#OrganizationParentRelationship +... ... replaced schema $ref=Entity.schema.json#Entity with ../Common/Entity.schema.json#Entity + +... OrganizationChildRelationship.schema.json +... ... added $id for OrganizationChildRelationship + +... OrganizationIdentification.schema.json +... ... replaced schema $ref=AttachmentRefOrValue.schema.json#/definitions/AttachmentRefOrValue with ../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue + +... OrganizationParentRelationship.schema.json +... ... added $id for OrganizationParentRelationship +... ... replaced schema $ref=OrganizationRef.schema.json#/definitions/OrganizationRef with OrganizationRef.schema.json#OrganizationRef + +... OtherNameIndividual.schema.json +... ... added $id for OtherNameIndividual +... ... replaced schema $ref=TimePeriod.schema.json#/definitions/TimePeriod with ../Common/TimePeriod.schema.json#TimePeriod +... ... replaced schema $ref=Entity.schema.json#Entity with ../Common/Entity.schema.json#Entity + +... OtherNameOrganization.schema.json +... ... added $id for OtherNameOrganization +... ... replaced schema $ref=TimePeriod.schema.json#/definitions/TimePeriod with ../Common/TimePeriod.schema.json#TimePeriod +... ... replaced schema $ref=Entity.schema.json#Entity with ../Common/Entity.schema.json#Entity + +... Party.schema.json +... ... added $id for Party +... ... replaced schema $ref=ExternalReference.schema.json#/definitions/ExternalReference with ../Common/ExternalReference.schema.json#ExternalReference +... ... replaced schema $ref=Characteristic.schema.json#/definitions/Characteristic with ../Common/Characteristic.schema.json#Characteristic +... ... replaced schema $ref=TaxExemptionCertificate.schema.json#/definitions/TaxExemptionCertificate with TaxExemptionCertificate.schema.json#TaxExemptionCertificate +... ... replaced schema $ref=PartyCreditProfile.schema.json#/definitions/PartyCreditProfile with PartyCreditProfile.schema.json#PartyCreditProfile +... ... replaced schema $ref=RelatedParty.schema.json#/definitions/RelatedParty with RelatedParty.schema.json#RelatedParty +... ... replaced schema $ref=ContactMedium.schema.json#/definitions/ContactMedium with ../Common/ContactMedium.schema.json#ContactMedium +... ... replaced schema $ref=Entity.schema.json#Entity with ../Common/Entity.schema.json#Entity + +... PartyAccount.schema.json +... ... replaced schema $ref=../Common/Account.schema.json#Account with Account.schema.json#Account + +... PartyBill.schema.json +... ... replaced schema $ref=../EngagedParty/RelatedParty.schema.json#RelatedParty with RelatedParty.schema.json#RelatedParty +... ... replaced schema $ref=../EngagedParty/FinancialAccountRef.schema.json#FinancialAccountRef with FinancialAccountRef.schema.json#FinancialAccountRef + +... PartyCreditProfile.schema.json +... ... added $id for PartyCreditProfile +... ... replaced schema $ref=TimePeriod.schema.json#/definitions/TimePeriod with ../Common/TimePeriod.schema.json#TimePeriod +... ... replaced schema $ref=Entity.schema.json#Entity with ../Common/Entity.schema.json#Entity + +... PartyRole.schema.json +... ... added $id for required +... ... added missing type (object) for required + +... SettlementAccount.schema.json +... ... replaced schema $ref=../Common/PartyAccount.schema.json#PartyAccount with PartyAccount.schema.json#PartyAccount + +... Skill.schema.json +... ... added $id for Skill +... ... replaced schema $ref=TimePeriod.schema.json#/definitions/TimePeriod with ../Common/TimePeriod.schema.json#TimePeriod +... ... replaced schema $ref=Entity.schema.json#Entity with ../Common/Entity.schema.json#Entity + +... TaxExemptionCertificate.schema.json +... ... added $id for TaxExemptionCertificate +... ... replaced schema $ref=TaxDefinition.schema.json#/definitions/TaxDefinition with ../Common/TaxDefinition.schema.json#TaxDefinition +... ... replaced schema $ref=TimePeriod.schema.json#/definitions/TimePeriod with ../Common/TimePeriod.schema.json#TimePeriod +... ... replaced schema $ref=AttachmentRefOrValue.schema.json#/definitions/AttachmentRefOrValue with ../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue +... ... replaced schema $ref=Entity.schema.json#Entity with ../Common/Entity.schema.json#Entity + +... SalesLead.schema.json +... ... replaced schema $ref=../MarketingSales/MarketingCampaignRef.schema.json#MarketingCampaignRef with MarketingCampaignRef.schema.json#MarketingCampaignRef +... ... replaced schema $ref=../MarketingSales/MarketSegmentRef.schema.json#MarketSegmentRef with MarketSegmentRef.schema.json#MarketSegmentRef +... ... replaced schema $ref=../Customer/ChannelRef.schema.json#ChannelRef with ../Common/ChannelRef.schema.json#ChannelRef +... ... replaced schema $ref=../MarketingSales/SalesOpportunityRef.schema.json#SalesOpportunityRef with SalesOpportunityRef.schema.json#SalesOpportunityRef + +... BaseProductRefOrValue.schema.json +... ... replaced schema $ref=Characteristic.schema.json#Characteristic with ../Common/Characteristic.schema.json#Characteristic + +... CancelOrder.schema.json +... ... replaced schema $ref=TaskStateType.schema.json#/definitions/TaskStateType with ../Common/TaskStateType.schema.json#TaskStateType + +... CancelProductOrder.schema.json +... ... replaced schema $ref=../Common/EntityRef.schema.json#CancelOrder with ../Common/EntityRef.schema.json#CancelOrderRef + +... LoyaltyAccount.schema.json +... ... removed title for LoyaltyAccount (should be at outer level) +... ... replaced schema $ref=LoyaltyProgramProductRef.schema.json#/definitions/LoyaltyProgramProductRef with LoyaltyProgramProductRef.schema.json#LoyaltyProgramProductRef + +... LoyaltyAccountRef.schema.json +... ... removed title for LoyaltyAccountRef (should be at outer level) + +... LoyaltyAction.schema.json +... ... removed title for LoyaltyAction (should be at outer level) +... ... replaced schema $ref=../Common/Any.schema.json#/definitions/Any with ../Common/Any.schema.json#Any +... ... replaced schema $ref=../Common/Any.schema.json#/definitions/Any with ../Common/Any.schema.json#Any +... ... replaced schema $ref=../Common/Any.schema.json#/definitions/Any with ../Common/Any.schema.json#Any + +... LoyaltyActionRef.schema.json +... ... removed title for LoyaltyActionRef (should be at outer level) + +... LoyaltyBalance.schema.json +... ... removed title for LoyaltyBalance (should be at outer level) +... ... replaced schema $ref=../Common/Money.schema.json#/definitions/Money with ../Common/Money.schema.json#Money +... ... replaced schema $ref=LoyaltyProgramMemberRef.schema.json#/definitions/LoyaltyProgramMemberRef with LoyaltyProgramMemberRef.schema.json#LoyaltyProgramMemberRef +... ... replaced schema $ref=../Common/TimePeriod.schema.json#/definitions/TimePeriod with ../Common/TimePeriod.schema.json#TimePeriod + +... LoyaltyCondition.schema.json +... ... removed title for LoyaltyCondition (should be at outer level) + +... LoyaltyConditionRef.schema.json +... ... removed title for LoyaltyConditionRef (should be at outer level) + +... LoyaltyEvent.schema.json +... ... removed title for LoyaltyEvent (should be at outer level) +... ... replaced schema $ref=LoyaltyProgramProductRef.schema.json#/definitions/LoyaltyProgramProductRef with LoyaltyProgramProductRef.schema.json#LoyaltyProgramProductRef +... ... replaced schema $ref=../Common/Any.schema.json#/definitions/Any with ../Common/Any.schema.json#Any + +... LoyaltyEventType.schema.json +... ... removed title for LoyaltyEventType (should be at outer level) + +... LoyaltyEventTypeRef.schema.json +... ... removed title for LoyaltyEventTypeRef (should be at outer level) + +... LoyaltyProgramMember.schema.json +... ... added $id for LoyaltyProgramMember +... ... removed id for LoyaltyProgramMember (using $id) +... ... removed title for LoyaltyProgramMember (should be at outer level) +... ... replaced schema $ref=../Common/TimePeriod.schema.json#/definitions/TimePeriod with ../Common/TimePeriod.schema.json#TimePeriod + +... LoyaltyProgramMemberRef.schema.json +... ... added $id for LoyaltyProgramMemberRef +... ... removed id for LoyaltyProgramMemberRef (using $id) +... ... removed title for LoyaltyProgramMemberRef (should be at outer level) + +... LoyaltyProgramProduct.schema.json +... ... added $id for LoyaltyProgramProduct +... ... removed id for LoyaltyProgramProduct (using $id) +... ... removed title for LoyaltyProgramProduct (should be at outer level) +... ... replaced schema $ref=Characteristic.schema.json#Characteristic with ../Common/Characteristic.schema.json#Characteristic +... ... replaced schema $ref=../Common/TimePeriod.schema.json#/definitions/TimePeriod with ../Common/TimePeriod.schema.json#TimePeriod + +... LoyaltyProgramProductRef.schema.json +... ... added $id for LoyaltyProgramProductRef +... ... removed id for LoyaltyProgramProductRef (using $id) +... ... removed title for LoyaltyProgramProductRef (should be at outer level) + +... LoyaltyProgramProductSpec.schema.json +... ... removed title for LoyaltyProgramProductSpec (should be at outer level) +... ... replaced schema $ref=../Common/TimePeriod.schema.json#/definitions/TimePeriod with ../Common/TimePeriod.schema.json#TimePeriod + +... LoyaltyProgramProductSpecRef.schema.json +... ... removed title for LoyaltyProgramProductSpecRef (should be at outer level) + +... LoyaltyRule.schema.json +... ... removed title for LoyaltyRule (should be at outer level) + +... LoyaltyRuleAction.schema.json +... ... removed title for LoyaltyRuleAction (should be at outer level) + +... LoyaltyRuleCondition.schema.json +... ... removed title for LoyaltyRuleCondition (should be at outer level) + +... LoyaltyRuleEventType.schema.json +... ... removed title for LoyaltyRuleEventType (should be at outer level) + +... PriceAlteration.schema.json +... ... replaced schema $ref=../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef with ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef +... ... replaced schema $ref=Price.schema.json#Price with ../Customer/Price.schema.json#Price + +... Product.schema.json +... ... added $id for Product +... ... replaced schema $ref=AgreementItemRef.schema.json#/definitions/AgreementItemRef with ../EngagedParty/AgreementItemRef.schema.json#AgreementItemRef +... ... replaced schema $ref=BillingAccountRef.schema.json#/definitions/BillingAccountRef with ../Customer/BillingAccountRef.schema.json#BillingAccountRef +... ... replaced schema $ref=Characteristic.schema.json#/definitions/Characteristic with ../Common/Characteristic.schema.json#Characteristic +... ... replaced schema $ref=ProductOfferingRef.schema.json#/definitions/ProductOfferingRef with ProductOfferingRef.schema.json#ProductOfferingRef +... ... replaced schema $ref=RelatedProductOrderItem.schema.json#/definitions/RelatedProductOrderItem with RelatedProductOrderItem.schema.json#RelatedProductOrderItem +... ... replaced schema $ref=ProductRefOrValue.schema.json#/definitions/ProductRefOrValue with ProductRefOrValue.schema.json#ProductRefOrValue +... ... replaced schema $ref=ProductPrice.schema.json#/definitions/ProductPrice with ProductPrice.schema.json#ProductPrice +... ... replaced schema $ref=ProductRelationship.schema.json#/definitions/ProductRelationship with ProductRelationship.schema.json#ProductRelationship +... ... replaced schema $ref=ProductSpecificationRef.schema.json#/definitions/ProductSpecificationRef with ProductSpecificationRef.schema.json#ProductSpecificationRef +... ... replaced schema $ref=ProductTerm.schema.json#/definitions/ProductTerm with ProductTerm.schema.json#ProductTerm +... ... replaced schema $ref=ResourceRef.schema.json#/definitions/ResourceRef with ../Resource/ResourceRef.schema.json#ResourceRef +... ... replaced schema $ref=ServiceRef.schema.json#/definitions/ServiceRef with ../Service/ServiceRef.schema.json#ServiceRef +... ... replaced schema $ref=RelatedParty.schema.json#/definitions/RelatedParty with ../EngagedParty/RelatedParty.schema.json#RelatedParty +... ... replaced schema $ref=RelatedPlaceRefOrValue.schema.json#/definitions/RelatedPlaceRefOrValue with ../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue +... ... replaced schema $ref=ProductStatusType.schema.json#/definitions/ProductStatusType with ProductStatusType.schema.json#ProductStatusType +... ... replaced schema $ref=Entity.schema.json#/Entity with ../Common/Entity.schema.json#Entity + +... ProductOfferingQualification.schema.json +... ... added $id for ProductOfferingQualification +... ... replaced schema $ref=ChannelRef.schema.json#/definitions/ChannelRef with ../Common/ChannelRef.schema.json#ChannelRef +... ... replaced schema $ref=Note.schema.json#/definitions/Note with ../Common/Note.schema.json#Note +... ... replaced schema $ref=ProductOfferingQualificationItem.schema.json#/definitions/ProductOfferingQualificationItem with ProductOfferingQualificationItem.schema.json#ProductOfferingQualificationItem +... ... replaced schema $ref=RelatedParty.schema.json#/definitions/RelatedParty with ../EngagedParty/RelatedParty.schema.json#RelatedParty +... ... replaced schema $ref=TaskStateType.schema.json#/definitions/TaskStateType with ../Common/TaskStateType.schema.json#TaskStateType +... ... replaced schema $ref=Entity.schema.json#/Entity with ../Common/Entity.schema.json#Entity + +... ProductOfferingQualificationItem.schema.json +... ... replaced schema $ref=ProductActionType.schema.json#/definitions/ProductActionType with ProductActionType.schema.json#ProductActionType +... ... replaced schema $ref=TaskStateType.schema.json#/definitions/TaskStateType with ../Common/TaskStateType.schema.json#TaskStateType +... ... replaced schema $ref=../Product/EligibilityUnavailabilityReason.schema.json#EligibilityUnavailabilityReason with EligibilityUnavailabilityReason.schema.json#EligibilityUnavailabilityReason + +... ProductOfferingQualificationRef.schema.json +... ... added $id for ProductOfferingQualificationRef +... ... replaced schema $ref=EntityRef.schema.json#/EntityRef with ../Common/EntityRef.schema.json#EntityRef + +... ProductPrice.schema.json +... ... replaced schema $ref=../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef with ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef +... ... replaced schema $ref=BillingAccountRef.schema.json#BillingAccountRef with ../Customer/BillingAccountRef.schema.json#BillingAccountRef +... ... replaced schema $ref=../Customer/PriceAlteration.schema.json#PriceAlteration with PriceAlteration.schema.json#PriceAlteration + +... ProductRestriction.schema.json +... ... replaced schema $ref=Characteristic.schema.json#Characteristic with ../Common/Characteristic.schema.json#Characteristic + +... ProductSpecificationCharacteristicValue.schema.json +... ... replaced schema $ref=../Common/Any.schema.json#/definitions/Any with ../Common/Any.schema.json#Any + +... Recommendation.schema.json +... ... replaced schema $ref=ProductOrderRef.schema.json#ProductOrderRef with ../Customer/ProductOrderRef.schema.json#ProductOrderRef +... ... replaced schema $ref=../Customer/ChannelRef.schema.json#ChannelRef with ../Common/ChannelRef.schema.json#ChannelRef +... ... replaced schema $ref=../Product/CategoryRef.schema.json#CategoryRef with CategoryRef.schema.json#CategoryRef + +... RelatedProductOrderItem.schema.json +... ... added $id for RelatedProductOrderItem +... ... replaced schema $ref=Entity.schema.json#/Entity with ../Common/Entity.schema.json#Entity + +... UsageConsumptionReportRequest.schema.json +... ... replaced schema $ref=UsageVolumeProductRef.schema.json#/definitions/UsageVolumeProductRef with UsageVolumeProductRef.schema.json#UsageVolumeProductRef + +... UsageConsumptionReportRequestIn.schema.json +... ... replaced schema $ref=NetworkProductRef.schema.json#/definitions/NetworkProductRef with NetworkProductRef.schema.json#NetworkProductRef + +... RealizingResourceRef.schema.json +... ... added $id for RealizingResourceRef +... ... replaced schema $ref=EntityRef.schema.json#/EntityRef with ../Common/EntityRef.schema.json#EntityRef + +... ResourceAlarmRef.schema.json +... ... replaced schema $ref=../Common/ChangeRequestRef.schema.json#/definitions/ChangeRequestRef with ../Common/ChangeRequestRef.schema.json#ChangeRequestRef + +... BaseService.schema.json +... ... replaced schema $ref=ServiceStateType.schema.json#/definitions/ServiceStateType with ServiceStateType.schema.json#ServiceStateType +... ... replaced schema $ref=ServiceSpecificationRef.schema.json#/definitions/ServiceSpecificationRef with ServiceSpecificationRef.schema.json#ServiceSpecificationRef +... ... replaced schema $ref=../Common/Characteristic.schema.json#/definitions/Characteristic with ../Common/Characteristic.schema.json#Characteristic +... ... replaced schema $ref=ServiceRelationship.schema.json#/definitions/ServiceRelationship with ServiceRelationship.schema.json#ServiceRelationship +... ... replaced schema $ref=ServiceRef.schema.json#/definitions/ServiceRef with ServiceRef.schema.json#ServiceRef +... ... replaced schema $ref=../Resource/ResourceRef.schema.json#/definitions/ResourceRef with ../Resource/ResourceRef.schema.json#ResourceRef +... ... replaced schema $ref=../EngagedParty/RelatedParty.schema.json#/definitions/RelatedParty with ../EngagedParty/RelatedParty.schema.json#RelatedParty +... ... replaced schema $ref=../Common/Place.schema.json#/definitions/Place with ../Common/Place.schema.json#Place + +... MetricDefMeasureThresholdRule.schema.json +... ... replaced schema $ref=MetricDefMeasureConsequence.schema.json#/definitions/MetricDefMeasureConsequence with MetricDefMeasureConsequence.schema.json#MetricDefMeasureConsequence + +... Service.schema.json +... ... replaced schema $ref=ServiceOrderRef.schema.json#/definitions/ServiceOrderRef with ServiceOrderRef.schema.json#ServiceOrderRef +... ... replaced schema $ref=../Common/Note.schema.json#/definitions/Note with ../Common/Note.schema.json#Note +... ... replaced schema $ref=../Service/BaseService.schema.json#BaseService with BaseService.schema.json#BaseService + +... ServiceOrder.schema.json +... ... replaced schema $ref=../Common/Note.schema.json#/definitions/Note with ../Common/Note.schema.json#Note +... ... replaced schema $ref=ServiceOrderItem.schema.json#/definitions/ServiceOrderItem with ServiceOrderItem.schema.json#ServiceOrderItem +... ... replaced schema $ref=ServiceOrderRelationship.schema.json#/definitions/ServiceOrderRelationship with ServiceOrderRelationship.schema.json#ServiceOrderRelationship +... ... replaced schema $ref=../EngagedParty/RelatedParty.schema.json#/definitions/RelatedParty with ../EngagedParty/RelatedParty.schema.json#RelatedParty +... ... replaced schema $ref=ServiceOrderStateType.schema.json#/definitions/ServiceOrderStateType with ServiceOrderStateType.schema.json#ServiceOrderStateType + +... ServiceOrderItem.schema.json +... ... replaced schema $ref=ServiceOrderActionType.schema.json#/definitions/ServiceOrderActionType with ServiceOrderActionType.schema.json#ServiceOrderActionType +... ... replaced schema $ref=ServiceOrderStateType.schema.json#/definitions/ServiceOrderStateType with ServiceOrderStateType.schema.json#ServiceOrderStateType +... ... replaced schema $ref=BaseService.schema.json#/definitions/BaseService with BaseService.schema.json#BaseService +... ... replaced schema $ref=../Customer/AppointmentRef.schema.json#/definitions/AppointmentRef with ../Customer/AppointmentRef.schema.json#AppointmentRef +... ... replaced schema $ref=OrderItemRelationship.schema.json#/definitions/OrderItemRelationship with ../Customer/OrderItemRelationship.schema.json#OrderItemRelationship + +... ServiceProblem.schema.json +... ... replaced schema $ref=../Common/Place.schema.json#/definitions/Place with ../Common/Place.schema.json#Place +... ... replaced schema $ref=../Resource/ResourceRef.schema.json#/definitions/ResourceRef with ../Resource/ResourceRef.schema.json#ResourceRef +... ... replaced schema $ref=ServiceRef.schema.json#/definitions/ServiceRef with ServiceRef.schema.json#ServiceRef +... ... replaced schema $ref=../Common/Note.schema.json#/definitions/Note with ../Common/Note.schema.json#Note +... ... replaced schema $ref=../Common/Characteristic.schema.json#/definitions/Characteristic with ../Common/Characteristic.schema.json#Characteristic +... ... replaced schema $ref=../Common/RelatedEntityRef.schema.json#/definitions/RelatedEntityRef with ../Common/RelatedEntityRef.schema.json#RelatedEntityRef +... ... replaced schema $ref=ImpactPattern.schema.json#/definitions/ImpactPattern with ImpactPattern.schema.json#ImpactPattern +... ... replaced schema $ref=ServiceProblemRef.schema.json#/definitions/ServiceProblemRef with ServiceProblemRef.schema.json#ServiceProblemRef +... ... replaced schema $ref=../Common/EventRef.schema.json#/definitions/EventRef with ../Common/EventRef.schema.json#EventRef +... ... replaced schema $ref=../Common/RelatedEntityRef.schema.json#/definitions/RelatedEntityRef with ../Common/RelatedEntityRef.schema.json#RelatedEntityRef +... ... replaced schema $ref=../EngagedParty/RelatedParty.schema.json#/definitions/RelatedParty with ../EngagedParty/RelatedParty.schema.json#RelatedParty +... ... replaced schema $ref=../EngagedParty/RelatedParty.schema.json#/definitions/RelatedParty with ../EngagedParty/RelatedParty.schema.json#RelatedParty +... ... replaced schema $ref=../EngagedParty/RelatedParty.schema.json#/definitions/RelatedParty with ../EngagedParty/RelatedParty.schema.json#RelatedParty +... ... replaced schema $ref=../Resource/ResourceRef.schema.json#/definitions/ResourceRef with ../Resource/ResourceRef.schema.json#ResourceRef +... ... replaced schema $ref=ServiceRef.schema.json#/definitions/ServiceRef with ServiceRef.schema.json#ServiceRef +... ... replaced schema $ref=TrackingRecord.schema.json#/definitions/TrackingRecord with TrackingRecord.schema.json#TrackingRecord +... ... replaced schema $ref=../Resource/ResourceAlarmRef.schema.json#/definitions/ResourceAlarmRef with ../Resource/ResourceAlarmRef.schema.json#ResourceAlarmRef +... ... replaced schema $ref=../EngagedParty/SLAViolationRef.schema.json#/definitions/SLAViolationRef with ../EngagedParty/SLAViolationRef.schema.json#SLAViolationRef +... ... replaced schema $ref=../Common/TroubleTicketRef.schema.json#/definitions/TroubleTicketRef with ../Common/TroubleTicketRef.schema.json#TroubleTicketRef +... ... replaced schema $ref=ServiceProblemRef.schema.json#/definitions/ServiceProblemRef with ServiceProblemRef.schema.json#ServiceProblemRef + +... ServiceProblemEventRecord.schema.json +... ... replaced schema $ref=ServiceProblemRef.schema.json#/definitions/ServiceProblemRef with ServiceProblemRef.schema.json#ServiceProblemRef +... ... replaced schema $ref=../Common/Any.schema.json#/definitions/Any with ../Common/Any.schema.json#Any + +... ServiceSpecCharacteristicValue.schema.json +... ... replaced schema $ref=../Common/Any.schema.json#/definitions/Any with ../Common/Any.schema.json#Any + +... ServiceSpecification.schema.json +... ... replaced schema $ref=ServiceLevelSpecificationRef.schema.json#/definitions/ServiceLevelSpecificationRef with ServiceLevelSpecificationRef.schema.json#ServiceLevelSpecificationRef +... ... replaced schema $ref=TargetServiceSchema.schema.json#/definitions/TargetServiceSchema with TargetServiceSchema.schema.json#TargetServiceSchema + +... ServiceSpecificationRef.schema.json +... ... replaced schema $ref=TargetServiceSchema.schema.json#/definitions/TargetServiceSchema with TargetServiceSchema.schema.json#TargetServiceSchema + +... ServiceTest.schema.json +... ... replaced schema $ref=../Common/Characteristic.schema.json#/definitions/Characteristic with ../Common/Characteristic.schema.json#Characteristic +... ... replaced schema $ref=ServiceRef.schema.json#/definitions/ServiceRef with ServiceRef.schema.json#ServiceRef +... ... replaced schema $ref=TestMeasure.schema.json#/definitions/TestMeasure with TestMeasure.schema.json#TestMeasure +... ... replaced schema $ref=ServiceTestSpecificationRef.schema.json#/definitions/ServiceTestSpecificationRef with ServiceTestSpecificationRef.schema.json#ServiceTestSpecificationRef + +... TestMeasure.schema.json +... ... replaced schema $ref=MeasureThresholdRuleViolation.schema.json#/definitions/MeasureThresholdRuleViolation with MeasureThresholdRuleViolation.schema.json#MeasureThresholdRuleViolation +... ... replaced schema $ref=../Common/Characteristic.schema.json#/definitions/Characteristic with ../Common/Characteristic.schema.json#Characteristic + +... TrackingRecord.schema.json +... ... replaced schema $ref=../Common/Characteristic.schema.json#/definitions/Characteristic with ../Common/Characteristic.schema.json#Characteristic + From e93800096e061ff3511652b0523d77852f22248f Mon Sep 17 00:00:00 2001 From: Schema validation Bot Date: Mon, 15 Jul 2019 13:50:01 +0000 Subject: [PATCH 09/11] Validation result with ERRORS [skip ci] --- .../validation-20190715T135001Z.txt | 1065 +++++++++++++++++ 1 file changed, 1065 insertions(+) create mode 100644 .circleci/validation_results/validation-20190715T135001Z.txt diff --git a/.circleci/validation_results/validation-20190715T135001Z.txt b/.circleci/validation_results/validation-20190715T135001Z.txt new file mode 100644 index 00000000..8c88fea1 --- /dev/null +++ b/.circleci/validation_results/validation-20190715T135001Z.txt @@ -0,0 +1,1065 @@ +SCHEMA VALIDATION +================= +# schemas : 489 files processed +# errors : 15 +# validate ok : 474 +# issues : 213 files / 574 issues + +total time: 4.77 seconds + + +ERROR - schemas with error(s): +... Common/Entity.schema.json +... ... discriminator (@type) defined but not included in 'required' property + +... Common/RelatedGeographicAddressRefOrValue.schema.json +... ... discriminator (isRef) defined but not included in 'required' property + +... Common/RelatedGeographicLocationRefOrValue.schema.json +... ... discriminator (isRef) defined but not included in 'required' property + +... Common/RelatedPlaceRefOrValue.schema.json +... ... discriminator (isRef) defined but no isRef property defined +... ... discriminator (isRef) defined but not included in 'required' property + +... Customer/BalanceTopupStatus.schema.json +... ... BalanceTopupStatus requires property "type" +... ... BalanceTopupStatus requires property "$id" + +... Customer/ProductOfferingQualificationItemRef.schema.json +... ... ProductOfferingQualificationItemRef requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/EntityRef.schema.json' + +... EngagedParty/PartyRole.schema.json +... ... required additionalProperty "0" exists in instance when not allowed +... ... required additionalProperty "1" exists in instance when not allowed + +... EngagedParty/RelatedPartyRefOrValue.schema.json +... ... isRef property defined, but not included in required +... ... discriminator (isRef) defined but not included in 'required' property + +... MarketingSales/SalesLead.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'MarketingSales/SalesLeadStateType.schema.json' + +... Product/BaseProductRefOrValue.schema.json +... ... isRef property defined, but not included in required + +... Product/CancelProductOrder.schema.json +... ... de-reference check: Token "#CancelOrderRef" does not exist. + +... Product/LoyaltyExecutionPoint.schema.json +... ... LoyaltyAccount additionalProperty "title" exists in instance when not allowed +... ... schema mismatch with title (LoyaltyExecutionPoint) and definitions (LoyaltyAccount) + +... Service/AlternateServiceProposal.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/ServiceRestriction.schema.json' + +... Service/ServiceQualification.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/ServiceRestriction.schema.json' + +... Service/ServiceQualificationItem.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/ServiceRestriction.schema.json' + + +ISSUES - schemas with issue(s): +... Common/AlternateGeographicAddress.schema.json +... ... geographicLocation :: no description value +... ... geographicSubAddress :: no description value + +... Common/AssociationRoleSpec.schema.json +... ... aggregation :: no description value +... ... defaultQuantity :: no description value +... ... entityType :: no description value +... ... isNavigable :: no description value +... ... isSource :: no description value +... ... maxQuantity :: no description value +... ... minQuantity :: no description value +... ... role :: no description value + +... Common/AssociationSpecification.schema.json +... ... constraint :: no description value +... ... associationRoleSpec :: no description value + +... Common/BusinessInteraction.schema.json +... ... interactionData :: no description value +... ... interactionDataComplete :: no description value +... ... interactionDataStatus :: no description value + +... Common/CalendarEventRef.schema.json +... ... CalendarEventRef :: no properties defined + +... Common/CalendarPeriod.schema.json +... ... timeZone :: recommend to add format +... ... hourPeriod :: no description value + +... Common/ChangeRequest.schema.json +... ... workLog :: no description value +... ... incident :: no description value +... ... changeRequestSpecification :: no description value +... ... impactEntity :: no description value +... ... changeRequestCharacteristic :: no description value +... ... targetEntity :: no description value +... ... resolution :: no description value +... ... sla :: no description value +... ... relateChangeRequest :: no description value +... ... category :: no description value +... ... note :: no description value + +... Common/ChangeRequestSpecification.schema.json +... ... validFor :: no description value + +... Common/Channel.schema.json +... ... Channel :: should be renamed as ChannelRef if this is a reference entity + +... Common/CommonComponents.schema.json +... ... Failing to check for issues: TypeError: Cannot read property 'properties' of undefined + +... Common/CommunicationMessage.schema.json +... ... logFlag :: no description value +... ... tryTimes :: recommend to add format + +... Common/Document.schema.json +... ... binaryAttachment :: no description value +... ... category :: no description value +... ... documentRelationship :: no description value +... ... relatedObject :: no description value + +... Common/DocumentCharacteristic.schema.json +... ... value :: no description value + +... Common/DocumentRelationship.schema.json +... ... documentRef :: no description value + +... Common/EntitySpecRelationship.schema.json +... ... associationSpec :: no description value + +... Common/EntitySpecification.schema.json +... ... attachment :: no description value +... ... entitySchema :: no description value +... ... specCharacteristic :: no description value +... ... relatedParty :: no description value + +... Common/ExternalReference.schema.json +... ... ExternalReference :: should be renamed as ExternalReferenceRef if this is a reference entity + +... Common/GeographicAddress.schema.json +... ... geographicLocation :: no description value +... ... geographicSubAddress :: no description value + +... Common/GeographicAddressValidation.schema.json +... ... validAddress :: no description value +... ... alternateGeographicAddress :: no description value + +... Common/GeographicLocation.schema.json +... ... accuracy :: no description value +... ... spatialRef :: no description value +... ... geometry :: no description value + +... Common/GeographicLocationRef.schema.json +... ... GeographicLocationRef :: no properties defined + +... Common/GeographicSite.schema.json +... ... relatedParty :: no description value +... ... calendar :: no description value +... ... geographicLocation :: no description value +... ... address :: no description value +... ... siteRelationship :: no description value + +... Common/Incident.schema.json +... ... Incident :: should be renamed as IncidentRef if this is a reference entity + +... Common/LocationCharacteristic.schema.json +... ... value :: no description value + +... Common/NetworkFunction.schema.json +... ... NetworkFunction :: should be renamed as NetworkFunctionRef if this is a reference entity + +... Common/Object.schema.json +... ... uri :: no description value + +... Common/Place.schema.json +... ... Place :: should be renamed as PlaceRef if this is a reference entity + +... Common/PlaceRef.schema.json +... ... PlaceRef :: no properties defined + +... Common/Receiver.schema.json +... ... party :: no description value + +... Common/Resolution.schema.json +... ... task :: no description value + +... Common/RetrieveGeographicLocation.schema.json +... ... requestedAccuracy :: no description value +... ... status :: no description value +... ... time :: no description value +... ... geographicLocation :: no description value +... ... thing :: no description value + +... Common/RetrieveLocationRelation.schema.json +... ... distance :: no description value +... ... status :: no description value +... ... time :: no description value +... ... intersection :: no description value +... ... location :: no description value + +... Common/Sender.schema.json +... ... party :: no description value + +... Common/SpecCharacteristic.schema.json +... ... specCharacteristicValue :: no description value +... ... specCharRelationship :: no description value + +... Common/Street.schema.json +... ... characteristic :: no description value +... ... address :: no description value + +... Common/StreetSegment.schema.json +... ... address :: no description value + +... Common/TicketRelationship.schema.json +... ... product :: no description value + +... Common/TroubleTicketRef.schema.json +... ... TroubleTicketRef :: no properties defined + +... Common/TroubleTicketRelationship.schema.json +... ... troubleTicket :: no description value + +... Common/Value.schema.json +... ... Value :: no properties defined + +... Common/WorkLog.schema.json +... ... lastUpdateDateTime :: recommend to add format +... ... lastUpdateDateTime :: recommend to add format +... ... record :: no description value + +... Customer/AppliedBillingRate.schema.json +... ... appliedTax :: no description value +... ... bill :: no description value +... ... characteristic :: no description value + +... Customer/AppliedCustomerBillingRate.schema.json +... ... appliedTax :: no description value +... ... bill :: no description value +... ... characteristic :: no description value + +... Customer/AppliedPartyBillingRate.schema.json +... ... appliedTax :: no description value +... ... bill :: no description value +... ... characteristic :: no description value + +... Customer/Appointment.schema.json +... ... attachment :: no description value +... ... contactMedium :: no description value +... ... note :: no description value +... ... relatedEntity :: no description value +... ... relatedParty :: no description value +... ... status :: no description value +... ... validFor :: no description value + +... Customer/Authorization.schema.json +... ... approver :: no description value + +... Customer/BalanceActivity.schema.json +... ... date :: recommend to add format +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceAdjustmentBody.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceAdjustmentRequest.schema.json +... ... requestedDate :: recommend to add format + +... Customer/BalanceDeduct.schema.json +... ... relatedParty :: no description value +... ... product :: no description value +... ... balanceReserve :: no description value +... ... requestor :: no description value +... ... partyAccount :: no description value + +... Customer/BalanceDeductRollback.schema.json +... ... relatedParty :: no description value +... ... product :: no description value +... ... partyAccount :: no description value +... ... balanceDeduct :: no description value +... ... requestor :: no description value + +... Customer/BalanceReserve.schema.json +... ... requestor :: no description value +... ... product :: no description value +... ... relatedParty :: no description value +... ... partyAccount :: no description value + +... Customer/BalanceTopupBody.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceTopupRequest.schema.json +... ... confirmationDate :: recommend to add format +... ... requestedDate :: recommend to add format + +... Customer/BalanceTopupStatusTypeModify.schema.json +... ... BalanceTopupStatusTypeModify :: should be renamed as BalanceTopupStatusTypeModifyRef if this is a reference entity + +... Customer/BalanceTransferBody.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceTransferRequest.schema.json +... ... confirmationDate :: recommend to add format +... ... requestedDate :: recommend to add format + +... Customer/BalanceTransferStatusTypeModify.schema.json +... ... BalanceTransferStatusTypeModify :: should be renamed as BalanceTransferStatusTypeModifyRef if this is a reference entity +... ... status :: no description value + +... Customer/BalanceUnreserve.schema.json +... ... balanceReserve :: no description value +... ... relatedParty :: no description value +... ... requestor :: no description value +... ... product :: no description value + +... Customer/BankCardMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/Bill.schema.json +... ... billingAccount :: no description value +... ... taxItem :: no description value +... ... paymentMethod :: no description value +... ... relatedParty :: no description value +... ... financialAccount :: no description value + +... Customer/BillFormat.schema.json +... ... BillFormat :: should be renamed as BillFormatRef if this is a reference entity + +... Customer/BillFormatRefOrValue.schema.json +... ... isRef :: no description value + +... Customer/BillPresentationMedia.schema.json +... ... BillPresentationMedia :: should be renamed as BillPresentationMediaRef if this is a reference entity + +... Customer/BillPresentationMediaRefOrValue.schema.json +... ... isRef :: no description value + +... Customer/BillStructure.schema.json +... ... presentationMedia :: no description value +... ... format :: no description value +... ... cycleSpecification :: no description value + +... Customer/BillingAccount.schema.json +... ... BillingAccount :: no properties defined + +... Customer/BillingCycleSpecification.schema.json +... ... billingDateShift :: recommend to add format +... ... chargeDateOffset :: recommend to add format +... ... creditDateOffset :: recommend to add format +... ... mailingDateOffset :: recommend to add format +... ... paymentDueDateOffset :: recommend to add format + +... Customer/BillingCycleSpecificationRef.schema.json +... ... dateShift :: recommend to add format + +... Customer/BillingCycleSpecificationRefOrValue.schema.json +... ... isRef :: no description value + +... Customer/CartItem.schema.json +... ... itemTerm :: no description value +... ... cartItem :: no description value +... ... note :: no description value +... ... ItemTotalPrice :: no description value +... ... product :: no description value +... ... itemPrice :: no description value +... ... productOffering :: no description value +... ... cartItemRelationship :: no description value + +... Customer/CartItemRelationship.schema.json +... ... cartItem :: no description value + +... Customer/CartPrice.schema.json +... ... price :: no description value +... ... priceAlteration :: no description value + +... Customer/CartTerm.schema.json +... ... description :: no description value +... ... duration :: no description value + +... Customer/CashDetails.schema.json +... ... CashDetails :: no properties defined + +... Customer/CashMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/CheckMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/Customer.schema.json +... ... engagedParty :: no description value +... ... roleType :: no description value +... ... account :: no description value +... ... paymentMethod :: no description value +... ... contactMedium :: no description value +... ... creditProfile :: no description value +... ... agreement :: no description value +... ... relatedParty :: no description value + +... Customer/CustomerBill.schema.json +... ... billingAccount :: no description value +... ... taxItem :: no description value +... ... paymentMethod :: no description value +... ... relatedParty :: no description value +... ... financialAccount :: no description value + +... Customer/DigitalWalletMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/Disability.schema.json +... ... validFor :: no description value + +... Customer/OrderItem.schema.json +... ... appointment :: no description value +... ... billingAccount :: no description value +... ... itemPrice :: no description value +... ... orderItem :: no description value +... ... orderItemRelationship :: no description value +... ... itemTotalPrice :: no description value +... ... payment :: no description value +... ... productOffering :: no description value +... ... product :: no description value +... ... qualification :: no description value +... ... itemTerm :: no description value + +... Customer/OrderItemPrice.schema.json +... ... productOfferingPrice :: no description value +... ... billingAccount :: no description value +... ... price :: no description value +... ... priceAlteration :: no description value + +... Customer/OrderItemRelationship.schema.json +... ... OrderItemRelationship :: should be renamed as OrderItemRelationshipRef if this is a reference entity + +... Customer/OrderRelationship.schema.json +... ... OrderRelationship :: should be renamed as OrderRelationshipRef if this is a reference entity + +... Customer/PaymentItem.schema.json +... ... payment :: no description value + +... Customer/PaymentMethod.schema.json +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/PaymentMethodRefOrValue.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/PaymentPlan.schema.json +... ... paymentMethod :: no description value + +... Customer/ProductOrder.schema.json +... ... billingAccount :: no description value +... ... channel :: no description value +... ... note :: no description value +... ... orderTotalPrice :: no description value +... ... payment :: no description value +... ... productOfferingQualification :: no description value +... ... quote :: no description value +... ... productOrderItem :: no description value +... ... relatedParty :: no description value + +... Customer/ProductOrderItem.schema.json +... ... appointment :: no description value +... ... billingAccount :: no description value +... ... itemPrice :: no description value +... ... itemTerm :: no description value +... ... itemTotalPrice :: no description value +... ... payment :: no description value +... ... product :: no description value +... ... productOffering :: no description value +... ... productOfferingQualificationItem :: no description value +... ... quoteItem :: no description value +... ... productOrderItem :: no description value +... ... productOrderItemRelationship :: no description value +... ... qualification :: no description value + +... Customer/ProductOrderRef.schema.json +... ... ProductOrderRef :: no properties defined + +... Customer/QuoteItem.schema.json +... ... product :: no description value +... ... productOffering :: no description value + +... Customer/QuoteItemRelationship.schema.json +... ... QuoteItemRelationship :: should be renamed as QuoteItemRelationshipRef if this is a reference entity + +... Customer/QuotePrice.schema.json +... ... priceAlteration :: no description value +... ... price :: no description value + +... Customer/QuoteRef.schema.json +... ... QuoteRef :: no properties defined + +... Customer/SearchTimeSlot.schema.json +... ... requestedTimeSlot :: no description value +... ... requestedTimeSlot :: recommend to add format +... ... availableTimeSlot :: no description value +... ... availableTimeSlot :: recommend to add format +... ... relatedEntity :: no description value + +... Customer/SettlementNoteAdvice.schema.json +... ... settlementMethod :: no description value +... ... settlementNoteImage :: no description value +... ... receiver :: no description value +... ... taxItem :: no description value +... ... issuer :: no description value +... ... settlementNoteItem :: no description value + +... Customer/SettlementNoteImage.schema.json +... ... imageFileURL :: recommend to add format + +... Customer/SettlementNoteItem.schema.json +... ... period :: no description value +... ... taxItem :: no description value + +... Customer/ShoppingCart.schema.json +... ... contactMedium :: no description value +... ... cartItem :: no description value +... ... relatedParty :: no description value + +... Customer/TokenizedCardMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/VoucherMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/Account.schema.json +... ... relatedParty :: no description value +... ... taxExemption :: no description value +... ... contact :: no description value +... ... accountBalance :: no description value +... ... accountRelationship :: no description value + +... EngagedParty/AccountDirectDetails.schema.json +... ... AccountDirectDetails :: should be renamed as AccountDirectDetailsRef if this is a reference entity +... ... account :: no description value + +... EngagedParty/AccountDirectMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/AccountRelationship.schema.json +... ... account :: no description value + +... EngagedParty/AccountTaxExemption.schema.json +... ... issuingJurisdiction :: recommend to add format + +... EngagedParty/Agreement.schema.json +... ... completionDate :: recommend to add format +... ... agreementSpecification :: no description value +... ... agreementItem :: no description value +... ... engagedPartyRole :: no description value +... ... agreementAuthorization :: no description value +... ... characteristic :: no description value +... ... associatedAgreement :: no description value + +... EngagedParty/AgreementItem.schema.json +... ... productOffering :: no description value +... ... termOrCondition :: no description value + +... EngagedParty/AgreementSpecCharacteristic.schema.json +... ... specCharacteristicValue :: no description value + +... EngagedParty/AgreementSpecification.schema.json +... ... serviceCategory :: no description value +... ... specificationCharacteristic :: no description value +... ... relatedParty :: no description value +... ... attachment :: no description value +... ... specificationRelationship :: no description value + +... EngagedParty/BankAccountDebitMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/BankAccountTransferMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/Contact.schema.json +... ... contactMedium :: no description value +... ... relatedParty :: no description value + +... EngagedParty/FinancialAccount.schema.json +... ... FinancialAccount :: no properties defined + +... EngagedParty/FinancialAccountRef.schema.json +... ... accountBalance :: no description value + +... EngagedParty/Individual.schema.json +... ... otherName :: no description value +... ... individualIdentification :: no description value +... ... disability :: no description value +... ... languageAbility :: no description value +... ... skill :: no description value + +... EngagedParty/IndividualIdentification.schema.json +... ... attachment :: no description value + +... EngagedParty/LanguageAbility.schema.json +... ... isFavouriteLanguage :: recommend to add format +... ... validFor :: no description value + +... EngagedParty/Organization.schema.json +... ... existsDuring :: no description value +... ... existsDuring :: recommend to add format +... ... otherName :: no description value +... ... organizationIdentification :: no description value +... ... organizationChildRelationship :: no description value +... ... organizationParentRelationship :: no description value + +... EngagedParty/OrganizationChildRelationship.schema.json +... ... organization :: no description value + +... EngagedParty/OrganizationIdentification.schema.json +... ... attachment :: no description value + +... EngagedParty/OrganizationParentRelationship.schema.json +... ... organization :: no description value + +... EngagedParty/OrganizationRef.schema.json +... ... OrganizationRef :: no properties defined + +... EngagedParty/OtherNameIndividual.schema.json +... ... validFor :: no description value + +... EngagedParty/OtherNameOrganization.schema.json +... ... validFor :: no description value + +... EngagedParty/PartnershipType.schema.json +... ... roleType :: no description value + +... EngagedParty/Party.schema.json +... ... externalReference :: no description value +... ... partyCharacteristic :: no description value +... ... taxExemptionCertificate :: no description value +... ... creditRating :: no description value +... ... relatedParty :: no description value +... ... contactMedium :: no description value + +... EngagedParty/PartyAccount.schema.json +... ... billStructure :: no description value +... ... paymentPlan :: no description value +... ... financialAccount :: no description value +... ... defaultPaymentMethod :: no description value + +... EngagedParty/PartyBill.schema.json +... ... billingAccount :: no description value +... ... taxItem :: no description value +... ... paymentMethod :: no description value +... ... relatedParty :: no description value +... ... financialAccount :: no description value + +... EngagedParty/PartyCreditProfile.schema.json +... ... validFor :: no description value + +... EngagedParty/PartyRef.schema.json +... ... PartyRef :: no properties defined + +... EngagedParty/RoleType.schema.json +... ... agreementSpecification :: no description value + +... EngagedParty/Rule.schema.json +... ... consequence :: no description value +... ... metric :: no description value +... ... operator :: no description value +... ... referenceValue :: no description value +... ... tolerance :: no description value +... ... unit :: no description value + +... EngagedParty/RuleRef.schema.json +... ... description :: no description value + +... EngagedParty/SLA.schema.json +... ... approvalDate :: no description value +... ... approved :: no description value +... ... rule :: no description value +... ... relatedParty :: no description value +... ... template :: no description value + +... EngagedParty/SLAViolation.schema.json +... ... date :: no description value +... ... relatedParty :: no description value +... ... violation :: no description value +... ... sla :: no description value + +... EngagedParty/SettlementAccount.schema.json +... ... SettlementAccount :: no properties defined + +... EngagedParty/Skill.schema.json +... ... validFor :: no description value + +... EngagedParty/TaxExemptionCertificate.schema.json +... ... taxDefinition :: no description value +... ... validFor :: no description value +... ... attachment :: no description value + +... EngagedParty/TemplateRef.schema.json +... ... description :: no description value + +... EngagedParty/Violation.schema.json +... ... actualValue :: no description value +... ... comment :: no description value +... ... consequence :: no description value +... ... operator :: no description value +... ... referenceValue :: no description value +... ... tolerance :: no description value +... ... unit :: no description value +... ... violationAverage :: no description value +... ... attachment :: no description value +... ... rule :: no description value + +... MarketingSales/MarketingCampaignRef.schema.json +... ... MarketingCampaignRef :: no properties defined + +... MarketingSales/SalesOpportunityRef.schema.json +... ... SalesOpportunityRef :: no properties defined + +... Product/BundledProductOfferingPriceRelationship.schema.json +... ... BundledProductOfferingPriceRelationship :: should be renamed as BundledProductOfferingPriceRelationshipRef if this is a reference entity + +... Product/BundledProductSpecification.schema.json +... ... BundledProductSpecification :: should be renamed as BundledProductSpecificationRef if this is a reference entity + +... Product/LoyaltyAccount.schema.json +... ... LoyaltyAccount :: should be renamed as LoyaltyAccountRef if this is a reference entity +... ... loyaltyProgramProduct :: no description value + +... Product/LoyaltyAction.schema.json +... ... type :: rename to avoid conflict with @type + +... Product/LoyaltyEvent.schema.json +... ... eventId :: no description value +... ... eventTime :: recommend to add format + +... Product/LoyaltyEventType.schema.json +... ... LoyaltyEventType :: should be renamed as LoyaltyEventTypeRef if this is a reference entity + +... Product/LoyaltyProgramProduct.schema.json +... ... loyaltyProgramProductSpec :: no description value +... ... loyaltyAccount :: no description value +... ... validFor :: no description value + +... Product/LoyaltyProgramProductSpec.schema.json +... ... productNumber :: no description value +... ... ValidFor :: no description value + +... Product/LoyaltyRuleAction.schema.json +... ... LoyaltyRuleAction :: should be renamed as LoyaltyRuleActionRef if this is a reference entity + +... Product/LoyaltyRuleCondition.schema.json +... ... LoyaltyRuleCondition :: should be renamed as LoyaltyRuleConditionRef if this is a reference entity + +... Product/LoyaltyRuleEventType.schema.json +... ... LoyaltyRuleEventType :: should be renamed as LoyaltyRuleEventTypeRef if this is a reference entity + +... Product/PriceAlteration.schema.json +... ... productOfferingPrice :: no description value +... ... price :: no description value + +... Product/Product.schema.json +... ... agreement :: no description value +... ... billingAccount :: no description value +... ... productCharacteristic :: no description value +... ... productOffering :: no description value +... ... productOrderItem :: no description value +... ... product :: no description value +... ... productPrice :: no description value +... ... productRelationship :: no description value +... ... productSpecification :: no description value +... ... productTerm :: no description value +... ... realizingResource :: no description value +... ... realizingService :: no description value +... ... relatedParty :: no description value +... ... place :: no description value + +... Product/ProductInventoryRelationship.schema.json +... ... product :: no description value + +... Product/ProductOffering.schema.json +... ... serviceCandidate :: recommend to add format +... ... resourceCandidate :: recommend to add format + +... Product/ProductOfferingPriceRef.schema.json +... ... ProductOfferingPriceRef :: no properties defined + +... Product/ProductOfferingPriceRelationship.schema.json +... ... ProductOfferingPriceRelationship :: should be renamed as ProductOfferingPriceRelationshipRef if this is a reference entity + +... Product/ProductOfferingQualificationItem.schema.json +... ... eligibilityUnavailabilityReason :: no description value +... ... category :: no description value +... ... qualificationItemRelationship :: no description value +... ... note :: no description value +... ... product :: no description value +... ... terminationError :: no description value +... ... productOffering :: no description value +... ... alternateProductOfferingProposal :: no description value + +... Product/ProductOfferingQualificationRef.schema.json +... ... ProductOfferingQualificationRef :: no properties defined + +... Product/ProductOfferingRef.schema.json +... ... ProductOfferingRef :: no properties defined + +... Product/ProductPrice.schema.json +... ... productOfferingPrice :: no description value +... ... billingAccount :: no description value +... ... productPriceAlteration :: no description value +... ... price :: no description value + +... Product/ProductRef.schema.json +... ... ProductRef :: no properties defined + +... Product/ProductRefOrValue.schema.json +... ... ProductRefOrValue :: no properties defined + +... Product/ProductRelationship.schema.json +... ... product :: no description value + +... Product/ProductRequest.schema.json +... ... referredProduct :: no description value +... ... realizingService :: no description value +... ... billingAccount :: no description value +... ... productOffering :: no description value +... ... agreement :: no description value +... ... characteristic :: no description value +... ... productRelationship :: no description value +... ... realizingResource :: no description value +... ... relatedParty :: no description value +... ... productPrice :: no description value +... ... productSpecification :: no description value +... ... place :: no description value + +... Product/ProductRestriction.schema.json +... ... productCharacteristic :: no description value +... ... productRelationship :: no description value +... ... relatedParty :: no description value +... ... productSpecification :: no description value +... ... relatedPlace :: no description value + +... Product/ProductSpecCharacteristic.schema.json +... ... productSpecCharRelationship :: no description value +... ... productSpecCharacteristicValue :: no description value + +... Product/Promotion.schema.json +... ... pattern :: no description value + +... Product/PromotionCriteriaGroup.schema.json +... ... criteria :: no description value + +... Product/PromotionPattern.schema.json +... ... action :: no description value +... ... criteriaGroup :: no description value + +... Product/QualificationItemRelationship.schema.json +... ... QualificationItemRelationship :: should be renamed as QualificationItemRelationshipRef if this is a reference entity + +... Product/Recommendation.schema.json +... ... description :: no description value +... ... order :: no description value +... ... channel :: no description value +... ... party :: no description value +... ... item :: no description value + +... Product/Usage.schema.json +... ... usageSpecification :: no description value +... ... usageCharacteristic :: no description value +... ... relatedParty :: no description value +... ... ratedProductUsage :: no description value + +... Product/UsageConsumptionReport.schema.json +... ... relatedParty :: no description value + +... Product/UsageSpecCharacteristic.schema.json +... ... usageSpecCharacteristicValue :: no description value + +... Product/UsageSpecification.schema.json +... ... usageSpecCharacteristic :: no description value + +... Product/UsageVolumeProduct.schema.json +... ... bucketBalance :: no description value +... ... bucketCounter :: no description value +... ... product :: no description value + +... Resource/LogicalResource.schema.json +... ... resourceRelationship :: no description value +... ... characteristic :: no description value +... ... place :: no description value +... ... partyRole :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/PhysicalResource.schema.json +... ... resourceRelationship :: no description value +... ... characteristic :: no description value +... ... place :: no description value +... ... partyRole :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/RealizingResourceRef.schema.json +... ... RealizingResourceRef :: no properties defined + +... Resource/Resource.schema.json +... ... resourceRelationship :: no description value +... ... characteristic :: no description value +... ... place :: no description value +... ... partyRole :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/ResourceAlarmRef.schema.json +... ... changeRequest :: no description value + +... Resource/ResourceOrder.schema.json +... ... orderRelationship :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/ResourceOrderItem.schema.json +... ... resourceSpecification :: no description value +... ... orderItemRelationship :: no description value + +... Resource/ResourceOrderItemRelationship.schema.json +... ... orderItem :: no description value + +... Resource/ResourceOrderRelationship.schema.json +... ... resourceOrder :: no description value +... ... serviceOrder :: no description value + +... Resource/SupportingResource.schema.json +... ... SupportingResource :: should be renamed as SupportingResourceRef if this is a reference entity + +... Service/FirstAlert.schema.json +... ... FirstAlert :: should be renamed as FirstAlertRef if this is a reference entity + +... Service/Service.schema.json +... ... serviceDate :: recommend to add format + +... Service/ServiceCategory.schema.json +... ... serviceCandidate :: recommend to add format + +... Service/ServiceLevelObjective.schema.json +... ... graceTimes :: recommend to add format + +... Service/ServiceOrder.schema.json +... ... orderDate :: no description value + +... Service/ServiceOrderItemRelationship.schema.json +... ... ServiceOrderItemRelationship :: should be renamed as ServiceOrderItemRelationshipRef if this is a reference entity + +... Service/ServiceQualificationItemRelationship.schema.json +... ... ServiceQualificationItemRelationship :: should be renamed as ServiceQualificationItemRelationshipRef if this is a reference entity + +... Service/ServiceQualificationRelationship.schema.json +... ... ServiceQualificationRelationship :: should be renamed as ServiceQualificationRelationshipRef if this is a reference entity + +... Service/ServiceRef.schema.json +... ... ServiceRef :: no properties defined + +... Service/SupportingService.schema.json +... ... SupportingService :: should be renamed as SupportingServiceRef if this is a reference entity + +... Common/RelatedGeographicAddressRefOrValue.schema.json +... ... isRef :: no description value +... ... role :: no description value + +... Common/RelatedGeographicLocationRefOrValue.schema.json +... ... isRef :: no description value +... ... role :: no description value + +... Common/RelatedPlaceRefOrValue.schema.json +... ... role :: no description value + +... Customer/BalanceTopupStatus.schema.json +... ... BalanceTopupStatus :: should be renamed as BalanceTopupStatusRef if this is a reference entity +... ... statusChangeDate :: recommend to add format + +... EngagedParty/PartyRole.schema.json +... ... engagedParty :: no description value +... ... roleType :: no description value +... ... account :: no description value +... ... paymentMethod :: no description value +... ... contactMedium :: no description value +... ... creditProfile :: no description value +... ... agreement :: no description value +... ... relatedParty :: no description value + +... EngagedParty/RelatedPartyRefOrValue.schema.json +... ... isRef :: no description value +... ... role :: no description value + +... MarketingSales/SalesLead.schema.json +... ... status :: no description value +... ... type :: rename to avoid conflict with @type +... ... priority :: no description value +... ... channel :: no description value +... ... productOffering :: no description value +... ... relatedParty :: no description value +... ... prospectContact :: no description value +... ... productSpecification :: no description value +... ... category :: no description value +... ... salesOpportunity :: no description value +... ... product :: no description value +... ... note :: no description value + +... Product/BaseProductRefOrValue.schema.json +... ... productCharacteristic :: no description value +... ... realizingResource :: no description value +... ... realizingService :: no description value +... ... productRelationship :: no description value +... ... relatedParty :: no description value +... ... productSpecification :: no description value +... ... relatedPlace :: no description value + +... Product/CancelProductOrder.schema.json +... ... CancelProductOrder :: should be renamed as CancelProductOrderRef if this is a reference entity +... ... productOrder :: no description value + +... Product/LoyaltyExecutionPoint.schema.json +... ... Failing to check for issues: TypeError: Cannot read property 'properties' of undefined + +... Service/AlternateServiceProposal.schema.json +... ... alternateService :: no description value + +error: TypeError: fd must be a file descriptor From 3a1ceee8a9c4404fab6eb33019cb3a55b5339150 Mon Sep 17 00:00:00 2001 From: Test results Date: Fri, 1 Nov 2019 07:52:29 +0100 Subject: [PATCH 10/11] Updated - with explicit domain --- Common/Address.schema.json | 136 +++--- Common/AddressRef.schema.json | 26 +- Common/AlternateGeographicAddress.schema.json | 176 +++---- Common/Any.schema.json | 17 +- Common/Area.schema.json | 70 +-- Common/Association.schema.json | 128 +++--- Common/AssociationRole.schema.json | 72 +-- Common/AssociationRoleSpec.schema.json | 80 ++-- Common/AssociationSpecRef.schema.json | 56 +-- Common/AssociationSpecification.schema.json | 116 ++--- Common/Attachment.schema.json | 154 +++---- Common/AttachmentRef.schema.json | 76 +-- Common/AttachmentRefOrValue.schema.json | 81 +++- Common/BaseEvent.schema.json | 124 ++--- Common/BasePlusEvent.schema.json | 116 ++--- Common/BusinessInteraction.schema.json | 68 +-- Common/CalendarEventRef.schema.json | 30 +- Common/CalendarPeriod.schema.json | 66 +-- Common/ChangeRequest.schema.json | 364 +++++++-------- .../ChangeRequestCharacteristic.schema.json | 48 +- Common/ChangeRequestRef.schema.json | 56 +-- Common/ChangeRequestSpecification.schema.json | 70 +-- Common/Channel.schema.json | 56 +-- Common/ChannelRef.schema.json | 40 +- Common/Characteristic.schema.json | 64 +-- Common/CommonComponents.schema.json | 82 ++-- Common/CommunicationMessage.schema.json | 188 ++++---- ...unicationRequestCharacteristic.schema.json | 48 +- Common/ConstraintRef.schema.json | 72 +-- Common/ContactMedium.schema.json | 64 +-- Common/ContentType.schema.json | 30 ++ Common/Document.schema.json | 188 ++++---- Common/DocumentAttachment.schema.json | 106 ++--- Common/DocumentCharacteristic.schema.json | 46 +- Common/DocumentRef.schema.json | 54 +-- Common/DocumentRelationship.schema.json | 46 +- Common/DocumentSpecification.schema.json | 74 +-- Common/Duration.schema.json | 38 +- Common/Entity.schema.json | 84 ++-- Common/EntityAttachment.schema.json | 90 ++-- Common/EntityCatalog.schema.json | 98 ++-- Common/EntityCatalogItem.schema.json | 98 ++-- Common/EntityCatalogItemRef.schema.json | 72 +-- Common/EntityCategory.schema.json | 114 ++--- Common/EntityRef.schema.json | 64 +-- Common/EntitySchemaRef.schema.json | 40 +- Common/EntitySpecRelationship.schema.json | 86 ++-- Common/EntitySpecification.schema.json | 140 +++--- Common/EntitySpecificationRef.schema.json | 72 +-- Common/Error.schema.json | 122 ++--- Common/Event.schema.json | 61 +++ Common/EventRef.schema.json | 74 +-- Common/ExportJob.schema.json | 118 ++--- Common/ExternalReference.schema.json | 48 +- Common/FileDocument.schema.json | 74 +-- Common/FloatCharacteristic.schema.json | 48 +- Common/GeographicAddress.schema.json | 146 +++--- Common/GeographicAddressRef.schema.json | 56 +-- .../GeographicAddressValidation.schema.json | 100 ++-- Common/GeographicLocation.schema.json | 64 +-- Common/GeographicLocationRef.schema.json | 28 +- Common/GeographicPoint.schema.json | 56 +-- Common/GeographicSite.schema.json | 134 +++--- Common/GeographicSiteRef.schema.json | 50 +- Common/GeographicSubAddress.schema.json | 120 ++--- Common/HeaderItem.schema.json | 46 +- Common/HourPeriod.schema.json | 46 +- Common/Hub.schema.json | 86 ++-- Common/ImpactEntityRef.schema.json | 64 +-- Common/ImportJob.schema.json | 110 ++--- Common/Incident.schema.json | 48 +- Common/IntegerCharacteristic.schema.json | 46 +- Common/JobStateType.schema.json | 32 +- Common/LocationCharacteristic.schema.json | 44 +- Common/MediumCharacteristic.schema.json | 120 ++--- Common/Money.schema.json | 50 +- Common/Monitor.schema.json | 80 ++-- Common/NetworkFunction.schema.json | 32 +- Common/Note.schema.json | 66 +-- Common/Notification.schema.json | 74 +-- Common/Object.schema.json | 46 +- Common/ObjectCharacteristic.schema.json | 46 +- Common/Place.schema.json | 56 +-- Common/PlaceRef.schema.json | 30 +- Common/ProcessFlow.schema.json | 142 +++--- Common/ProcessFlowRef.schema.json | 40 +- Common/ProcessFlowStateType.schema.json | 32 +- Common/QualificationRef.schema.json | 40 +- Common/Quantity.schema.json | 42 +- Common/QuantityType.schema.json | 48 +- Common/RatedProductUsage.schema.json | 138 +++--- Common/Receiver.schema.json | 86 ++-- Common/ReceiverRef.schema.json | 56 +-- Common/Record.schema.json | 58 +-- Common/RelatedChangeRequestRef.schema.json | 72 +-- Common/RelatedChannel.schema.json | 48 +- Common/RelatedEntity.schema.json | 50 +- Common/RelatedEntityRef.schema.json | 64 +-- ...tedGeographicAddressRefOrValue.schema.json | 54 +-- ...edGeographicLocationRefOrValue.schema.json | 54 +-- Common/RelatedObject.schema.json | 48 +- Common/RelatedPlace.schema.json | 64 +-- Common/RelatedPlaceRefOrValue.schema.json | 51 +-- Common/Request.schema.json | 70 +-- Common/Resolution.schema.json | 68 +-- Common/Response.schema.json | 62 +-- Common/RetrieveGeographicLocation.schema.json | 76 +-- Common/RetrieveLocationRelation.schema.json | 80 ++-- Common/Sender.schema.json | 70 +-- Common/SiteRelationship.schema.json | 70 +-- Common/SpecCharRelationship.schema.json | 72 +-- Common/SpecCharacteristic.schema.json | 96 ++-- Common/SpecCharacteristicValue.schema.json | 104 ++--- Common/StatusChange.schema.json | 58 +-- Common/Street.schema.json | 80 ++-- Common/StreetSegment.schema.json | 78 ++-- Common/StringCharacteristic.schema.json | 46 +- Common/SubAddress.schema.json | 118 ++--- Common/TargetEntityRef.schema.json | 64 +-- Common/Task.schema.json | 56 +-- Common/TaskFlow.schema.json | 160 ++++--- Common/TaskFlowRef.schema.json | 54 +-- Common/TaskFlowRelationship.schema.json | 46 +- Common/TaskFlowStateType.schema.json | 34 +- Common/TaskStateType.schema.json | 32 +- Common/TaxDefinition.schema.json | 64 +-- Common/Ticket.schema.json | 186 ++++---- Common/TicketRelationship.schema.json | 46 +- Common/TimePeriod.schema.json | 68 +-- Common/TimePeriodType.schema.json | 48 +- Common/Topic.schema.json | 39 ++ Common/TroubleTicket.schema.json | 264 +++++------ Common/TroubleTicketRef.schema.json | 30 +- Common/TroubleTicketRelationship.schema.json | 46 +- Common/TroubleTicketStatusType.schema.json | 40 +- Common/Value.schema.json | 28 +- Common/WorkLog.schema.json | 70 +-- Customer/AccumulatedBalance.schema.json | 114 ++--- Customer/AppliedBillingRate.schema.json | 128 +++--- ...pliedBillingRateCharacteristic.schema.json | 48 +- Customer/AppliedBillingTaxRate.schema.json | 58 +-- .../AppliedCustomerBillingRate.schema.json | 128 +++--- Customer/AppliedPartyBillingRate.schema.json | 128 +++--- Customer/Appointment.schema.json | 186 ++++---- Customer/AppointmentRef.schema.json | 64 +-- Customer/AppointmentStateType.schema.json | 34 +- Customer/AppointmentStateValues.schema.json | 34 +- Customer/Authorization.schema.json | 88 ++-- Customer/BalanceActionRequestRef.schema.json | 46 +- Customer/BalanceActivity.schema.json | 124 ++--- Customer/BalanceAdjustment.schema.json | 20 +- Customer/BalanceAdjustmentBody.schema.json | 62 +-- Customer/BalanceAdjustmentRequest.schema.json | 122 ++--- Customer/BalanceDeduct.schema.json | 122 ++--- Customer/BalanceDeductRef.schema.json | 56 +-- Customer/BalanceDeductRollback.schema.json | 104 ++--- Customer/BalanceReserve.schema.json | 152 +++--- Customer/BalanceReserveRef.schema.json | 56 +-- Customer/BalanceTopup.schema.json | 20 +- Customer/BalanceTopupBody.schema.json | 62 +-- Customer/BalanceTopupRequest.schema.json | 192 ++++---- Customer/BalanceTopupStatus.schema.json | 44 +- .../BalanceTopupStatusTypeModify.schema.json | 34 +- Customer/BalanceTransfer.schema.json | 20 +- Customer/BalanceTransferBody.schema.json | 72 +-- Customer/BalanceTransferRequest.schema.json | 194 ++++---- ...alanceTransferStatusTypeModify.schema.json | 32 +- Customer/BalanceUnreserve.schema.json | 98 ++-- Customer/BankCardDetails.schema.json | 98 ++-- Customer/BankCardMethod.schema.json | 116 ++--- Customer/Bill.schema.json | 230 +++++----- Customer/BillFormat.schema.json | 70 +-- Customer/BillFormatRef.schema.json | 64 +-- Customer/BillFormatRefOrValue.schema.json | 56 +-- Customer/BillPresentationMedia.schema.json | 70 +-- Customer/BillPresentationMediaRef.schema.json | 64 +-- ...illPresentationMediaRefOrValue.schema.json | 56 +-- Customer/BillRef.schema.json | 64 +-- Customer/BillStructure.schema.json | 56 +-- Customer/BillingAccount.schema.json | 38 +- Customer/BillingAccountRef.schema.json | 64 +-- .../BillingCycleSpecification.schema.json | 134 +++--- .../BillingCycleSpecificationRef.schema.json | 80 ++-- ...ngCycleSpecificationRefOrValue.schema.json | 56 +-- Customer/Bucket.schema.json | 28 +- Customer/BucketBalance.schema.json | 160 +++---- Customer/BucketBalanceRef.schema.json | 46 +- Customer/CartItem.schema.json | 148 +++--- Customer/CartItemActionType.schema.json | 32 +- Customer/CartItemRef.schema.json | 48 +- Customer/CartItemRelationship.schema.json | 60 +-- Customer/CartItemStatusType.schema.json | 28 +- Customer/CartPrice.schema.json | 98 ++-- Customer/CartTerm.schema.json | 48 +- Customer/CashDetails.schema.json | 30 +- Customer/CashMethod.schema.json | 116 ++--- Customer/CheckDetails.schema.json | 74 +-- Customer/CheckMethod.schema.json | 116 ++--- Customer/CreditProfile.schema.json | 66 +-- Customer/Customer.schema.json | 173 ++++--- Customer/CustomerBill.schema.json | 228 ++++----- Customer/DigitalWalletDetails.schema.json | 58 +-- Customer/DigitalWalletMethod.schema.json | 116 ++--- Customer/Disability.schema.json | 54 +-- Customer/OrderItem.schema.json | 172 +++---- Customer/OrderItemActionType.schema.json | 32 +- Customer/OrderItemPrice.schema.json | 110 ++--- Customer/OrderItemRelationship.schema.json | 44 +- Customer/OrderPrice.schema.json | 110 ++--- Customer/OrderRelationship.schema.json | 50 +- Customer/OrderTerm.schema.json | 56 +-- Customer/PaymentItem.schema.json | 46 +- Customer/PaymentMethod.schema.json | 112 ++--- Customer/PaymentMethodRef.schema.json | 64 +-- Customer/PaymentMethodRefOrValue.schema.json | 70 +-- Customer/PaymentPlan.schema.json | 94 ++-- Customer/PaymentRef.schema.json | 40 +- Customer/Price.schema.json | 68 +-- Customer/ProductOrder.schema.json | 288 ++++++------ Customer/ProductOrderItem.schema.json | 184 ++++---- .../ProductOrderItemStateType.schema.json | 44 +- Customer/ProductOrderRef.schema.json | 30 +- Customer/ProductOrderStateType.schema.json | 46 +- .../QueryProductRecommendation.schema.json | 77 ++++ Customer/Quote.schema.json | 288 ++++++------ Customer/QuoteItem.schema.json | 196 ++++---- Customer/QuoteItemRef.schema.json | 72 +-- Customer/QuoteItemRelationship.schema.json | 48 +- Customer/QuotePrice.schema.json | 98 ++-- Customer/QuoteRef.schema.json | 30 +- Customer/SearchTimeSlot.schema.json | 126 ++--- Customer/SearchTimeSlotStateType.schema.json | 18 + Customer/SettlementMethod.schema.json | 48 +- Customer/SettlementNoteAdvice.schema.json | 178 ++++---- Customer/SettlementNoteImage.schema.json | 64 +-- Customer/SettlementNoteItem.schema.json | 112 ++--- Customer/ShoppingCart.schema.json | 106 ++--- Customer/ShoppingCartRef.schema.json | 56 +-- Customer/TaxItem.schema.json | 58 +-- Customer/TimeSlot.schema.json | 62 +-- Customer/TokenizedCardDetails.schema.json | 80 ++-- Customer/TokenizedCardMethod.schema.json | 116 ++--- Customer/VoucherDetails.schema.json | 68 +-- Customer/VoucherMethod.schema.json | 116 ++--- EngagedParty/Account.schema.json | 164 +++---- EngagedParty/AccountBalance.schema.json | 66 +-- EngagedParty/AccountBalanceRef.schema.json | 64 +-- EngagedParty/AccountDirectDetails.schema.json | 36 +- EngagedParty/AccountDirectMethod.schema.json | 118 ++--- EngagedParty/AccountRef.schema.json | 72 +-- EngagedParty/AccountRelationship.schema.json | 60 +-- EngagedParty/AccountTaxExemption.schema.json | 72 +-- EngagedParty/Agreement.schema.json | 210 ++++----- EngagedParty/AgreementAttachment.schema.json | 66 +-- .../AgreementAuthorization.schema.json | 58 +-- EngagedParty/AgreementItem.schema.json | 64 +-- EngagedParty/AgreementItemRef.schema.json | 40 +- EngagedParty/AgreementRef.schema.json | 40 +- .../AgreementSpecCharacteristic.schema.json | 84 ++-- ...reementSpecCharacteristicValue.schema.json | 88 ++-- .../AgreementSpecification.schema.json | 168 +++---- .../AgreementSpecificationRef.schema.json | 48 +- ...ementSpecificationRelationship.schema.json | 48 +- .../AgreementTermOrCondition.schema.json | 56 +-- EngagedParty/BankAccount.schema.json | 64 +-- .../BankAccountDebitDetails.schema.json | 72 +-- .../BankAccountDebitMethod.schema.json | 116 ++--- .../BankAccountTransferDetails.schema.json | 72 +-- .../BankAccountTransferMethod.schema.json | 116 ++--- EngagedParty/Contact.schema.json | 88 ++-- EngagedParty/FinancialAccount.schema.json | 36 +- EngagedParty/FinancialAccountRef.schema.json | 70 +-- EngagedParty/Individual.schema.json | 268 +++++------ .../IndividualIdentification.schema.json | 80 ++-- EngagedParty/IndividualStateType.schema.json | 30 +- EngagedParty/IssuerRef.schema.json | 56 +-- EngagedParty/LanguageAbility.schema.json | 94 ++-- EngagedParty/Organization.schema.json | 148 +++--- .../OrganizationChildRelationship.schema.json | 46 +- .../OrganizationIdentification.schema.json | 80 ++-- ...OrganizationParentRelationship.schema.json | 46 +- EngagedParty/OrganizationRef.schema.json | 28 +- .../OrganizationStateType.schema.json | 30 +- EngagedParty/OtherName.schema.json | 104 ++--- EngagedParty/OtherNameIndividual.schema.json | 126 ++--- .../OtherNameOrganization.schema.json | 62 +-- EngagedParty/Partner.schema.json | 94 ++++ EngagedParty/Partnership.schema.json | 50 ++ EngagedParty/PartnershipRef.schema.json | 35 ++ .../PartnershipSpecification.schema.json | 45 ++ .../PartnershipSpecificationRef.schema.json | 35 ++ EngagedParty/PartnershipType.schema.json | 82 ++-- EngagedParty/PartnershipTypeRef.schema.json | 64 +-- EngagedParty/Party.schema.json | 120 ++--- EngagedParty/PartyAccount.schema.json | 78 ++-- EngagedParty/PartyAccountRef.schema.json | 80 ++-- EngagedParty/PartyBill.schema.json | 228 ++++----- EngagedParty/PartyCreditProfile.schema.json | 72 +-- EngagedParty/PartyOrPartyRoleRef.schema.json | 72 +-- EngagedParty/PartyRef.schema.json | 34 +- EngagedParty/PartyRole.schema.json | 183 ++++---- EngagedParty/PartyRoleRef.schema.json | 80 ++-- EngagedParty/RelatedParty.schema.json | 56 +-- EngagedParty/RelatedPartyRef.schema.json | 72 +-- .../RelatedPartyRefOrValue.schema.json | 54 +-- EngagedParty/RoleSpecification.schema.json | 44 ++ EngagedParty/RoleType.schema.json | 82 ++-- EngagedParty/RoleTypeRef.schema.json | 72 +-- EngagedParty/Rule.schema.json | 72 +-- EngagedParty/RuleRef.schema.json | 62 +-- EngagedParty/SLA.schema.json | 132 +++--- EngagedParty/SLARef.schema.json | 64 +-- EngagedParty/SLAViolation.schema.json | 74 +-- EngagedParty/SLAViolationRef.schema.json | 50 +- EngagedParty/SettlementAccount.schema.json | 38 +- EngagedParty/Skill.schema.json | 70 +-- .../TaxExemptionCertificate.schema.json | 64 +-- EngagedParty/TemplateRef.schema.json | 62 +-- EngagedParty/Violation.schema.json | 90 ++-- MarketingSales/MarketSegmentRef.schema.json | 64 +-- .../MarketingCampaignRef.schema.json | 30 +- MarketingSales/SalesLead.schema.json | 234 +++++----- .../SalesLeadPriorityType.schema.json | 17 + MarketingSales/SalesLeadStateType.schema.json | 20 + .../SalesOpportunityRef.schema.json | 30 +- Product/AlternateProduct.schema.json | 51 +++ ...ternateProductOfferingProposal.schema.json | 66 +-- Product/BaseProductRefOrValue.schema.json | 152 +++--- Product/BundledProductOffering.schema.json | 72 +-- .../BundledProductOfferingOption.schema.json | 56 +-- ...oductOfferingPriceRelationship.schema.json | 56 +-- Product/BundledProductOfferingRef.schema.json | 64 +-- .../BundledProductSpecification.schema.json | 64 +-- Product/CancelOrder.schema.json | 84 ++-- Product/CancelProductOrder.schema.json | 44 +- Product/Catalog.schema.json | 134 +++--- Product/Category.schema.json | 142 +++--- Product/CategoryRef.schema.json | 40 +- Product/ConsumptionSummary.schema.json | 88 ++-- ...ligibilityUnavailabilityReason.schema.json | 48 +- Product/LoyaltyAccount.schema.json | 44 +- Product/LoyaltyAccountRef.schema.json | 38 +- Product/LoyaltyAction.schema.json | 140 +++--- Product/LoyaltyActionRef.schema.json | 38 +- Product/LoyaltyBalance.schema.json | 68 +-- Product/LoyaltyCondition.schema.json | 62 +-- Product/LoyaltyConditionRef.schema.json | 38 +- Product/LoyaltyEvent.schema.json | 62 +-- Product/LoyaltyEventType.schema.json | 46 +- Product/LoyaltyEventTypeRef.schema.json | 38 +- Product/LoyaltyExecutionPoint.schema.json | 152 +++--- Product/LoyaltyProgramMember.schema.json | 72 +-- Product/LoyaltyProgramMemberRef.schema.json | 48 +- Product/LoyaltyProgramProduct.schema.json | 108 ++--- Product/LoyaltyProgramProductRef.schema.json | 48 +- Product/LoyaltyProgramProductSpec.schema.json | 92 ++-- .../LoyaltyProgramProductSpecRef.schema.json | 38 +- Product/LoyaltyRule.schema.json | 144 +++--- Product/LoyaltyRuleAction.schema.json | 38 +- Product/LoyaltyRuleCondition.schema.json | 38 +- Product/LoyaltyRuleEventType.schema.json | 38 +- Product/NetworkProduct.schema.json | 92 ++-- Product/NetworkProductRef.schema.json | 72 +-- Product/OrderStateType.schema.json | 46 +- Product/PriceAlteration.schema.json | 108 ++--- Product/PricingLogicAlgorithm.schema.json | 80 ++-- Product/Product.schema.json | 276 +++++------ Product/ProductActionType.schema.json | 32 +- Product/ProductCharacteristic.schema.json | 48 +- .../ProductInventoryRelationship.schema.json | 54 +-- Product/ProductOffering.schema.json | 294 ++++++------ Product/ProductOfferingPrice.schema.json | 292 ++++++------ Product/ProductOfferingPriceRef.schema.json | 30 +- ...oductOfferingPriceRelationship.schema.json | 64 +-- .../ProductOfferingQualification.schema.json | 217 ++++----- ...oductOfferingQualificationItem.schema.json | 147 +++--- ...ctOfferingQualificationItemRef.schema.json | 80 ++-- ...roductOfferingQualificationRef.schema.json | 30 +- ...OfferingQualificationStateType.schema.json | 32 +- Product/ProductOfferingRef.schema.json | 30 +- Product/ProductOfferingTerm.schema.json | 64 +-- Product/ProductPrice.schema.json | 110 ++--- Product/ProductRef.schema.json | 28 +- Product/ProductRefOrValue.schema.json | 36 +- Product/ProductRelationship.schema.json | 54 +-- Product/ProductRequest.schema.json | 250 +++++----- Product/ProductRestriction.schema.json | 110 ++--- .../ProductSpecCharRelationship.schema.json | 48 +- Product/ProductSpecCharacteristic.schema.json | 96 ++-- ...ProductSpecCharacteristicValue.schema.json | 88 ++-- Product/ProductSpecification.schema.json | 228 ++++----- ...uctSpecificationCharacteristic.schema.json | 140 +++--- ...tionCharacteristicRelationship.schema.json | 80 ++-- ...ecificationCharacteristicValue.schema.json | 104 ++--- ...ficationCharacteristicValueUse.schema.json | 92 ++-- Product/ProductSpecificationRef.schema.json | 48 +- ...oductSpecificationRelationship.schema.json | 64 +-- .../ProductSpecificationSchemaRef.schema.json | 40 +- Product/ProductStatusType.schema.json | 40 +- Product/ProductTerm.schema.json | 64 +-- Product/Promotion.schema.json | 110 ++--- Product/PromotionAction.schema.json | 66 +-- Product/PromotionCriteria.schema.json | 64 +-- Product/PromotionCriteriaGroup.schema.json | 68 +-- Product/PromotionPattern.schema.json | 104 ++--- .../QualificationItemRelationship.schema.json | 48 +- Product/QuoteItemStateType.schema.json | 32 +- Product/QuoteStateType.schema.json | 36 +- Product/QuoteTerm.schema.json | 56 +-- Product/Recommendation.schema.json | 132 +++--- Product/RecommendationItem.schema.json | 48 +- Product/RelatedProductOrderItem.schema.json | 88 ++-- Product/TargetProductSchema.schema.json | 48 +- Product/Usage.schema.json | 124 ++--- Product/UsageCharacteristic.schema.json | 48 +- Product/UsageConsumptionReport.schema.json | 94 ++-- Product/UsageConsumptionReportRef.schema.json | 74 +-- .../UsageConsumptionReportRequest.schema.json | 118 ++--- ...sageConsumptionReportRequestIn.schema.json | 76 +-- Product/UsageSpecCharacteristic.schema.json | 68 +-- .../UsageSpecCharacteristicValue.schema.json | 72 +-- Product/UsageSpecification.schema.json | 84 ++-- Product/UsageSpecificationRef.schema.json | 64 +-- Product/UsageVolumeBalance.schema.json | 56 +-- Product/UsageVolumeProduct.schema.json | 100 ++-- Product/UsageVolumeProductRef.schema.json | 56 +-- Resource/LogicalResource.schema.json | 182 ++++---- Resource/PhysicalResource.schema.json | 208 ++++----- Resource/RealizingResourceRef.schema.json | 30 +- Resource/Resource.schema.json | 174 +++---- Resource/ResourceAlarmRef.schema.json | 62 +-- Resource/ResourceCandidateRef.schema.json | 72 +-- Resource/ResourceCharacteristic.schema.json | 46 +- Resource/ResourceOrder.schema.json | 180 ++++---- Resource/ResourceOrderItem.schema.json | 82 ++-- Resource/ResourceOrderItemRef.schema.json | 46 +- .../ResourceOrderItemRelationship.schema.json | 44 +- Resource/ResourceOrderRef.schema.json | 54 +-- .../ResourceOrderRelationship.schema.json | 50 +- Resource/ResourceRef.schema.json | 46 +- Resource/ResourceRelationship.schema.json | 48 +- Resource/ResourceSpecificationRef.schema.json | 72 +-- Resource/SupportingResource.schema.json | 54 +-- Service/AlternateServiceProposal.schema.json | 56 +-- Service/AppliedConsequence.schema.json | 64 +-- Service/BaseService.schema.json | 172 +++---- Service/FirstAlert.schema.json | 56 +-- Service/ImpactPattern.schema.json | 54 +-- .../MeasureThresholdRuleViolation.schema.json | 118 ++--- .../MetricDefMeasureConsequence.schema.json | 72 +-- .../MetricDefMeasureThresholdRule.schema.json | 118 ++--- Service/ProblemAcknowledgement.schema.json | 84 ++-- Service/ProblemGroup.schema.json | 70 +-- Service/ProblemUnacknowledgement.schema.json | 84 ++-- Service/ProblemUngroup.schema.json | 70 +-- Service/Service.schema.json | 128 +++--- Service/ServiceCandidate.schema.json | 120 ++--- Service/ServiceCandidateRef.schema.json | 72 +-- Service/ServiceCatalog.schema.json | 126 ++--- Service/ServiceCategory.schema.json | 142 +++--- Service/ServiceCategoryRef.schema.json | 64 +-- Service/ServiceCharacteristic.schema.json | 56 +-- ...ligibilityUnavailabilityReason.schema.json | 48 +- Service/ServiceLevelObjective.schema.json | 142 +++--- Service/ServiceLevelObjectiveRef.schema.json | 56 +-- .../ServiceLevelSpecConsequence.schema.json | 48 +- Service/ServiceLevelSpecParameter.schema.json | 94 ++-- Service/ServiceLevelSpecification.schema.json | 86 ++-- .../ServiceLevelSpecificationRef.schema.json | 64 +-- ...erviceOfferingQualificationRef.schema.json | 64 +-- Service/ServiceOrder.schema.json | 210 ++++----- Service/ServiceOrderActionType.schema.json | 32 +- Service/ServiceOrderItem.schema.json | 92 ++-- .../ServiceOrderItemRelationship.schema.json | 56 +-- Service/ServiceOrderRef.schema.json | 64 +-- Service/ServiceOrderRelationship.schema.json | 70 +-- Service/ServiceOrderStateType.schema.json | 42 +- Service/ServiceProblem.schema.json | 432 +++++++++--------- Service/ServiceProblemEventRecord.schema.json | 82 ++-- Service/ServiceProblemRef.schema.json | 62 +-- Service/ServiceQualification.schema.json | 184 ++++---- Service/ServiceQualificationItem.schema.json | 172 +++---- ...eQualificationItemRelationship.schema.json | 48 +- ...rviceQualificationRelationship.schema.json | 46 +- Service/ServiceRef.schema.json | 30 +- Service/ServiceRelationship.schema.json | 46 +- .../ServiceSpecCharRelationship.schema.json | 80 ++-- Service/ServiceSpecCharacteristic.schema.json | 148 +++--- ...ServiceSpecCharacteristicValue.schema.json | 104 ++--- Service/ServiceSpecRelationship.schema.json | 80 ++-- Service/ServiceSpecification.schema.json | 198 ++++---- Service/ServiceSpecificationRef.schema.json | 80 ++-- Service/ServiceStateType.schema.json | 36 +- Service/ServiceTest.schema.json | 144 +++--- Service/ServiceTestCharacteristic.schema.json | 48 +- Service/ServiceTestSpecification.schema.json | 102 ++--- .../ServiceTestSpecificationRef.schema.json | 64 +-- Service/SupportingService.schema.json | 64 +-- Service/TargetServiceSchema.schema.json | 46 +- Service/TerminationError.schema.json | 38 +- Service/TestMeasure.schema.json | 114 ++--- Service/TestMeasureDefinition.schema.json | 126 ++--- Service/TrackingRecord.schema.json | 88 ++-- 503 files changed, 21048 insertions(+), 20387 deletions(-) create mode 100644 Common/ContentType.schema.json create mode 100644 Common/Event.schema.json create mode 100644 Common/Topic.schema.json create mode 100644 Customer/QueryProductRecommendation.schema.json create mode 100644 Customer/SearchTimeSlotStateType.schema.json create mode 100644 EngagedParty/Partner.schema.json create mode 100644 EngagedParty/Partnership.schema.json create mode 100644 EngagedParty/PartnershipRef.schema.json create mode 100644 EngagedParty/PartnershipSpecification.schema.json create mode 100644 EngagedParty/PartnershipSpecificationRef.schema.json create mode 100644 EngagedParty/RoleSpecification.schema.json create mode 100644 MarketingSales/SalesLeadPriorityType.schema.json create mode 100644 MarketingSales/SalesLeadStateType.schema.json create mode 100644 Product/AlternateProduct.schema.json diff --git a/Common/Address.schema.json b/Common/Address.schema.json index d05c7075..0ddeb1a4 100644 --- a/Common/Address.schema.json +++ b/Common/Address.schema.json @@ -1,71 +1,71 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Address.schema.json", - "title": "Address", - "definitions": { - "Address": { - "$id": "#Address", - "description": "Structured textual way of describing how to find a Property in an urban area (country properties are often\ndefined differently).\nNote : Address corresponds to SID UrbanPropertyAddress", - "type": "object", - "properties": { - "city": { - "type": "string", - "description": "City that the address is in" - }, - "country": { - "type": "string", - "description": "Country that the address is in" - }, - "locality": { - "type": "string", - "description": "\"An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature.\" [ANZLIC-STREET], or a suburb \"a bounded locality within a city, town or shire principally of urban character \" [ANZLICSTREET]" - }, - "postcode": { - "type": "string", - "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" - }, - "stateOrProvince": { - "type": "string", - "description": "the State or Province that the address is in" - }, - "streetName": { - "type": "string", - "description": "Name of the street or other street type" - }, - "streetNr": { - "type": "string", - "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" - }, - "streetNrLast": { - "type": "string", - "description": "Last number in a range of street numbers allocated to a property" - }, - "streetNrLastSuffix": { - "type": "string", - "description": "Last street number suffix for a ranged address" - }, - "streetNrSuffix": { - "type": "string", - "description": "the first street number suffix" - }, - "streetSuffix": { - "type": "string", - "description": "A modifier denoting a relative direction" - }, - "streetType": { - "type": "string", - "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf " - }, - "subAddress": { - "$ref": "SubAddress.schema.json#SubAddress", - "description": "Within a property in an urban area, may refer to a building, building cluster, or a floor of a multistory building" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Address.schema.json", + "title": "Address", + "definitions": { + "Address": { + "$id": "#Address", + "description": "Structured textual way of describing how to find a Property in an urban area (country properties are often\ndefined differently).\nNote : Address corresponds to SID UrbanPropertyAddress", + "type": "object", + "properties": { + "city": { + "type": "string", + "description": "City that the address is in" + }, + "country": { + "type": "string", + "description": "Country that the address is in" + }, + "locality": { + "type": "string", + "description": "\"An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature.\" [ANZLIC-STREET], or a suburb \"a bounded locality within a city, town or shire principally of urban character \" [ANZLICSTREET]" + }, + "postcode": { + "type": "string", + "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" + }, + "stateOrProvince": { + "type": "string", + "description": "the State or Province that the address is in" + }, + "streetName": { + "type": "string", + "description": "Name of the street or other street type" + }, + "streetNr": { + "type": "string", + "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" + }, + "streetNrLast": { + "type": "string", + "description": "Last number in a range of street numbers allocated to a property" + }, + "streetNrLastSuffix": { + "type": "string", + "description": "Last street number suffix for a ranged address" + }, + "streetNrSuffix": { + "type": "string", + "description": "the first street number suffix" + }, + "streetSuffix": { + "type": "string", + "description": "A modifier denoting a relative direction" + }, + "streetType": { + "type": "string", + "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf " + }, + "subAddress": { + "$ref": "../Common/SubAddress.schema.json#SubAddress", + "description": "Within a property in an urban area, may refer to a building, building cluster, or a floor of a multistory building" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/AddressRef.schema.json b/Common/AddressRef.schema.json index 9790806d..c60aeea3 100644 --- a/Common/AddressRef.schema.json +++ b/Common/AddressRef.schema.json @@ -1,16 +1,16 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AddressRef.schema.json", - "title": "AddressRef", - "definitions": { - "AddressRef": { - "$id": "#AddressRef", - "type": "object", - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AddressRef.schema.json", + "title": "AddressRef", + "definitions": { + "AddressRef": { + "$id": "#AddressRef", + "type": "object", + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} \ No newline at end of file + } +} diff --git a/Common/AlternateGeographicAddress.schema.json b/Common/AlternateGeographicAddress.schema.json index 2b6bbced..29849211 100644 --- a/Common/AlternateGeographicAddress.schema.json +++ b/Common/AlternateGeographicAddress.schema.json @@ -1,91 +1,91 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AlternateGeographicAddress.schema.json", - "title": "AlternateGeographicAddress", - "definitions": { - "AlternateGeographicAddress": { - "$id": "#AlternateGeographicAddress", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "An URI used to access to the address resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of the address" - }, - "name": { - "type": "string", - "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" - }, - "role": { - "type": "string", - "description": "Role of the place, such as: [home delivery], [shop retrieval])" - }, - "city": { - "type": "string", - "description": "City that the address is in" - }, - "country": { - "type": "string", - "description": "Country that the address is in" - }, - "locality": { - "type": "string", - "description": "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature. [ANZLIC-STREET], or a suburb, a bounded locality within a city, town or shire principally of urban character [ANZLICSTREET]" - }, - "postcode": { - "type": "string", - "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" - }, - "stateOrProvince": { - "type": "string", - "description": "the State or Province that the address is in" - }, - "streetName": { - "type": "string", - "description": "Name of the street or other street type" - }, - "streetNr": { - "type": "string", - "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" - }, - "streetNrLast": { - "type": "string", - "description": "Last number in a range of street numbers allocated to a property" - }, - "streetNrLastSuffix": { - "type": "string", - "description": "Last street number suffix for a ranged address" - }, - "streetNrSuffix": { - "type": "string", - "description": "the first street number suffix" - }, - "streetSuffix": { - "type": "string", - "description": "A modifier denoting a relative direction" - }, - "streetType": { - "type": "string", - "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf " - }, - "geographicLocation": { - "$ref": "GeographicLocation.schema.json#GeographicLocation" - }, - "geographicSubAddress": { - "type": "array", - "items": { - "$ref": "GeographicSubAddress.schema.json#GeographicSubAddress" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AlternateGeographicAddress.schema.json", + "title": "AlternateGeographicAddress", + "definitions": { + "AlternateGeographicAddress": { + "$id": "#AlternateGeographicAddress", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "An URI used to access to the address resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of the address" + }, + "name": { + "type": "string", + "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" + }, + "role": { + "type": "string", + "description": "Role of the place, such as: [home delivery], [shop retrieval])" + }, + "city": { + "type": "string", + "description": "City that the address is in" + }, + "country": { + "type": "string", + "description": "Country that the address is in" + }, + "locality": { + "type": "string", + "description": "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature. [ANZLIC-STREET], or a suburb, a bounded locality within a city, town or shire principally of urban character [ANZLICSTREET]" + }, + "postcode": { + "type": "string", + "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" + }, + "stateOrProvince": { + "type": "string", + "description": "the State or Province that the address is in" + }, + "streetName": { + "type": "string", + "description": "Name of the street or other street type" + }, + "streetNr": { + "type": "string", + "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" + }, + "streetNrLast": { + "type": "string", + "description": "Last number in a range of street numbers allocated to a property" + }, + "streetNrLastSuffix": { + "type": "string", + "description": "Last street number suffix for a ranged address" + }, + "streetNrSuffix": { + "type": "string", + "description": "the first street number suffix" + }, + "streetSuffix": { + "type": "string", + "description": "A modifier denoting a relative direction" + }, + "streetType": { + "type": "string", + "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf " + }, + "geographicLocation": { + "$ref": "../Common/GeographicLocation.schema.json#GeographicLocation" + }, + "geographicSubAddress": { + "type": "array", + "items": { + "$ref": "../Common/GeographicSubAddress.schema.json#GeographicSubAddress" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Any.schema.json b/Common/Any.schema.json index 18f415c8..b8c0bca8 100644 --- a/Common/Any.schema.json +++ b/Common/Any.schema.json @@ -1,11 +1,10 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Any.schema.json", - "title": "Any", - "definitions": { - "Any": { - "$id": "#Any", - "type": "object" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Any.schema.json", + "title": "Any", + "definitions": { + "Any": { + "$id": "#Any" } -} \ No newline at end of file + } +} diff --git a/Common/Area.schema.json b/Common/Area.schema.json index 8edacc8c..ef13d452 100644 --- a/Common/Area.schema.json +++ b/Common/Area.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Area.schema.json", - "title": "Area", - "definitions": { - "Area": { - "$id": "#Area", - "description": "Area corresponds to a geographic area as a city, a locality, a district, etc.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of an Area" - }, - "name": { - "type": "string", - "description": "The defined name of the municipality" - }, - "areaType": { - "type": "string", - "description": "SUBURB, LOCALITY, CITY, TOWN, BOROUGH, ..." - }, - "characteristic": { - "type": "array", - "description": "Any additional characterization of the Area, defined for the Area type", - "items": { - "$ref": "LocationCharacteristic.schema.json#LocationCharacteristic" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Area.schema.json", + "title": "Area", + "definitions": { + "Area": { + "$id": "#Area", + "description": "Area corresponds to a geographic area as a city, a locality, a district, etc.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of an Area" + }, + "name": { + "type": "string", + "description": "The defined name of the municipality" + }, + "areaType": { + "type": "string", + "description": "SUBURB, LOCALITY, CITY, TOWN, BOROUGH, ..." + }, + "characteristic": { + "type": "array", + "description": "Any additional characterization of the Area, defined for the Area type", + "items": { + "$ref": "../Common/LocationCharacteristic.schema.json#LocationCharacteristic" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Association.schema.json b/Common/Association.schema.json index 16bdfb51..004c8d79 100644 --- a/Common/Association.schema.json +++ b/Common/Association.schema.json @@ -1,67 +1,67 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Association.schema.json", - "title": "Association", - "definitions": { - "Association": { - "$id": "#Association", - "description": "Association is the class that describe a relationship between two or more entity specifications based on a given association specification. The role and type of each endpoint in the relationship is given by an association role. The type of endpoints in the relationship should match the ones as defined in the corresponding association role specification. A relationship between entity specifications may be governed by conditions and rules which are addressed by constraint references in this resource. Constraints for a relationship may include new rules and conditions in addition to those defined for the corresponding association specification", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the association" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to this association" - }, - "id": { - "type": "string", - "description": "unique identifier of the association" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "The last modified date of this association object" - }, - "lifecycleStatus": { - "type": "string", - "description": "Indicates the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name given to this association" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which this association is valid" - }, - "version": { - "type": "string", - "description": "Version of this REST resource" - }, - "associationSpec": { - "$ref": "AssociationSpecRef.schema.json#AssociationSpecRef", - "description": "The specification of this association" - }, - "associationRole": { - "$ref": "AssociationRole.schema.json#AssociationRole", - "description": "The role of this association" - }, - "constraint": { - "description": "Any constraints in this association", - "type": "array", - "items": { - "$ref": "ConstraintRef.schema.json#ConstraintRef" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Association.schema.json", + "title": "Association", + "definitions": { + "Association": { + "$id": "#Association", + "description": "Association is the class that describe a relationship between two or more entity specifications based on a given association specification. The role and type of each endpoint in the relationship is given by an association role. The type of endpoints in the relationship should match the ones as defined in the corresponding association role specification. A relationship between entity specifications may be governed by conditions and rules which are addressed by constraint references in this resource. Constraints for a relationship may include new rules and conditions in addition to those defined for the corresponding association specification", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the association" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to this association" + }, + "id": { + "type": "string", + "description": "unique identifier of the association" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "The last modified date of this association object" + }, + "lifecycleStatus": { + "type": "string", + "description": "Indicates the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name given to this association" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which this association is valid" + }, + "version": { + "type": "string", + "description": "Version of this REST resource" + }, + "associationSpec": { + "$ref": "../Common/AssociationSpecRef.schema.json#AssociationSpecRef", + "description": "The specification of this association" + }, + "associationRole": { + "$ref": "../Common/AssociationRole.schema.json#AssociationRole", + "description": "The role of this association" + }, + "constraint": { + "description": "Any constraints in this association", + "type": "array", + "items": { + "$ref": "../Common/ConstraintRef.schema.json#ConstraintRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/AssociationRole.schema.json b/Common/AssociationRole.schema.json index cd534cab..778f2cab 100644 --- a/Common/AssociationRole.schema.json +++ b/Common/AssociationRole.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AssociationRole.schema.json", - "title": "AssociationRole", - "definitions": { - "AssociationRole": { - "$id": "#AssociationRole", - "description": "This embedded object represents the role and type of each entity involved in a relationship.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink reference to the endpoint plays this association role" - }, - "id": { - "type": "string", - "description": "The identifier of the endpoint plays this role" - }, - "isSource": { - "type": "boolean", - "description": "A flag indicating if the participant involved in a uni-directional relationship is the source or not. this flag is true If the association is bi-directional (both end points are navigable)" - }, - "name": { - "type": "string", - "description": "Name of the endpoint which plays this association role" - }, - "role": { - "type": "string", - "description": "The association role of this relationship participant as defined in the associationRoleSpec" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AssociationRole.schema.json", + "title": "AssociationRole", + "definitions": { + "AssociationRole": { + "$id": "#AssociationRole", + "description": "This embedded object represents the role and type of each entity involved in a relationship.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink reference to the endpoint plays this association role" + }, + "id": { + "type": "string", + "description": "The identifier of the endpoint plays this role" + }, + "isSource": { + "type": "boolean", + "description": "A flag indicating if the participant involved in a uni-directional relationship is the source or not. this flag is true If the association is bi-directional (both end points are navigable)" + }, + "name": { + "type": "string", + "description": "Name of the endpoint which plays this association role" + }, + "role": { + "type": "string", + "description": "The association role of this relationship participant as defined in the associationRoleSpec" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/AssociationRoleSpec.schema.json b/Common/AssociationRoleSpec.schema.json index 40616e41..941af63d 100644 --- a/Common/AssociationRoleSpec.schema.json +++ b/Common/AssociationRoleSpec.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AssociationRoleSpec.schema.json", - "title": "AssociationRoleSpec", - "definitions": { - "AssociationRoleSpec": { - "$id": "#AssociationRoleSpec", - "description": "This embedded object represents the role and type of each entity involved in a relationship.", - "type": "object", - "properties": { - "aggregation": { - "type": "string" - }, - "defaultQuantity": { - "type": "integer" - }, - "entityType": { - "type": "string" - }, - "isNavigable": { - "type": "boolean" - }, - "isSource": { - "type": "boolean" - }, - "maxQuantity": { - "type": "integer" - }, - "minQuantity": { - "type": "integer" - }, - "role": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AssociationRoleSpec.schema.json", + "title": "AssociationRoleSpec", + "definitions": { + "AssociationRoleSpec": { + "$id": "#AssociationRoleSpec", + "description": "This embedded object represents the role and type of each entity involved in a relationship.", + "type": "object", + "properties": { + "aggregation": { + "type": "string" + }, + "defaultQuantity": { + "type": "integer" + }, + "entityType": { + "type": "string" + }, + "isNavigable": { + "type": "boolean" + }, + "isSource": { + "type": "boolean" + }, + "maxQuantity": { + "type": "integer" + }, + "minQuantity": { + "type": "integer" + }, + "role": { + "type": "string" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/AssociationSpecRef.schema.json b/Common/AssociationSpecRef.schema.json index 92da747d..dcbcab96 100644 --- a/Common/AssociationSpecRef.schema.json +++ b/Common/AssociationSpecRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AssociationSpecRef.schema.json", - "title": "AssociationSpecRef", - "definitions": { - "AssociationSpecRef": { - "$id": "#AssociationSpecRef", - "description": "reference to an AssociationSpecification object", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink reference to the target AssociationSpecification" - }, - "id": { - "type": "string", - "description": "reference id to the target AssociationSpecification" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AssociationSpecRef.schema.json", + "title": "AssociationSpecRef", + "definitions": { + "AssociationSpecRef": { + "$id": "#AssociationSpecRef", + "description": "reference to an AssociationSpecification object", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink reference to the target AssociationSpecification" + }, + "id": { + "type": "string", + "description": "reference id to the target AssociationSpecification" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/AssociationSpecification.schema.json b/Common/AssociationSpecification.schema.json index 8ffa46be..9f57fcbf 100644 --- a/Common/AssociationSpecification.schema.json +++ b/Common/AssociationSpecification.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AssociationSpecification.schema.json", - "title": "AssociationSpecification", - "definitions": { - "AssociationSpecification": { - "$id": "#AssociationSpecification", - "description": "AssociationSpecification is an association class that describes a type of relationship between two entities. This is a generic construct that may be used to describe relationship types and roles. The role and type of each entity in the relationship is given by an association role specification. Two role specifications are embedded in the association specification.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the specification" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to this specification" - }, - "id": { - "type": "string", - "description": "unique identifier of the association specification" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "The last modified date of this specification" - }, - "lifecycleStatus": { - "type": "string", - "description": "Indicates the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name given to this association specification" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which this specification is valid" - }, - "version": { - "type": "string", - "description": "Version of this association" - }, - "constraint": { - "type": "array", - "items": { - "$ref": "ConstraintRef.schema.json#ConstraintRef" - } - }, - "associationRoleSpec": { - "$ref": "AssociationRoleSpec.schema.json#AssociationRoleSpec" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AssociationSpecification.schema.json", + "title": "AssociationSpecification", + "definitions": { + "AssociationSpecification": { + "$id": "#AssociationSpecification", + "description": "AssociationSpecification is an association class that describes a type of relationship between two entities. This is a generic construct that may be used to describe relationship types and roles. The role and type of each entity in the relationship is given by an association role specification. Two role specifications are embedded in the association specification.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the specification" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to this specification" + }, + "id": { + "type": "string", + "description": "unique identifier of the association specification" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "The last modified date of this specification" + }, + "lifecycleStatus": { + "type": "string", + "description": "Indicates the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name given to this association specification" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which this specification is valid" + }, + "version": { + "type": "string", + "description": "Version of this association" + }, + "constraint": { + "type": "array", + "items": { + "$ref": "../Common/ConstraintRef.schema.json#ConstraintRef" + } + }, + "associationRoleSpec": { + "$ref": "../Common/AssociationRoleSpec.schema.json#AssociationRoleSpec" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Attachment.schema.json b/Common/Attachment.schema.json index f81cca4e..41a200d0 100644 --- a/Common/Attachment.schema.json +++ b/Common/Attachment.schema.json @@ -1,80 +1,80 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Attachment.schema.json", - "title": "Attachment", - "definitions": { - "Attachment": { - "$id": "#Attachment", - "description": "Complements the description of an element (for instance a product) through video, pictures...", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for this particular attachment", - "examples": [ - "4aafacbd-11ff-4dc8-b445-305f2215715f", - "2334bc59-726e-4d34-ab96-f50e0561412f" - ] - }, - "href": { - "type": "string", - "format": "uri", - "description": "URI for this Attachment", - "examples": [ - "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f" - ] - }, - "name": { - "type": "string", - "description": "The name of the attachment" - }, - "description": { - "type": "string", - "description": "A narrative text describing the content of the attachment", - "examples": [ - "Photograph of the Product", - "Explanation Video" - ] - }, - "attachmentType": { - "type": "string", - "description": "Attachment type such as video, picture", - "examples": [ - "video", - "picture" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "Uniform Resource Locator, is a web page address (a subset of URI)", - "examples": [ - "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f" - ] - }, - "mimeType": { - "type": "string", - "description": "Attachment mime type such as extension file for video, picture and document" - }, - "content": { - "type": "string", - "format": "base64", - "description": "The actual contents of the attachment object, if embedded, encoded as base64" - }, - "size": { - "$ref": "Quantity.schema.json#Quantity", - "description": "The size of the attachment." - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period of time for which the attachment is valid" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Attachment.schema.json", + "title": "Attachment", + "definitions": { + "Attachment": { + "$id": "#Attachment", + "description": "Complements the description of an element (for instance a product) through video, pictures...", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for this particular attachment", + "examples": [ + "4aafacbd-11ff-4dc8-b445-305f2215715f", + "2334bc59-726e-4d34-ab96-f50e0561412f" + ] + }, + "href": { + "type": "string", + "format": "uri", + "description": "URI for this Attachment", + "examples": [ + "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f" + ] + }, + "name": { + "type": "string", + "description": "The name of the attachment" + }, + "description": { + "type": "string", + "description": "A narrative text describing the content of the attachment", + "examples": [ + "Photograph of the Product", + "Explanation Video" + ] + }, + "attachmentType": { + "type": "string", + "description": "Attachment type such as video, picture", + "examples": [ + "video", + "picture" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "Uniform Resource Locator, is a web page address (a subset of URI)", + "examples": [ + "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f" + ] + }, + "mimeType": { + "type": "string", + "description": "Attachment mime type such as extension file for video, picture and document" + }, + "content": { + "type": "string", + "format": "base64", + "description": "The actual contents of the attachment object, if embedded, encoded as base64" + }, + "size": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "The size of the attachment." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period of time for which the attachment is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/AttachmentRef.schema.json b/Common/AttachmentRef.schema.json index 41c2f328..1511dd63 100644 --- a/Common/AttachmentRef.schema.json +++ b/Common/AttachmentRef.schema.json @@ -1,41 +1,41 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AttachmentRef.schema.json", - "title": "AttachmentRef", - "definitions": { - "AttachmentRef": { - "$id": "#AttachmentRef", - "description": "Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative text describing the content of the attachment" - }, - "href": { - "type": "string", - "description": "URL serving as reference for the attachment resource", - "format": "uri" - }, - "id": { - "description": "Unique-Identifier for this attachment", - "type": "string" - }, - "url": { - "description": "Link to the attachment media/content", - "type": "string", - "format": "uri" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AttachmentRef.schema.json", + "title": "AttachmentRef", + "definitions": { + "AttachmentRef": { + "$id": "#AttachmentRef", + "description": "Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative text describing the content of the attachment" + }, + "href": { + "type": "string", + "description": "URL serving as reference for the attachment resource", + "format": "uri" + }, + "id": { + "description": "Unique-Identifier for this attachment", + "type": "string" + }, + "url": { + "description": "Link to the attachment media/content", + "type": "string", + "format": "uri" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/AttachmentRefOrValue.schema.json b/Common/AttachmentRefOrValue.schema.json index 3573f9e9..c258a966 100644 --- a/Common/AttachmentRefOrValue.schema.json +++ b/Common/AttachmentRefOrValue.schema.json @@ -1,20 +1,67 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AttachmentRefOrValue.schema.json", - "title": "AttachmentRefOrValue", - "definitions": { - "AttachmentRefOrValue": { - "$id": "#AttachmentRefOrValue", - "type": "object", - "description": "An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and not to AttchmentRefOrValue itself", - "allOf": [ - { - "$ref": "AttachmentRef.schema.json#AttachmentRef" - }, - { - "$ref": "Attachment.schema.json#Attachment" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AttachmentRefOrValue.schema.json", + "title": "AttachmentRefOrValue", + "definitions": { + "AttachmentRefOrValue": { + "$id": "#AttachmentRefOrValue", + "type": "object", + "description": "An attachment by value or by reference.", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "description": { + "type": "string", + "description": "A narrative text describing the content of the attachment" + }, + "href": { + "type": "string", + "description": "URI for this Attachment" + }, + "id": { + "type": "string", + "description": "Unique identifier for this particular attachment" + }, + "url": { + "type": "string", + "description": "Uniform Resource Locator, is a web page address (a subset of URI)" + }, + "name": { + "type": "string", + "description": "The name of the attachment" + }, + "attachmentType": { + "type": "string", + "description": "Attachment type such as video, picture" + }, + "mimeType": { + "type": "string", + "description": "Attachment mime type such as extension file for video, picture and document" + }, + "isRef": { + "type": "boolean", + "default": true + }, + "content": { + "$ref": "../Common/ContentType.schema.json#ContentType", + "description": "The file itself when provided." + }, + "size": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "The size of the attachment." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period of time for which the attachment is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/BaseEvent.schema.json b/Common/BaseEvent.schema.json index 2c0ca7ac..d508dbc0 100644 --- a/Common/BaseEvent.schema.json +++ b/Common/BaseEvent.schema.json @@ -1,65 +1,65 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BaseEvent.schema.json", - "title": "BaseEvent", - "definitions": { - "BaseEvent": { - "$id": "#BaseEvent", - "description": "Base event with common attributes.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Identifier of the Process flow" - }, - "href": { - "type": "string", - "description": "Reference of the ProcessFlow" - }, - "eventId": { - "type": "string", - "description": "The identifier of the notification." - }, - "eventTime": { - "type": "string", - "format": "date-time", - "description": "Time of the event occurrence." - }, - "eventType": { - "type": "string", - "description": "The type of the notification." - }, - "correlationId": { - "type": "string", - "description": "The correlation id for this event." - }, - "domain": { - "type": "string", - "description": "The domain of the event." - }, - "title": { - "type": "string", - "description": "The title of the event." - }, - "description": { - "type": "string", - "description": "An explnatory of the event." - }, - "priority": { - "type": "string", - "description": "A priority." - }, - "timeOcurred": { - "type": "string", - "format": "date-time", - "description": "The time the event occured." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BaseEvent.schema.json", + "title": "BaseEvent", + "definitions": { + "BaseEvent": { + "$id": "#BaseEvent", + "description": "Base event with common attributes.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the Process flow" + }, + "href": { + "type": "string", + "description": "Reference of the ProcessFlow" + }, + "eventId": { + "type": "string", + "description": "The identifier of the notification." + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "Time of the event occurrence." + }, + "eventType": { + "type": "string", + "description": "The type of the notification." + }, + "correlationId": { + "type": "string", + "description": "The correlation id for this event." + }, + "domain": { + "type": "string", + "description": "The domain of the event." + }, + "title": { + "type": "string", + "description": "The title of the event." + }, + "description": { + "type": "string", + "description": "An explnatory of the event." + }, + "priority": { + "type": "string", + "description": "A priority." + }, + "timeOcurred": { + "type": "string", + "format": "date-time", + "description": "The time the event occured." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/BasePlusEvent.schema.json b/Common/BasePlusEvent.schema.json index a93e0ab9..16387bb4 100644 --- a/Common/BasePlusEvent.schema.json +++ b/Common/BasePlusEvent.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BasePlusEvent.schema.json", - "title": "BasePlusEvent", - "definitions": { - "BasePlusEvent": { - "$id": "#BasePlusEvent", - "description": "Base event with common attributes.", - "type": "object", - "properties": { - "eventId": { - "type": "string", - "description": "The identifier of the notification." - }, - "eventTime": { - "type": "string", - "format": "date-time", - "description": "Time of the event occurrence." - }, - "eventType": { - "type": "string", - "description": "The type of the notification." - }, - "correlationId": { - "type": "string", - "description": "The correlation id for this event." - }, - "domain": { - "type": "string", - "description": "The domain of the event." - }, - "title": { - "type": "string", - "description": "The title of the event." - }, - "description": { - "type": "string", - "description": "An explnatory of the event." - }, - "priority": { - "type": "string", - "description": "A priority." - }, - "timeOcurred": { - "type": "string", - "format": "date-time", - "description": "The time the event occured." - }, - "fieldPath": { - "type": "string", - "description": "The path identifying the object field concerned by this notification." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BasePlusEvent.schema.json", + "title": "BasePlusEvent", + "definitions": { + "BasePlusEvent": { + "$id": "#BasePlusEvent", + "description": "Base event with common attributes.", + "type": "object", + "properties": { + "eventId": { + "type": "string", + "description": "The identifier of the notification." + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "Time of the event occurrence." + }, + "eventType": { + "type": "string", + "description": "The type of the notification." + }, + "correlationId": { + "type": "string", + "description": "The correlation id for this event." + }, + "domain": { + "type": "string", + "description": "The domain of the event." + }, + "title": { + "type": "string", + "description": "The title of the event." + }, + "description": { + "type": "string", + "description": "An explnatory of the event." + }, + "priority": { + "type": "string", + "description": "A priority." + }, + "timeOcurred": { + "type": "string", + "format": "date-time", + "description": "The time the event occured." + }, + "fieldPath": { + "type": "string", + "description": "The path identifying the object field concerned by this notification." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/BusinessInteraction.schema.json b/Common/BusinessInteraction.schema.json index ff5093e0..f5abd0dc 100644 --- a/Common/BusinessInteraction.schema.json +++ b/Common/BusinessInteraction.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BusinessInteraction.schema.json", - "title": "BusinessInteraction", - "definitions": { - "BusinessInteraction": { - "$id": "#BusinessInteraction", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A description of this interaction" - }, - "id": { - "type": "string", - "description": "The unique ID for this interaction" - }, - "interactionData": { - "type": "string", - "format": "date-time" - }, - "interactionDataComplete": { - "type": "string", - "format": "date-time" - }, - "interactionDataStatus": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BusinessInteraction.schema.json", + "title": "BusinessInteraction", + "definitions": { + "BusinessInteraction": { + "$id": "#BusinessInteraction", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of this interaction" + }, + "id": { + "type": "string", + "description": "The unique ID for this interaction" + }, + "interactionData": { + "type": "string", + "format": "date-time" + }, + "interactionDataComplete": { + "type": "string", + "format": "date-time" + }, + "interactionDataStatus": { + "type": "string" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/CalendarEventRef.schema.json b/Common/CalendarEventRef.schema.json index 2b70302a..2f5b9683 100644 --- a/Common/CalendarEventRef.schema.json +++ b/Common/CalendarEventRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CalendarEventRef.schema.json", - "title": "CalendarEventRef", - "definitions": { - "CalendarEventRef": { - "$id": "#CalendarEventRef", - "type": "object", - "description": "Reference of a CalendarEvent", - "properties": {}, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CalendarEventRef.schema.json", + "title": "CalendarEventRef", + "definitions": { + "CalendarEventRef": { + "$id": "#CalendarEventRef", + "type": "object", + "description": "Reference of a CalendarEvent", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} \ No newline at end of file + } +} diff --git a/Common/CalendarPeriod.schema.json b/Common/CalendarPeriod.schema.json index d4b0dfb0..215d081d 100644 --- a/Common/CalendarPeriod.schema.json +++ b/Common/CalendarPeriod.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CalendarPeriod.schema.json", - "title": "CalendarPeriod", - "definitions": { - "CalendarPeriod": { - "$id": "#CalendarPeriod", - "type": "object", - "properties": { - "day": { - "type": "string", - "description": "Day where the calendar status applies (e.g.: monday, mon-to-fri, weekdays, weekend, all week, ...)" - }, - "status": { - "type": "string", - "description": "Indication of the availability of the site (e.g.: open)" - }, - "timeZone": { - "type": "string", - "description": "Indication of the timezone applicable to the calendar information (e.g.: Paris, GMT+1)" - }, - "hourPeriod": { - "type": "array", - "items": { - "$ref": "HourPeriod.schema.json#HourPeriod" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CalendarPeriod.schema.json", + "title": "CalendarPeriod", + "definitions": { + "CalendarPeriod": { + "$id": "#CalendarPeriod", + "type": "object", + "properties": { + "day": { + "type": "string", + "description": "Day where the calendar status applies (e.g.: monday, mon-to-fri, weekdays, weekend, all week, ...)" + }, + "status": { + "type": "string", + "description": "Indication of the availability of the site (e.g.: open)" + }, + "timeZone": { + "type": "string", + "description": "Indication of the timezone applicable to the calendar information (e.g.: Paris, GMT+1)" + }, + "hourPeriod": { + "type": "array", + "items": { + "$ref": "../Common/HourPeriod.schema.json#HourPeriod" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/ChangeRequest.schema.json b/Common/ChangeRequest.schema.json index f321a5d3..326cbb45 100644 --- a/Common/ChangeRequest.schema.json +++ b/Common/ChangeRequest.schema.json @@ -1,185 +1,185 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ChangeRequest.schema.json", - "title": "ChangeRequest", - "definitions": { - "ChangeRequest": { - "$id": "#ChangeRequest", - "description": "Change Request is a type of request which can be used for the management and control of Change Management \nprocess between a customer and a service provider or between a service provider and a partner and vice versa.", - "type": "object", - "properties": { - "actualEndTime": { - "type": "string", - "format": "date-time", - "description": "Date and time when the change implementation actually finished" - }, - "actualStartTime": { - "type": "string", - "format": "date-time", - "description": "Date and time when the change implementation actually started" - }, - "budget": { - "type": "string", - "description": "The budget reserved for the change" - }, - "channel": { - "type": "string", - "description": "A channel represents the way the Change Request was created" - }, - "completionDate": { - "type": "string", - "format": "date-time", - "description": "Date and time when the change request is confirmed to be completed" - }, - "currency": { - "type": "string", - "description": "The used currency related with cost" - }, - "description": { - "type": "string", - "description": "Description of the change request" - }, - "externalId": { - "type": "string", - "description": "ID given by the requestor to facilitate the relationship set up and subsequent searches" - }, - "href": { - "type": "string", - "description": "Hyperlink to access a change request" - }, - "id": { - "type": "string", - "description": "Identifier of a Change Request. It is created on repository side (a Change Management system)" - }, - "impact": { - "type": "string", - "description": "Indicates the impact of this change" - }, - "plannedEndTime": { - "type": "string", - "format": "date-time", - "description": "Date and time when the change implementation is planned to be finished" - }, - "plannedStartTime": { - "type": "string", - "format": "date-time", - "description": "Date and time when the change implementation is planned to be started" - }, - "priority": { - "type": "string", - "description": "Used by consumers to prioritize a change request in Change Management system" - }, - "requestDate": { - "type": "string", - "format": "date-time", - "description": "Date and time when the change request is raised" - }, - "requestType": { - "type": "string", - "description": "Indicates the type of the change request" - }, - "risk": { - "type": "string", - "description": "The risk to implement this change request" - }, - "riskMitigationPlan": { - "type": "string", - "description": "The risk mitigation plan" - }, - "riskValue": { - "type": "string", - "description": "The additional cost if the risk will happen" - }, - "scheduledDate": { - "type": "string", - "format": "date-time", - "description": "Date and time that the schedule is made" - }, - "status": { - "type": "string", - "description": "Status of the change request and its sub-state" - }, - "attachment": { - "type": "array", - "items": { - "$ref": "Attachment.schema.json#Attachment" - }, - "description": "The attachments of the communication message (when it is email type)" - }, - "workLog": { - "$ref": "WorkLog.schema.json#WorkLog" - }, - "incident": { - "type": "array", - "items": { - "$ref": "Incident.schema.json#Incident" - } - }, - "changeRequestSpecification": { - "$ref": "ChangeRequestSpecification.schema.json#ChangeRequestSpecification" - }, - "impactEntity": { - "type": "array", - "items": { - "$ref": "ImpactEntityRef.schema.json#ImpactEntityRef" - } - }, - "changeRequestCharacteristic": { - "type": "array", - "items": { - "$ref": "ChangeRequestCharacteristic.schema.json#ChangeRequestCharacteristic" - } - }, - "targetEntity": { - "type": "array", - "items": { - "$ref": "TargetEntityRef.schema.json#TargetEntityRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "description": "The parties involved in the change request" - }, - "resolution": { - "$ref": "Resolution.schema.json#Resolution" - }, - "sla": { - "type": "array", - "items": { - "$ref": "../EngagedParty/SLARef.schema.json#SLARef" - } - }, - "relateChangeRequest": { - "type": "array", - "items": { - "$ref": "RelatedChangeRequestRef.schema.json#RelatedChangeRequestRef" - } - }, - "category": { - "type": "array", - "items": { - "$ref": "../Product/CategoryRef.schema.json#CategoryRef" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "Note.schema.json#Note" - } - }, - "location": { - "$ref": "GeographicAddressRef.schema.json#GeographicAddressRef", - "description": "The place at which the change request occurred" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ChangeRequest.schema.json", + "title": "ChangeRequest", + "definitions": { + "ChangeRequest": { + "$id": "#ChangeRequest", + "description": "Change Request is a type of request which can be used for the management and control of Change Management \nprocess between a customer and a service provider or between a service provider and a partner and vice versa.", + "type": "object", + "properties": { + "actualEndTime": { + "type": "string", + "format": "date-time", + "description": "Date and time when the change implementation actually finished" + }, + "actualStartTime": { + "type": "string", + "format": "date-time", + "description": "Date and time when the change implementation actually started" + }, + "budget": { + "type": "string", + "description": "The budget reserved for the change" + }, + "channel": { + "type": "string", + "description": "A channel represents the way the Change Request was created" + }, + "completionDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the change request is confirmed to be completed" + }, + "currency": { + "type": "string", + "description": "The used currency related with cost" + }, + "description": { + "type": "string", + "description": "Description of the change request" + }, + "externalId": { + "type": "string", + "description": "ID given by the requestor to facilitate the relationship set up and subsequent searches" + }, + "href": { + "type": "string", + "description": "Hyperlink to access a change request" + }, + "id": { + "type": "string", + "description": "Identifier of a Change Request. It is created on repository side (a Change Management system)" + }, + "impact": { + "type": "string", + "description": "Indicates the impact of this change" + }, + "plannedEndTime": { + "type": "string", + "format": "date-time", + "description": "Date and time when the change implementation is planned to be finished" + }, + "plannedStartTime": { + "type": "string", + "format": "date-time", + "description": "Date and time when the change implementation is planned to be started" + }, + "priority": { + "type": "string", + "description": "Used by consumers to prioritize a change request in Change Management system" + }, + "requestDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the change request is raised" + }, + "requestType": { + "type": "string", + "description": "Indicates the type of the change request" + }, + "risk": { + "type": "string", + "description": "The risk to implement this change request" + }, + "riskMitigationPlan": { + "type": "string", + "description": "The risk mitigation plan" + }, + "riskValue": { + "type": "string", + "description": "The additional cost if the risk will happen" + }, + "scheduledDate": { + "type": "string", + "format": "date-time", + "description": "Date and time that the schedule is made" + }, + "status": { + "type": "string", + "description": "Status of the change request and its sub-state" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "../Common/Attachment.schema.json#Attachment" + }, + "description": "The attachments of the communication message (when it is email type)" + }, + "workLog": { + "$ref": "../Common/WorkLog.schema.json#WorkLog" + }, + "incident": { + "type": "array", + "items": { + "$ref": "../Common/Incident.schema.json#Incident" + } + }, + "changeRequestSpecification": { + "$ref": "../Common/ChangeRequestSpecification.schema.json#ChangeRequestSpecification" + }, + "impactEntity": { + "type": "array", + "items": { + "$ref": "../Common/ImpactEntityRef.schema.json#ImpactEntityRef" + } + }, + "changeRequestCharacteristic": { + "type": "array", + "items": { + "$ref": "../Common/ChangeRequestCharacteristic.schema.json#ChangeRequestCharacteristic" + } + }, + "targetEntity": { + "type": "array", + "items": { + "$ref": "../Common/TargetEntityRef.schema.json#TargetEntityRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "The parties involved in the change request" + }, + "resolution": { + "$ref": "../Common/Resolution.schema.json#Resolution" + }, + "sla": { + "type": "array", + "items": { + "$ref": "../EngagedParty/SLARef.schema.json#SLARef" + } + }, + "relateChangeRequest": { + "type": "array", + "items": { + "$ref": "../Common/RelatedChangeRequestRef.schema.json#RelatedChangeRequestRef" + } + }, + "category": { + "type": "array", + "items": { + "$ref": "../Product/CategoryRef.schema.json#CategoryRef" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "location": { + "$ref": "../Common/GeographicAddressRef.schema.json#GeographicAddressRef", + "description": "The place at which the change request occurred" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/ChangeRequestCharacteristic.schema.json b/Common/ChangeRequestCharacteristic.schema.json index 95e28735..10f9bab2 100644 --- a/Common/ChangeRequestCharacteristic.schema.json +++ b/Common/ChangeRequestCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ChangeRequestCharacteristic.schema.json", - "title": "ChangeRequestCharacteristic", - "definitions": { - "ChangeRequestCharacteristic": { - "$id": "#ChangeRequestCharacteristic", - "description": "Characteristics of the change request to instantiate or to modify", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic." - }, - "value": { - "type": "string", - "description": "Value of the characteristic." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ChangeRequestCharacteristic.schema.json", + "title": "ChangeRequestCharacteristic", + "definitions": { + "ChangeRequestCharacteristic": { + "$id": "#ChangeRequestCharacteristic", + "description": "Characteristics of the change request to instantiate or to modify", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic." + }, + "value": { + "type": "string", + "description": "Value of the characteristic." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/ChangeRequestRef.schema.json b/Common/ChangeRequestRef.schema.json index 8a41186d..4e8189fd 100644 --- a/Common/ChangeRequestRef.schema.json +++ b/Common/ChangeRequestRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ChangeRequestRef.schema.json", - "title": "ChangeRequestRef", - "definitions": { - "ChangeRequestRef": { - "$id": "#ChangeRequestRef", - "type": "object", - "description": "Reference to a Change Request", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "href": { - "type": "string", - "description": "The reference link to the change request" - }, - "id": { - "type": "string", - "description": "The identifier of the change request" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ChangeRequestRef.schema.json", + "title": "ChangeRequestRef", + "definitions": { + "ChangeRequestRef": { + "$id": "#ChangeRequestRef", + "type": "object", + "description": "Reference to a Change Request", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "href": { + "type": "string", + "description": "The reference link to the change request" + }, + "id": { + "type": "string", + "description": "The identifier of the change request" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/ChangeRequestSpecification.schema.json b/Common/ChangeRequestSpecification.schema.json index eb74264c..8bc7a70c 100644 --- a/Common/ChangeRequestSpecification.schema.json +++ b/Common/ChangeRequestSpecification.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ChangeRequestSpecification.schema.json", - "title": "ChangeRequestSpecification", - "definitions": { - "ChangeRequestSpecification": { - "$id": "#ChangeRequestSpecification", - "description": "Defines a set of attributes related to Change Request.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the specification" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the specification." - }, - "id": { - "type": "string", - "description": "Identifier of the specification." - }, - "name": { - "type": "string", - "description": "Name of the specification." - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ChangeRequestSpecification.schema.json", + "title": "ChangeRequestSpecification", + "definitions": { + "ChangeRequestSpecification": { + "$id": "#ChangeRequestSpecification", + "description": "Defines a set of attributes related to Change Request.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the specification" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the specification." + }, + "id": { + "type": "string", + "description": "Identifier of the specification." + }, + "name": { + "type": "string", + "description": "Name of the specification." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Channel.schema.json b/Common/Channel.schema.json index 131659f0..5b812a3c 100755 --- a/Common/Channel.schema.json +++ b/Common/Channel.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Channel.schema.json", - "title": "Channel", - "definitions": { - "Channel": { - "$id": "#Channel", - "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the channel" - }, - "id": { - "type": "string", - "description": "Unique identifier of the channel" - }, - "name": { - "type": "string", - "description": "Name of the channel" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Channel.schema.json", + "title": "Channel", + "definitions": { + "Channel": { + "$id": "#Channel", + "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the channel" + }, + "id": { + "type": "string", + "description": "Unique identifier of the channel" + }, + "name": { + "type": "string", + "description": "Name of the channel" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/ChannelRef.schema.json b/Common/ChannelRef.schema.json index 6547487a..f4ec3a75 100644 --- a/Common/ChannelRef.schema.json +++ b/Common/ChannelRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ChannelRef.schema.json", - "title": "ChannelRef", - "definitions": { - "ChannelRef": { - "$id": "#ChannelRef", - "type": "object", - "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..", - "properties": { - "name": { - "type": "string", - "description": "Name of the channel." - } - }, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ChannelRef.schema.json", + "title": "ChannelRef", + "definitions": { + "ChannelRef": { + "$id": "#ChannelRef", + "type": "object", + "description": "The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..", + "properties": { + "name": { + "type": "string", + "description": "Name of the channel." } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Characteristic.schema.json b/Common/Characteristic.schema.json index 411c7d76..bd57b91c 100644 --- a/Common/Characteristic.schema.json +++ b/Common/Characteristic.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Characteristic.schema.json", - "title": "Characteristic", - "definitions": { - "Characteristic": { - "$id": "#Characteristic", - "description": "Describes a given characteristic of an object or entity through a name/value pair.", - "type": "object", - "required": [ - "name", - "value" - ], - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "valueType": { - "type": "string", - "description": "Data type of the value of the characteristic" - }, - "value": { - "$ref": "Any.schema.json#Any", - "description": "The value of the characteristic" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Characteristic.schema.json", + "title": "Characteristic", + "definitions": { + "Characteristic": { + "$id": "#Characteristic", + "description": "Describes a given characteristic of an object or entity through a name/value pair.", + "type": "object", + "required": [ + "name", + "value" + ], + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "valueType": { + "type": "string", + "description": "Data type of the value of the characteristic" + }, + "value": { + "$ref": "../Common/Any.schema.json#Any", + "description": "The value of the characteristic" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/CommonComponents.schema.json b/Common/CommonComponents.schema.json index 8df17fe3..c7425a56 100644 --- a/Common/CommonComponents.schema.json +++ b/Common/CommonComponents.schema.json @@ -1,44 +1,44 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CommonComponents.json", - "title": "CommonComponents", - "description": "Highly reusable schema fragments for use in TMForum Open-APIs", - "definitions": { - "polymorphicPattern": { - "$id": "#polymorphicPattern", - "type": "object", - "properties": { - "@schemaLocation": { - "type": "string", - "format": "uri", - "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", - "examples": [ - "http://host/schemas/Subclass.schema.json" - ] - }, - "@baseType": { - "type": "string", - "description": "When sub-classing, this defines the super-class", - "examples": [ - "Place", - "ServiceSpecification" - ] - }, - "@type": { - "type": "string", - "description": "When sub-classing, this defines the sub-class entity name", - "examples": [ - "VendorProductOffering", - "DroneServiceSpecification" - ] - } - }, - "dependencies": { - "@schemaLocation": [ - "@baseType", - "@type" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CommonComponents.json", + "title": "CommonComponents", + "description": "Highly reusable schema fragments for use in TMForum Open-APIs", + "definitions": { + "polymorphicPattern": { + "$id": "#polymorphicPattern", + "type": "object", + "properties": { + "@schemaLocation": { + "type": "string", + "format": "uri", + "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", + "examples": [ + "http://host/schemas/Subclass.schema.json" + ] + }, + "@baseType": { + "type": "string", + "description": "When sub-classing, this defines the super-class", + "examples": [ + "Place", + "ServiceSpecification" + ] + }, + "@type": { + "type": "string", + "description": "When sub-classing, this defines the sub-class entity name", + "examples": [ + "VendorProductOffering", + "DroneServiceSpecification" + ] } + }, + "dependencies": { + "@schemaLocation": [ + "@baseType", + "@type" + ] + } } -} \ No newline at end of file + } +} diff --git a/Common/CommunicationMessage.schema.json b/Common/CommunicationMessage.schema.json index c5d448fb..0610c3b7 100644 --- a/Common/CommunicationMessage.schema.json +++ b/Common/CommunicationMessage.schema.json @@ -1,97 +1,97 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CommunicationMessage.schema.json", - "title": "CommunicationMessage", - "definitions": { - "CommunicationMessage": { - "$id": "#CommunicationMessage", - "description": "Communication message means a notification approach in the format of a message which can be dispatched (sent) to the certain user by the system with the content which can be felt and understood by the recipient. The user can be either a final customer or a customer service agent. The message can reach the customer in different interaction channels, including: email, short message, mobile app notification (push).", - "type": "object", - "properties": { - "callbackFlag": { - "type": "boolean", - "description": "Do you want a callback on delivery of communication message?" - }, - "content": { - "type": "string", - "description": "The content of the communication message" - }, - "description": { - "type": "string", - "description": "Description for the whole object" - }, - "href": { - "type": "string", - "description": "Hypertext Reference of the Communication Message" - }, - "id": { - "type": "string", - "description": "Unique identifier of Communication Message" - }, - "logFlag": { - "type": "boolean" - }, - "priority": { - "type": "string", - "description": "The priority of the communication message.\nSmall number means higher priority." - }, - "sendTime": { - "type": "string", - "format": "date-time", - "description": "The time of sending communication message" - }, - "sendTimeComplete": { - "type": "string", - "format": "date-time", - "description": "The time of completion of sending communication message" - }, - "status": { - "type": "string", - "description": "Status of communication message" - }, - "subject": { - "type": "string", - "description": "The title of the message, necessary for the email and mobile app push" - }, - "tryTimes": { - "type": "integer", - "description": "How many times do you want to retry the delivery of this message?" - }, - "messageType": { - "type": "string", - "description": "The type of message, such as: SMS, Email, Mobile app push notification" - }, - "attachment": { - "type": "array", - "description": "Any attachment associated with this message", - "items": { - "$ref": "Attachment.schema.json#Attachment" - } - }, - "receiver": { - "type": "array", - "description": "The receiver(s) of this message", - "items": { - "$ref": "Receiver.schema.json#Receiver" - } - }, - "sender": { - "$ref": "Sender.schema.json#Sender", - "description": "The sender of this message" - }, - "characteristic": { - "type": "array", - "description": "Any additional characteristic(s) of this message", - "items": { - "$ref": "CommunicationRequestCharacteristic.schema.json#CommunicationRequestCharacteristic" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CommunicationMessage.schema.json", + "title": "CommunicationMessage", + "definitions": { + "CommunicationMessage": { + "$id": "#CommunicationMessage", + "description": "Communication message means a notification approach in the format of a message which can be dispatched (sent) to the certain user by the system with the content which can be felt and understood by the recipient. The user can be either a final customer or a customer service agent. The message can reach the customer in different interaction channels, including: email, short message, mobile app notification (push).", + "type": "object", + "properties": { + "callbackFlag": { + "type": "boolean", + "description": "Do you want a callback on delivery of communication message?" + }, + "content": { + "type": "string", + "description": "The content of the communication message" + }, + "description": { + "type": "string", + "description": "Description for the whole object" + }, + "href": { + "type": "string", + "description": "Hypertext Reference of the Communication Message" + }, + "id": { + "type": "string", + "description": "Unique identifier of Communication Message" + }, + "logFlag": { + "type": "boolean" + }, + "priority": { + "type": "string", + "description": "The priority of the communication message.\nSmall number means higher priority." + }, + "sendTime": { + "type": "string", + "format": "date-time", + "description": "The time of sending communication message" + }, + "sendTimeComplete": { + "type": "string", + "format": "date-time", + "description": "The time of completion of sending communication message" + }, + "status": { + "type": "string", + "description": "Status of communication message" + }, + "subject": { + "type": "string", + "description": "The title of the message, necessary for the email and mobile app push" + }, + "tryTimes": { + "type": "integer", + "description": "How many times do you want to retry the delivery of this message?" + }, + "messageType": { + "type": "string", + "description": "The type of message, such as: SMS, Email, Mobile app push notification" + }, + "attachment": { + "type": "array", + "description": "Any attachment associated with this message", + "items": { + "$ref": "../Common/Attachment.schema.json#Attachment" + } + }, + "receiver": { + "type": "array", + "description": "The receiver(s) of this message", + "items": { + "$ref": "../Common/Receiver.schema.json#Receiver" + } + }, + "sender": { + "$ref": "../Common/Sender.schema.json#Sender", + "description": "The sender of this message" + }, + "characteristic": { + "type": "array", + "description": "Any additional characteristic(s) of this message", + "items": { + "$ref": "../Common/CommunicationRequestCharacteristic.schema.json#CommunicationRequestCharacteristic" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/CommunicationRequestCharacteristic.schema.json b/Common/CommunicationRequestCharacteristic.schema.json index 79766c37..9e82ecce 100644 --- a/Common/CommunicationRequestCharacteristic.schema.json +++ b/Common/CommunicationRequestCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CommunicationRequestCharacteristic.schema.json", - "title": "CommunicationRequestCharacteristic", - "definitions": { - "CommunicationRequestCharacteristic": { - "$id": "#CommunicationRequestCharacteristic", - "description": "The values of parameters which are used in the content if the content contains them.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Content parameter identifier" - }, - "value": { - "type": "string", - "description": "Content parameter value" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CommunicationRequestCharacteristic.schema.json", + "title": "CommunicationRequestCharacteristic", + "definitions": { + "CommunicationRequestCharacteristic": { + "$id": "#CommunicationRequestCharacteristic", + "description": "The values of parameters which are used in the content if the content contains them.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Content parameter identifier" + }, + "value": { + "type": "string", + "description": "Content parameter value" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/ConstraintRef.schema.json b/Common/ConstraintRef.schema.json index 5fabbf0a..d1d4ca85 100644 --- a/Common/ConstraintRef.schema.json +++ b/Common/ConstraintRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ConstraintRef.schema.json", - "title": "ConstraintRef", - "definitions": { - "ConstraintRef": { - "$id": "#ConstraintRef", - "type": "object", - "description": "Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.", - "properties": { - "@referredType": { - "type": "string", - "description": "The (class) type of the referred constraint" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to the target constraint" - }, - "id": { - "type": "string", - "description": "reference id to the target constraint" - }, - "name": { - "type": "string", - "description": "Name given to the constraint" - }, - "version": { - "type": "string", - "description": "constraint version" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ConstraintRef.schema.json", + "title": "ConstraintRef", + "definitions": { + "ConstraintRef": { + "$id": "#ConstraintRef", + "type": "object", + "description": "Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.", + "properties": { + "@referredType": { + "type": "string", + "description": "The (class) type of the referred constraint" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to the target constraint" + }, + "id": { + "type": "string", + "description": "reference id to the target constraint" + }, + "name": { + "type": "string", + "description": "Name given to the constraint" + }, + "version": { + "type": "string", + "description": "constraint version" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/ContactMedium.schema.json b/Common/ContactMedium.schema.json index c1318dc0..d4ecdd72 100644 --- a/Common/ContactMedium.schema.json +++ b/Common/ContactMedium.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ContactMedium.schema.json", - "title": "ContactMedium", - "definitions": { - "ContactMedium": { - "$id": "#ContactMedium", - "description": "Indicates the contact medium that could be used to contact the party.", - "type": "object", - "properties": { - "preferred": { - "type": "boolean", - "description": "If true, indicates that is the preferred contact medium" - }, - "mediumType": { - "type": "string", - "description": "Type of the contact medium, such as: email address, telephone number, postal address" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The time period that the contact medium is valid for" - }, - "characteristic": { - "$ref": "MediumCharacteristic.schema.json#MediumCharacteristic", - "description": "Any additional characteristic(s) of this contact medium" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ContactMedium.schema.json", + "title": "ContactMedium", + "definitions": { + "ContactMedium": { + "$id": "#ContactMedium", + "description": "Indicates the contact medium that could be used to contact the party.", + "type": "object", + "properties": { + "preferred": { + "type": "boolean", + "description": "If true, indicates that is the preferred contact medium" + }, + "mediumType": { + "type": "string", + "description": "Type of the contact medium, such as: email address, telephone number, postal address" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The time period that the contact medium is valid for" + }, + "characteristic": { + "$ref": "../Common/MediumCharacteristic.schema.json#MediumCharacteristic", + "description": "Any additional characteristic(s) of this contact medium" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/ContentType.schema.json b/Common/ContentType.schema.json new file mode 100644 index 00000000..c6b1d1e6 --- /dev/null +++ b/Common/ContentType.schema.json @@ -0,0 +1,30 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ContentType.schema.json", + "title": "Base64 content structure.", + "definitions": { + "ContentType": { + "$id": "#ContentType", + "type": "object", + "description": "Base64 content structure.", + "properties": { + "type": { + "type": "string", + "description": "Content type." + }, + "contentEncoding": { + "type": "string", + "format": "byte", + "description": "Base64 encoded content." + }, + "description": { + "type": "string", + "description": "Content description." + } + }, + "required": [ + "contentEncoding" + ] + } + } +} diff --git a/Common/Document.schema.json b/Common/Document.schema.json index 429ee1d3..61ab9c56 100644 --- a/Common/Document.schema.json +++ b/Common/Document.schema.json @@ -1,97 +1,97 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Document.schema.json", - "title": "Document", - "definitions": { - "Document": { - "$id": "#Document", - "description": "Document is a tangible output from an activity", - "type": "object", - "properties": { - "creationDate": { - "type": "string", - "format": "date-time", - "description": "The date and time the document was created. A date and time formatted in compliance with the ISO8601 standard must be used." - }, - "description": { - "type": "string", - "description": "Free-text description of the document" - }, - "href": { - "type": "string", - "format": "uri", - "description": "The URI for the object itself" - }, - "id": { - "type": "string", - "description": "Identifier of an instance of the document. Required to be unique within the document type. Used in URIs as the identifier for specific instances of a type." - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "The date and time the document was last modified. A date and time formatted in compliance with the ISO8601 standard must be used." - }, - "lifecycleState": { - "type": "string", - "description": "The life cycle state of the document" - }, - "name": { - "type": "string", - "description": "A string used to give a name to the document" - }, - "documentType": { - "type": "string", - "description": "The specific type of this document" - }, - "version": { - "type": "string", - "description": "A particular form or variety of an artefact that is different from others or from the original. The form represents differences in properties that characterize an artefact, that are not enough to warrant creating a new artefact" - }, - "characteristic": { - "type": "array", - "description": "Any additional characteristic(s) specific to this Document", - "items": { - "$ref": "DocumentCharacteristic.schema.json#DocumentCharacteristic" - } - }, - "relatedParty": { - "type": "array", - "description": "Any Parties related to this Document (eg: author)", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "documentSpecification": { - "description": "The specification or this Document", - "$ref": "DocumentSpecification.schema.json#DocumentSpecification" - }, - "binaryAttachment": { - "type": "array", - "items": { - "$ref": "DocumentAttachment.schema.json#DocumentAttachment" - } - }, - "category": { - "type": "array", - "items": { - "$ref": "../Product/CategoryRef.schema.json#CategoryRef" - } - }, - "documentRelationship": { - "type": "array", - "items": { - "$ref": "DocumentRelationship.schema.json#DocumentRelationship" - } - }, - "relatedObject": { - "$ref": "RelatedObject.schema.json#RelatedObject" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Document.schema.json", + "title": "Document", + "definitions": { + "Document": { + "$id": "#Document", + "description": "Document is a tangible output from an activity", + "type": "object", + "properties": { + "creationDate": { + "type": "string", + "format": "date-time", + "description": "The date and time the document was created. A date and time formatted in compliance with the ISO8601 standard must be used." + }, + "description": { + "type": "string", + "description": "Free-text description of the document" + }, + "href": { + "type": "string", + "format": "uri", + "description": "The URI for the object itself" + }, + "id": { + "type": "string", + "description": "Identifier of an instance of the document. Required to be unique within the document type. Used in URIs as the identifier for specific instances of a type." + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "The date and time the document was last modified. A date and time formatted in compliance with the ISO8601 standard must be used." + }, + "lifecycleState": { + "type": "string", + "description": "The life cycle state of the document" + }, + "name": { + "type": "string", + "description": "A string used to give a name to the document" + }, + "documentType": { + "type": "string", + "description": "The specific type of this document" + }, + "version": { + "type": "string", + "description": "A particular form or variety of an artefact that is different from others or from the original. The form represents differences in properties that characterize an artefact, that are not enough to warrant creating a new artefact" + }, + "characteristic": { + "type": "array", + "description": "Any additional characteristic(s) specific to this Document", + "items": { + "$ref": "../Common/DocumentCharacteristic.schema.json#DocumentCharacteristic" + } + }, + "relatedParty": { + "type": "array", + "description": "Any Parties related to this Document (eg: author)", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "documentSpecification": { + "description": "The specification or this Document", + "$ref": "../Common/DocumentSpecification.schema.json#DocumentSpecification" + }, + "binaryAttachment": { + "type": "array", + "items": { + "$ref": "../Common/DocumentAttachment.schema.json#DocumentAttachment" + } + }, + "category": { + "type": "array", + "items": { + "$ref": "../Product/CategoryRef.schema.json#CategoryRef" + } + }, + "documentRelationship": { + "type": "array", + "items": { + "$ref": "../Common/DocumentRelationship.schema.json#DocumentRelationship" + } + }, + "relatedObject": { + "$ref": "../Common/RelatedObject.schema.json#RelatedObject" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/DocumentAttachment.schema.json b/Common/DocumentAttachment.schema.json index 5cafa1d8..655665a6 100644 --- a/Common/DocumentAttachment.schema.json +++ b/Common/DocumentAttachment.schema.json @@ -1,56 +1,56 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DocumentAttachment.schema.json", - "title": "DocumentAttachment", - "definitions": { - "DocumentAttachment": { - "$id": "#DocumentAttachment", - "description": "Attachment refers to extensions or additional parts that is or may be attached to something (agreements, contracts, appointments) to perform a particular function. They can be communication attachments, documents and other.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description of the binary attachment" - }, - "id": { - "type": "string", - "description": "Identifier of the binary attachment" - }, - "mimeType": { - "type": "string", - "description": "mimeType of the Attachment, such as: application/pdf" - }, - "name": { - "type": "string", - "description": "Name of the binary attachment" - }, - "size": { - "type": "integer", - "description": "The size of the document or attachment. If this component contains the embedded data then the size is the size of the embedded data; if it is a reference without the data then it is the size of the referenced document" - }, - "sizeUnit": { - "type": "string", - "description": "The unit of measure for the size" - }, - "attachmentType": { - "type": "string", - "description": "Identifies the sub-type of the instance of binary attachment" - }, - "URL": { - "type": "string", - "format": "uri", - "description": "URL of the Attachment" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "Validity period of the Attachment" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DocumentAttachment.schema.json", + "title": "DocumentAttachment", + "definitions": { + "DocumentAttachment": { + "$id": "#DocumentAttachment", + "description": "Attachment refers to extensions or additional parts that is or may be attached to something (agreements, contracts, appointments) to perform a particular function. They can be communication attachments, documents and other.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of the binary attachment" + }, + "id": { + "type": "string", + "description": "Identifier of the binary attachment" + }, + "mimeType": { + "type": "string", + "description": "mimeType of the Attachment, such as: application/pdf" + }, + "name": { + "type": "string", + "description": "Name of the binary attachment" + }, + "size": { + "type": "integer", + "description": "The size of the document or attachment. If this component contains the embedded data then the size is the size of the embedded data; if it is a reference without the data then it is the size of the referenced document" + }, + "sizeUnit": { + "type": "string", + "description": "The unit of measure for the size" + }, + "attachmentType": { + "type": "string", + "description": "Identifies the sub-type of the instance of binary attachment" + }, + "URL": { + "type": "string", + "format": "uri", + "description": "URL of the Attachment" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Validity period of the Attachment" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/DocumentCharacteristic.schema.json b/Common/DocumentCharacteristic.schema.json index 95cd4dab..9e0dd4a9 100644 --- a/Common/DocumentCharacteristic.schema.json +++ b/Common/DocumentCharacteristic.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DocumentCharacteristic.schema.json", - "title": "DocumentCharacteristic", - "definitions": { - "DocumentCharacteristic": { - "$id": "#DocumentCharacteristic", - "description": "is a list of name value pairs that define the document characteristics.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "name of the characteristic" - }, - "value": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DocumentCharacteristic.schema.json", + "title": "DocumentCharacteristic", + "definitions": { + "DocumentCharacteristic": { + "$id": "#DocumentCharacteristic", + "description": "is a list of name value pairs that define the document characteristics.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "name of the characteristic" + }, + "value": { + "type": "string" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/DocumentRef.schema.json b/Common/DocumentRef.schema.json index 8325c1b0..c5e35214 100644 --- a/Common/DocumentRef.schema.json +++ b/Common/DocumentRef.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DocumentRef.schema.json", - "title": "DocumentRef", - "definitions": { - "DocumentRef": { - "$id": "#DocumentRef", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URI for the object itself." - }, - "id": { - "type": "string", - "description": "Identifier of the document" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DocumentRef.schema.json", + "title": "DocumentRef", + "definitions": { + "DocumentRef": { + "$id": "#DocumentRef", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URI for the object itself." + }, + "id": { + "type": "string", + "description": "Identifier of the document" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/DocumentRelationship.schema.json b/Common/DocumentRelationship.schema.json index 6ee3c148..c14f5fb3 100644 --- a/Common/DocumentRelationship.schema.json +++ b/Common/DocumentRelationship.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DocumentRelationship.schema.json", - "title": "DocumentRelationship", - "definitions": { - "DocumentRelationship": { - "$id": "#DocumentRelationship", - "description": "Another document that is related to the current document;", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "The type of relationship" - }, - "documentRef": { - "$ref": "DocumentRef.schema.json#DocumentRef" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DocumentRelationship.schema.json", + "title": "DocumentRelationship", + "definitions": { + "DocumentRelationship": { + "$id": "#DocumentRelationship", + "description": "Another document that is related to the current document;", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of relationship" + }, + "documentRef": { + "$ref": "../Common/DocumentRef.schema.json#DocumentRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/DocumentSpecification.schema.json b/Common/DocumentSpecification.schema.json index 08d7a27a..8e798c83 100644 --- a/Common/DocumentSpecification.schema.json +++ b/Common/DocumentSpecification.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DocumentSpecification.schema.json", - "title": "DocumentSpecification", - "definitions": { - "DocumentSpecification": { - "$id": "#DocumentSpecification", - "description": "A document specification reference", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URI for the object itself." - }, - "id": { - "type": "string", - "description": "Identifier of the DocumentSpecification" - }, - "name": { - "type": "string", - "description": "a String. Name of the DocumentSpecification" - }, - "URL": { - "type": "string", - "format": "uri", - "description": "URL of the Document Specification" - }, - "version": { - "type": "string", - "description": "A string, a version of the DocumentSpecification." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DocumentSpecification.schema.json", + "title": "DocumentSpecification", + "definitions": { + "DocumentSpecification": { + "$id": "#DocumentSpecification", + "description": "A document specification reference", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URI for the object itself." + }, + "id": { + "type": "string", + "description": "Identifier of the DocumentSpecification" + }, + "name": { + "type": "string", + "description": "a String. Name of the DocumentSpecification" + }, + "URL": { + "type": "string", + "format": "uri", + "description": "URL of the Document Specification" + }, + "version": { + "type": "string", + "description": "A string, a version of the DocumentSpecification." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Duration.schema.json b/Common/Duration.schema.json index ed45f0fa..7e9ae061 100644 --- a/Common/Duration.schema.json +++ b/Common/Duration.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Duration.schema.json", - "title": "Duration", - "definitions": { - "Duration": { - "$id": "#Duration", - "type": "object", - "description": "A time interval in a given unit of time", - "properties": { - "amount": { - "type": "integer", - "description": "Time interval (number of seconds, minutes, hours, etc.)" - }, - "units": { - "type": "string", - "description": "Unit of time (seconds, minutes, hours, etc.)" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Duration.schema.json", + "title": "Duration", + "definitions": { + "Duration": { + "$id": "#Duration", + "type": "object", + "description": "A time interval in a given unit of time", + "properties": { + "amount": { + "type": "integer", + "description": "Time interval (number of seconds, minutes, hours, etc.)" + }, + "units": { + "type": "string", + "description": "Unit of time (seconds, minutes, hours, etc.)" } + } } -} \ No newline at end of file + } +} diff --git a/Common/Entity.schema.json b/Common/Entity.schema.json index d3d44081..9bee435e 100644 --- a/Common/Entity.schema.json +++ b/Common/Entity.schema.json @@ -1,45 +1,45 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Entity.schema.json", - "title": "Entity", - "definitions": { - "Entity": { - "$id": "#Entity", - "type": "object", - "description": "Base entity schema for use in TMForum Open-APIs", - "discriminator": "@type", - "properties": { - "@schemaLocation": { - "type": "string", - "format": "uri", - "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", - "examples": [ - "http://host/schemas/Subclass.schema.json" - ] - }, - "@baseType": { - "type": "string", - "description": "When sub-classing, this defines the super-class", - "examples": [ - "Place", - "ServiceSpecification" - ] - }, - "@type": { - "type": "string", - "description": "When sub-classing, this defines the sub-class entity name", - "examples": [ - "VendorProductOffering", - "DroneServiceSpecification" - ] - } - }, - "dependencies": { - "@schemaLocation": [ - "@baseType", - "@type" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Entity.schema.json", + "title": "Entity", + "definitions": { + "Entity": { + "$id": "#Entity", + "type": "object", + "description": "Base entity schema for use in TMForum Open-APIs", + "discriminator": "@type", + "properties": { + "@schemaLocation": { + "type": "string", + "format": "uri", + "description": "A URI to a JSON-Schema file that defines additional attributes and relationships", + "examples": [ + "http://host/schemas/Subclass.schema.json" + ] + }, + "@baseType": { + "type": "string", + "description": "When sub-classing, this defines the super-class", + "examples": [ + "Place", + "ServiceSpecification" + ] + }, + "@type": { + "type": "string", + "description": "When sub-classing, this defines the sub-class entity name", + "examples": [ + "VendorProductOffering", + "DroneServiceSpecification" + ] } + }, + "dependencies": { + "@schemaLocation": [ + "@baseType", + "@type" + ] + } } -} \ No newline at end of file + } +} diff --git a/Common/EntityAttachment.schema.json b/Common/EntityAttachment.schema.json index 5714b6c0..94ec4014 100644 --- a/Common/EntityAttachment.schema.json +++ b/Common/EntityAttachment.schema.json @@ -1,48 +1,48 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntityAttachment.schema.json", - "title": "EntityAttachment", - "definitions": { - "EntityAttachment": { - "$id": "#EntityAttachment", - "description": "Complements the description of an entity through video, pictures...", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative text describing the content of the attachment" - }, - "href": { - "type": "string", - "description": "Reference of the attachment" - }, - "id": { - "type": "string", - "description": "Unique identifier of the attachment" - }, - "mimeType": { - "type": "string", - "description": "Attachment mime type such as extension file for video, picture and document" - }, - "name": { - "type": "string", - "description": "name given to the attachment" - }, - "uri": { - "type": "string", - "format": "uri", - "description": "Uniform Resource Identifier (URI) of the attachment" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which this attachment is valid" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntityAttachment.schema.json", + "title": "EntityAttachment", + "definitions": { + "EntityAttachment": { + "$id": "#EntityAttachment", + "description": "Complements the description of an entity through video, pictures...", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative text describing the content of the attachment" + }, + "href": { + "type": "string", + "description": "Reference of the attachment" + }, + "id": { + "type": "string", + "description": "Unique identifier of the attachment" + }, + "mimeType": { + "type": "string", + "description": "Attachment mime type such as extension file for video, picture and document" + }, + "name": { + "type": "string", + "description": "name given to the attachment" + }, + "uri": { + "type": "string", + "format": "uri", + "description": "Uniform Resource Identifier (URI) of the attachment" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which this attachment is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/EntityCatalog.schema.json b/Common/EntityCatalog.schema.json index 5107a28c..ca7c258a 100644 --- a/Common/EntityCatalog.schema.json +++ b/Common/EntityCatalog.schema.json @@ -1,52 +1,52 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntityCatalog.schema.json", - "title": "EntityCatalog", - "definitions": { - "EntityCatalog": { - "$id": "#EntityCatalog", - "description": "The root entity for entity catalog management. An entity catalog can be defined as a collection of entity catalog items and arranging them in a particular manner based on the need.\nIn comparison to Product, Service and Resource catalogs, the entity catalog is intended for the purpose of providing any SID entity to consumers via a catalog, with its specification and policy providing governance over its content. Even Entity catalog may have an overlap with Product, Service or Resource catalog, it does not replace them. It is primarily intended to address those SID entities which may not be addressed by any of Product, Service or Resource catalog.\nAn entity catalog comprises of a list of RootEntities made available through EntityCatalogItems. This API addresses only RootEntity extended items as EntitySpecification. An entity catalog typically includes name, description and time period that it is valid for.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of this catalog" - }, - "href": { - "type": "string", - "description": "Unique reference of the catalog" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Catalog" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the catalog" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which the catalog is valid" - }, - "version": { - "type": "string", - "description": "Catalog version" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntityCatalog.schema.json", + "title": "EntityCatalog", + "definitions": { + "EntityCatalog": { + "$id": "#EntityCatalog", + "description": "The root entity for entity catalog management. An entity catalog can be defined as a collection of entity catalog items and arranging them in a particular manner based on the need.\nIn comparison to Product, Service and Resource catalogs, the entity catalog is intended for the purpose of providing any SID entity to consumers via a catalog, with its specification and policy providing governance over its content. Even Entity catalog may have an overlap with Product, Service or Resource catalog, it does not replace them. It is primarily intended to address those SID entities which may not be addressed by any of Product, Service or Resource catalog.\nAn entity catalog comprises of a list of RootEntities made available through EntityCatalogItems. This API addresses only RootEntity extended items as EntitySpecification. An entity catalog typically includes name, description and time period that it is valid for.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of this catalog" + }, + "href": { + "type": "string", + "description": "Unique reference of the catalog" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Catalog" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the catalog" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the catalog is valid" + }, + "version": { + "type": "string", + "description": "Catalog version" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/EntityCatalogItem.schema.json b/Common/EntityCatalogItem.schema.json index ef94fd5c..4378089e 100644 --- a/Common/EntityCatalogItem.schema.json +++ b/Common/EntityCatalogItem.schema.json @@ -1,52 +1,52 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntityCatalogItem.schema.json", - "title": "EntityCatalogItem", - "definitions": { - "EntityCatalogItem": { - "$id": "#EntityCatalogItem", - "description": "An EntityCatalogItem is an entity that allows any ProductOffering, ServiceCandidate, ResourceCandidate, or even any object inheriting from RootEntity, to be available to a catalog. The CatalogSpecification and Policy of the catalog governs the content of the EntityCatalogItem. This API addresses only EntitySpecification items extended from RootEntity as EntityCatalogItem.\nThe EntityCatalogItem resource (JSON format) represents a set of characteristics that define the values given by the EntityCatalogItem.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of this REST resource" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to this REST resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of this REST resource" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update of this REST resource" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status of this catalog item" - }, - "name": { - "type": "string", - "description": "Name given to this REST resource" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which this REST resource is valid" - }, - "version": { - "type": "string", - "description": "EntityCatalogItem version" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntityCatalogItem.schema.json", + "title": "EntityCatalogItem", + "definitions": { + "EntityCatalogItem": { + "$id": "#EntityCatalogItem", + "description": "An EntityCatalogItem is an entity that allows any ProductOffering, ServiceCandidate, ResourceCandidate, or even any object inheriting from RootEntity, to be available to a catalog. The CatalogSpecification and Policy of the catalog governs the content of the EntityCatalogItem. This API addresses only EntitySpecification items extended from RootEntity as EntityCatalogItem.\nThe EntityCatalogItem resource (JSON format) represents a set of characteristics that define the values given by the EntityCatalogItem.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of this REST resource" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to this REST resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of this REST resource" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update of this REST resource" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status of this catalog item" + }, + "name": { + "type": "string", + "description": "Name given to this REST resource" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which this REST resource is valid" + }, + "version": { + "type": "string", + "description": "EntityCatalogItem version" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/EntityCatalogItemRef.schema.json b/Common/EntityCatalogItemRef.schema.json index 09b92953..097c5cc3 100644 --- a/Common/EntityCatalogItemRef.schema.json +++ b/Common/EntityCatalogItemRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntityCatalogItemRef.schema.json", - "title": "EntityCatalogItemRef", - "definitions": { - "EntityCatalogItemRef": { - "$id": "#EntityCatalogItemRef", - "description": "reference to EntityCatalogItem object", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink reference to the target EntityCatalogItem" - }, - "id": { - "type": "string", - "description": "reference id to the target EntityCatalogItem" - }, - "name": { - "type": "string", - "description": "Name given to the EntityCatalogItem" - }, - "version": { - "type": "string", - "description": "EntityCatalogItem version" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntityCatalogItemRef.schema.json", + "title": "EntityCatalogItemRef", + "definitions": { + "EntityCatalogItemRef": { + "$id": "#EntityCatalogItemRef", + "description": "reference to EntityCatalogItem object", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink reference to the target EntityCatalogItem" + }, + "id": { + "type": "string", + "description": "reference id to the target EntityCatalogItem" + }, + "name": { + "type": "string", + "description": "Name given to the EntityCatalogItem" + }, + "version": { + "type": "string", + "description": "EntityCatalogItem version" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/EntityCategory.schema.json b/Common/EntityCategory.schema.json index 1c4a18e9..a69af2ea 100644 --- a/Common/EntityCategory.schema.json +++ b/Common/EntityCategory.schema.json @@ -1,60 +1,60 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntityCategory.schema.json", - "title": "EntityCategory", - "definitions": { - "EntityCategory": { - "$id": "#EntityCategory", - "description": "The (entity) category resource is used to group entity catalog items in logical containers. Categories can contain other categories.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the category" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to the category" - }, - "id": { - "type": "string", - "description": "Unique identifier of the category" - }, - "isRoot": { - "type": "boolean", - "description": "If true, this Boolean indicates that the category is a root of categories" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the category" - }, - "parentId": { - "type": "string", - "description": "Unique identifier of the parent category" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which the category is valid" - }, - "version": { - "type": "string", - "description": "Category version" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntityCategory.schema.json", + "title": "EntityCategory", + "definitions": { + "EntityCategory": { + "$id": "#EntityCategory", + "description": "The (entity) category resource is used to group entity catalog items in logical containers. Categories can contain other categories.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the category" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to the category" + }, + "id": { + "type": "string", + "description": "Unique identifier of the category" + }, + "isRoot": { + "type": "boolean", + "description": "If true, this Boolean indicates that the category is a root of categories" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the category" + }, + "parentId": { + "type": "string", + "description": "Unique identifier of the parent category" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the category is valid" + }, + "version": { + "type": "string", + "description": "Category version" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/EntityRef.schema.json b/Common/EntityRef.schema.json index 8d35bab6..f62e9d94 100644 --- a/Common/EntityRef.schema.json +++ b/Common/EntityRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntityRef.schema.json", - "title": "EntityRef", - "definitions": { - "EntityRef": { - "$id": "#EntityRef", - "description": "Entity reference schema to be use for all entityRef class.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of a related entity." - }, - "href": { - "type": "string", - "description": "Reference of the related entity." - }, - "name": { - "type": "string", - "description": "Name of the related entity." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntityRef.schema.json", + "title": "EntityRef", + "definitions": { + "EntityRef": { + "$id": "#EntityRef", + "description": "Entity reference schema to be use for all entityRef class.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of a related entity." + }, + "href": { + "type": "string", + "description": "Reference of the related entity." + }, + "name": { + "type": "string", + "description": "Name of the related entity." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/EntitySchemaRef.schema.json b/Common/EntitySchemaRef.schema.json index 299a602a..11fe1f37 100644 --- a/Common/EntitySchemaRef.schema.json +++ b/Common/EntitySchemaRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntitySchemaRef.schema.json", - "title": "EntitySchemaRef", - "definitions": { - "EntitySchemaRef": { - "$id": "#EntitySchemaRef", - "description": "The reference object to the schema and type of target entity which is described by an entity specification", - "type": "object", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntitySchemaRef.schema.json", + "title": "EntitySchemaRef", + "definitions": { + "EntitySchemaRef": { + "$id": "#EntitySchemaRef", + "description": "The reference object to the schema and type of target entity which is described by an entity specification", + "type": "object", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/EntitySpecRelationship.schema.json b/Common/EntitySpecRelationship.schema.json index eae83851..bc1f8a7b 100644 --- a/Common/EntitySpecRelationship.schema.json +++ b/Common/EntitySpecRelationship.schema.json @@ -1,46 +1,46 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntitySpecRelationship.schema.json", - "title": "EntitySpecRelationship", - "definitions": { - "EntitySpecRelationship": { - "$id": "#EntitySpecRelationship", - "description": "A migration, substitution, dependency or exclusivity relationship between/among entity specifications.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the target EntitySpecification" - }, - "id": { - "type": "string", - "description": "Unique identifier of target EntitySpecification" - }, - "name": { - "type": "string", - "description": "The name given to the target entity specification instance" - }, - "role": { - "type": "string", - "description": "The association role for this entity specification" - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship such as migration, substitution, dependency, exclusivity" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which the entitySpecRelationship is valid" - }, - "associationSpec": { - "$ref": "AssociationSpecRef.schema.json#AssociationSpecRef" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntitySpecRelationship.schema.json", + "title": "EntitySpecRelationship", + "definitions": { + "EntitySpecRelationship": { + "$id": "#EntitySpecRelationship", + "description": "A migration, substitution, dependency or exclusivity relationship between/among entity specifications.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the target EntitySpecification" + }, + "id": { + "type": "string", + "description": "Unique identifier of target EntitySpecification" + }, + "name": { + "type": "string", + "description": "The name given to the target entity specification instance" + }, + "role": { + "type": "string", + "description": "The association role for this entity specification" + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship such as migration, substitution, dependency, exclusivity" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the entitySpecRelationship is valid" + }, + "associationSpec": { + "$ref": "../Common/AssociationSpecRef.schema.json#AssociationSpecRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/EntitySpecification.schema.json b/Common/EntitySpecification.schema.json index 5e2cafc6..7861dbad 100644 --- a/Common/EntitySpecification.schema.json +++ b/Common/EntitySpecification.schema.json @@ -1,73 +1,73 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntitySpecification.schema.json", - "title": "EntitySpecification", - "definitions": { - "EntitySpecification": { - "$id": "#EntitySpecification", - "description": "EntitySpecification is a class that offers characteristics to describe a type of entity. Entities are generic constructs that may be used to describe bespoke business entities that are not effectively covered by the existing SID model.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of this REST resource" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to this REST resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of this REST resource" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update of this REST resource" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status of this catalog item" - }, - "name": { - "type": "string", - "description": "Name given to this REST resource" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which this REST resource is valid" - }, - "version": { - "type": "string", - "description": "Entity specification version" - }, - "attachment": { - "type": "array", - "items": { - "$ref": "EntityAttachment.schema.json#EntityAttachment" - } - }, - "entitySchema": { - "$ref": "EntitySchemaRef.schema.json#EntitySchemaRef" - }, - "specCharacteristic": { - "type": "array", - "items": { - "$ref": "SpecCharacteristic.schema.json#SpecCharacteristic" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntitySpecification.schema.json", + "title": "EntitySpecification", + "definitions": { + "EntitySpecification": { + "$id": "#EntitySpecification", + "description": "EntitySpecification is a class that offers characteristics to describe a type of entity. Entities are generic constructs that may be used to describe bespoke business entities that are not effectively covered by the existing SID model.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of this REST resource" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to this REST resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of this REST resource" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update of this REST resource" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status of this catalog item" + }, + "name": { + "type": "string", + "description": "Name given to this REST resource" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which this REST resource is valid" + }, + "version": { + "type": "string", + "description": "Entity specification version" + }, + "attachment": { + "type": "array", + "items": { + "$ref": "../Common/EntityAttachment.schema.json#EntityAttachment" + } + }, + "entitySchema": { + "$ref": "../Common/EntitySchemaRef.schema.json#EntitySchemaRef" + }, + "specCharacteristic": { + "type": "array", + "items": { + "$ref": "../Common/SpecCharacteristic.schema.json#SpecCharacteristic" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/EntitySpecificationRef.schema.json b/Common/EntitySpecificationRef.schema.json index f26cb943..584974ab 100644 --- a/Common/EntitySpecificationRef.schema.json +++ b/Common/EntitySpecificationRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EntitySpecificationRef.schema.json", - "title": "EntitySpecificationRef", - "definitions": { - "EntitySpecificationRef": { - "$id": "#EntitySpecificationRef", - "description": "reference to an EntitySpecification object", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink reference to the target EntitySpecification" - }, - "id": { - "type": "string", - "description": "reference id to the target EntitySpecification" - }, - "name": { - "type": "string", - "description": "Name given to the EntitySpecification" - }, - "version": { - "type": "string", - "description": "EntitySpecification version" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EntitySpecificationRef.schema.json", + "title": "EntitySpecificationRef", + "definitions": { + "EntitySpecificationRef": { + "$id": "#EntitySpecificationRef", + "description": "reference to an EntitySpecification object", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink reference to the target EntitySpecification" + }, + "id": { + "type": "string", + "description": "reference id to the target EntitySpecification" + }, + "name": { + "type": "string", + "description": "Name given to the EntitySpecification" + }, + "version": { + "type": "string", + "description": "EntitySpecification version" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Error.schema.json b/Common/Error.schema.json index 04da2f9d..d7257b73 100644 --- a/Common/Error.schema.json +++ b/Common/Error.schema.json @@ -1,64 +1,64 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Error.schema.json", - "title": "Error", - "definitions": { - "Error": { - "$id": "#Error", - "description": "Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)", - "type": "object", - "required": [ - "code", - "reason" - ], - "properties": { - "code": { - "type": "integer", - "description": "Application relevant detail, defined in the API or a common list", - "examples": [ - "1", - "2" - ] - }, - "reason": { - "type": "string", - "description": "Explanation of the reason for the error which can be shown to a client user", - "examples": [ - "This customer does not exist", - "The service is not available at this location" - ] - }, - "message": { - "type": "string", - "description": "More details and corrective actions related to the error which can be shown to a client user", - "examples": [ - "Please use a valid password", - "Please enter a smaller quantity" - ] - }, - "status": { - "type": "string", - "description": "HTTP Error code extension", - "examples": [ - "400-2", - "500-4" - ] - }, - "referenceError": { - "type": "string", - "format": "uri", - "description": "URI of documentation describing the error", - "examples": [ - "https://docs.microsoft.com/en-us/windows/desktop/wmdm/error-codes", - "https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html" - ] - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Error.schema.json", + "title": "Error", + "definitions": { + "Error": { + "$id": "#Error", + "description": "Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)", + "type": "object", + "required": [ + "code", + "reason" + ], + "properties": { + "code": { + "type": "integer", + "description": "Application relevant detail, defined in the API or a common list", + "examples": [ + "1", + "2" + ] + }, + "reason": { + "type": "string", + "description": "Explanation of the reason for the error which can be shown to a client user", + "examples": [ + "This customer does not exist", + "The service is not available at this location" + ] + }, + "message": { + "type": "string", + "description": "More details and corrective actions related to the error which can be shown to a client user", + "examples": [ + "Please use a valid password", + "Please enter a smaller quantity" + ] + }, + "status": { + "type": "string", + "description": "HTTP Error code extension", + "examples": [ + "400-2", + "500-4" + ] + }, + "referenceError": { + "type": "string", + "format": "uri", + "description": "URI of documentation describing the error", + "examples": [ + "https://docs.microsoft.com/en-us/windows/desktop/wmdm/error-codes", + "https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html" + ] } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Event.schema.json b/Common/Event.schema.json new file mode 100644 index 00000000..9faa8843 --- /dev/null +++ b/Common/Event.schema.json @@ -0,0 +1,61 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Event.schema.json", + "title": "Event", + "definitions": { + "Event": { + "$id": "#Event", + "description": "event with common attributes.", + "type": "object", + "properties": { + "eventId": { + "type": "string", + "description": "The identifier of the notification." + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "Time of the event occurrence." + }, + "eventType": { + "type": "string", + "description": "The type of the notification." + }, + "correlationId": { + "type": "string", + "description": "The correlation id for this event." + }, + "domain": { + "type": "string", + "description": "The domain of the event." + }, + "title": { + "type": "string", + "description": "The title of the event." + }, + "description": { + "type": "string", + "description": "An explnatory of the event." + }, + "priority": { + "type": "string", + "description": "A priority." + }, + "timeOcurred": { + "type": "string", + "format": "date-time", + "description": "The time the event occured." + }, + "event": { + "description": "The event linked to the involved resource object", + "$ref": "../Common/Any.schema.json#Any" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] + } + } +} diff --git a/Common/EventRef.schema.json b/Common/EventRef.schema.json index 5c437373..6b1e9138 100644 --- a/Common/EventRef.schema.json +++ b/Common/EventRef.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EventRef.schema.json", - "title": "EventRef", - "definitions": { - "EventRef": { - "$id": "#EventRef", - "type": "object", - "description": "Events linked with service problem", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "eventTime": { - "type": "string", - "format": "date-time", - "description": "Time the event occurred" - }, - "eventType": { - "type": "string", - "description": "Type of the event" - }, - "href": { - "type": "string", - "description": "event reference" - }, - "id": { - "type": "string", - "description": "ID of the event" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EventRef.schema.json", + "title": "EventRef", + "definitions": { + "EventRef": { + "$id": "#EventRef", + "type": "object", + "description": "Events linked with service problem", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "Time the event occurred" + }, + "eventType": { + "type": "string", + "description": "Type of the event" + }, + "href": { + "type": "string", + "description": "event reference" + }, + "id": { + "type": "string", + "description": "ID of the event" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/ExportJob.schema.json b/Common/ExportJob.schema.json index 5b0264d4..d2fdd70f 100644 --- a/Common/ExportJob.schema.json +++ b/Common/ExportJob.schema.json @@ -1,62 +1,62 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ExportJob.schema.json", - "title": "ExportJob", - "definitions": { - "ExportJob": { - "$id": "#ExportJob", - "description": "Represents a task used to export resources to a file", - "type": "object", - "properties": { - "completionDate": { - "type": "string", - "format": "date-time", - "description": "Data at which the job was completed" - }, - "contentType": { - "type": "string", - "description": "The format of the exported data" - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the job was created" - }, - "errorLog": { - "type": "string", - "description": "Reason for failure" - }, - "href": { - "type": "string", - "description": "Reference of the export job" - }, - "id": { - "type": "string", - "description": "Identifier of the export job" - }, - "path": { - "type": "string", - "description": "URL of the root resource acting as the source for streaming content to the file specified by the export job" - }, - "query": { - "type": "string", - "description": "Used to scope the exported data" - }, - "status": { - "description": "Status of the export job (not started, running, succeeded, failed)", - "$ref": "JobStateType.schema.json#JobStateType" - }, - "url": { - "type": "string", - "format": "uri", - "description": "URL of the file containing the data to be exported" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ExportJob.schema.json", + "title": "ExportJob", + "definitions": { + "ExportJob": { + "$id": "#ExportJob", + "description": "Represents a task used to export resources to a file", + "type": "object", + "properties": { + "completionDate": { + "type": "string", + "format": "date-time", + "description": "Data at which the job was completed" + }, + "contentType": { + "type": "string", + "description": "The format of the exported data" + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the job was created" + }, + "errorLog": { + "type": "string", + "description": "Reason for failure" + }, + "href": { + "type": "string", + "description": "Reference of the export job" + }, + "id": { + "type": "string", + "description": "Identifier of the export job" + }, + "path": { + "type": "string", + "description": "URL of the root resource acting as the source for streaming content to the file specified by the export job" + }, + "query": { + "type": "string", + "description": "Used to scope the exported data" + }, + "status": { + "description": "Status of the export job (not started, running, succeeded, failed)", + "$ref": "../Common/JobStateType.schema.json#JobStateType" + }, + "url": { + "type": "string", + "format": "uri", + "description": "URL of the file containing the data to be exported" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/ExternalReference.schema.json b/Common/ExternalReference.schema.json index 23aea5cf..6731d057 100644 --- a/Common/ExternalReference.schema.json +++ b/Common/ExternalReference.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ExternalReference.schema.json", - "title": "ExternalReference", - "definitions": { - "ExternalReference": { - "$id": "#ExternalReference", - "type": "object", - "description": "External reference of the individual or reference in other system", - "properties": { - "externalReferenceType": { - "type": "string", - "description": "Type of the external reference" - }, - "name": { - "type": "string", - "description": "External reference name" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ExternalReference.schema.json", + "title": "ExternalReference", + "definitions": { + "ExternalReference": { + "$id": "#ExternalReference", + "type": "object", + "description": "External reference of the individual or reference in other system", + "properties": { + "externalReferenceType": { + "type": "string", + "description": "Type of the external reference" + }, + "name": { + "type": "string", + "description": "External reference name" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/FileDocument.schema.json b/Common/FileDocument.schema.json index 3c9912da..3e8f203c 100644 --- a/Common/FileDocument.schema.json +++ b/Common/FileDocument.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "FileDocument.schema.json", - "title": "FileDocument", - "definitions": { - "FileDocument": { - "$id": "#FileDocument", - "description": "A document accompanying an entity", - "type": "object", - "properties": { - "downloadUrl": { - "type": "string", - "format": "uri", - "description": "URL where the document could be downloaded" - }, - "fileType": { - "type": "string", - "description": "Document file format of the file : csv, pdf, xls, txt... for example" - }, - "name": { - "type": "string", - "description": "Document name" - }, - "size": { - "type": "integer", - "description": "Document file size (by default in bytes)" - }, - "sizeUnit": { - "type": "integer", - "description": "Size unit (in bytes by default)" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "FileDocument.schema.json", + "title": "FileDocument", + "definitions": { + "FileDocument": { + "$id": "#FileDocument", + "description": "A document accompanying an entity", + "type": "object", + "properties": { + "downloadUrl": { + "type": "string", + "format": "uri", + "description": "URL where the document could be downloaded" + }, + "fileType": { + "type": "string", + "description": "Document file format of the file : csv, pdf, xls, txt... for example" + }, + "name": { + "type": "string", + "description": "Document name" + }, + "size": { + "type": "integer", + "description": "Document file size (by default in bytes)" + }, + "sizeUnit": { + "type": "integer", + "description": "Size unit (in bytes by default)" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/FloatCharacteristic.schema.json b/Common/FloatCharacteristic.schema.json index cb7535d8..85a0a569 100644 --- a/Common/FloatCharacteristic.schema.json +++ b/Common/FloatCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "FloatCharacteristic.schema.json", - "title": "FloatCharacteristic", - "definitions": { - "FloatCharacteristic": { - "$id": "#FloatCharacteristic", - "description": "A characteristic which value is a float number", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "valueType": { - "type": "string", - "description": "Data type of the value of the characteristic" - }, - "value": { - "type": "number", - "format": "float", - "description": "Value of the characteristic" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "FloatCharacteristic.schema.json", + "title": "FloatCharacteristic", + "definitions": { + "FloatCharacteristic": { + "$id": "#FloatCharacteristic", + "description": "A characteristic which value is a float number", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "valueType": { + "type": "string", + "description": "Data type of the value of the characteristic" + }, + "value": { + "type": "number", + "format": "float", + "description": "Value of the characteristic" } + } } -} \ No newline at end of file + } +} diff --git a/Common/GeographicAddress.schema.json b/Common/GeographicAddress.schema.json index 4f7ff306..d95b7912 100644 --- a/Common/GeographicAddress.schema.json +++ b/Common/GeographicAddress.schema.json @@ -1,76 +1,76 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicAddress.schema.json", - "title": "GeographicAddress", - "definitions": { - "GeographicAddress": { - "$id": "#GeographicAddress", - "description": "Structured textual way of describing how to find a Property in an urban area (country properties are often defined differently).\nNote : Address corresponds to SID UrbanPropertyAddress", - "type": "object", - "properties": { - "city": { - "type": "string", - "description": "City that the address is in" - }, - "country": { - "type": "string", - "description": "Country that the address is in" - }, - "locality": { - "type": "string", - "description": "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature. [ANZLIC-STREET], or a suburb, a bounded locality within a city, town or shire principally of urban character [ANZLICSTREET]" - }, - "postcode": { - "type": "string", - "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" - }, - "stateOrProvince": { - "type": "string", - "description": "the State or Province that the address is in" - }, - "streetName": { - "type": "string", - "description": "Name of the street or other street type" - }, - "streetNr": { - "type": "string", - "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" - }, - "streetNrLast": { - "type": "string", - "description": "Last number in a range of street numbers allocated to a property" - }, - "streetNrLastSuffix": { - "type": "string", - "description": "Last street number suffix for a ranged address" - }, - "streetNrSuffix": { - "type": "string", - "description": "the first street number suffix" - }, - "streetSuffix": { - "type": "string", - "description": "A modifier denoting a relative direction" - }, - "streetType": { - "type": "string", - "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf " - }, - "geographicLocation": { - "$ref": "GeographicLocation.schema.json#GeographicLocation" - }, - "geographicSubAddress": { - "type": "array", - "items": { - "$ref": "GeographicSubAddress.schema.json#GeographicSubAddress" - } - } - }, - "allOf": [ - { - "$ref": "Place.schema.json#Place" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicAddress.schema.json", + "title": "GeographicAddress", + "definitions": { + "GeographicAddress": { + "$id": "#GeographicAddress", + "description": "Structured textual way of describing how to find a Property in an urban area (country properties are often defined differently).\nNote : Address corresponds to SID UrbanPropertyAddress", + "type": "object", + "properties": { + "city": { + "type": "string", + "description": "City that the address is in" + }, + "country": { + "type": "string", + "description": "Country that the address is in" + }, + "locality": { + "type": "string", + "description": "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature. [ANZLIC-STREET], or a suburb, a bounded locality within a city, town or shire principally of urban character [ANZLICSTREET]" + }, + "postcode": { + "type": "string", + "description": "descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)" + }, + "stateOrProvince": { + "type": "string", + "description": "the State or Province that the address is in" + }, + "streetName": { + "type": "string", + "description": "Name of the street or other street type" + }, + "streetNr": { + "type": "string", + "description": "Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" + }, + "streetNrLast": { + "type": "string", + "description": "Last number in a range of street numbers allocated to a property" + }, + "streetNrLastSuffix": { + "type": "string", + "description": "Last street number suffix for a ranged address" + }, + "streetNrSuffix": { + "type": "string", + "description": "the first street number suffix" + }, + "streetSuffix": { + "type": "string", + "description": "A modifier denoting a relative direction" + }, + "streetType": { + "type": "string", + "description": "alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf " + }, + "geographicLocation": { + "$ref": "../Common/GeographicLocation.schema.json#GeographicLocation" + }, + "geographicSubAddress": { + "type": "array", + "items": { + "$ref": "../Common/GeographicSubAddress.schema.json#GeographicSubAddress" + } } + }, + "allOf": [ + { + "$ref": "../Common/Place.schema.json#Place" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/GeographicAddressRef.schema.json b/Common/GeographicAddressRef.schema.json index 03c525a9..3b575a9b 100644 --- a/Common/GeographicAddressRef.schema.json +++ b/Common/GeographicAddressRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicAddressRef.schema.json", - "title": "GeographicAddressRef", - "definitions": { - "GeographicAddressRef": { - "$id": "#GeographicAddressRef", - "description": "The place at which the change request has occurred.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The detail address of the location." - }, - "id": { - "type": "string", - "description": "The post code of an address." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicAddressRef.schema.json", + "title": "GeographicAddressRef", + "definitions": { + "GeographicAddressRef": { + "$id": "#GeographicAddressRef", + "description": "The place at which the change request has occurred.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The detail address of the location." + }, + "id": { + "type": "string", + "description": "The post code of an address." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/GeographicAddressValidation.schema.json b/Common/GeographicAddressValidation.schema.json index 0a61525e..abed1f9b 100644 --- a/Common/GeographicAddressValidation.schema.json +++ b/Common/GeographicAddressValidation.schema.json @@ -1,53 +1,53 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicAddressValidation.schema.json", - "title": "GeographicAddressValidation", - "definitions": { - "GeographicAddressValidation": { - "$id": "#GeographicAddressValidation", - "description": "This resource is used to manage address validation request and response", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "An URI used to access to the address validation resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Address Validation" - }, - "provideAlternative": { - "type": "boolean", - "description": "Indicator provided by the requester to specify if alternate addresses must be provided in case of partial or fail result." - }, - "status": { - "type": "string", - "description": "Status of the address validation (inProgress, terminatedWithError, done)" - }, - "validationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the address validation is performed" - }, - "validationResult": { - "type": "string", - "description": "Result of the address validation (success, partial, fail)" - }, - "validAddress": { - "$ref": "GeographicAddress.schema.json#GeographicAddress" - }, - "alternateGeographicAddress": { - "type": "array", - "items": { - "$ref": "GeographicAddress.schema.json#GeographicAddress" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicAddressValidation.schema.json", + "title": "GeographicAddressValidation", + "definitions": { + "GeographicAddressValidation": { + "$id": "#GeographicAddressValidation", + "description": "This resource is used to manage address validation request and response", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "An URI used to access to the address validation resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Address Validation" + }, + "provideAlternative": { + "type": "boolean", + "description": "Indicator provided by the requester to specify if alternate addresses must be provided in case of partial or fail result." + }, + "status": { + "type": "string", + "description": "Status of the address validation (inProgress, terminatedWithError, done)" + }, + "validationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the address validation is performed" + }, + "validationResult": { + "type": "string", + "description": "Result of the address validation (success, partial, fail)" + }, + "validAddress": { + "$ref": "../Common/GeographicAddress.schema.json#GeographicAddress" + }, + "alternateGeographicAddress": { + "type": "array", + "items": { + "$ref": "../Common/GeographicAddress.schema.json#GeographicAddress" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/GeographicLocation.schema.json b/Common/GeographicLocation.schema.json index e55bfac5..41dedede 100644 --- a/Common/GeographicLocation.schema.json +++ b/Common/GeographicLocation.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicLocation.schema.json", - "title": "GeographicLocation", - "definitions": { - "GeographicLocation": { - "$id": "#GeographicLocation", - "description": "A GeographicLocation allows to describe through coordinate(s) a point, a line or a space", - "type": "object", - "properties": { - "accuracy": { - "type": "string" - }, - "geometryType": { - "type": "string", - "description": "Type allows to describe the GeoLocation form: it could be a point, a line, a polygon, a cylinder, etc" - }, - "spatialRef": { - "type": "string" - }, - "geometry": { - "type": "array", - "items": { - "$ref": "GeographicPoint.schema.json#GeographicPoint" - } - } - }, - "allOf": [ - { - "$ref": "Place.schema.json#Place" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicLocation.schema.json", + "title": "GeographicLocation", + "definitions": { + "GeographicLocation": { + "$id": "#GeographicLocation", + "description": "A GeographicLocation allows to describe through coordinate(s) a point, a line or a space", + "type": "object", + "properties": { + "accuracy": { + "type": "string" + }, + "geometryType": { + "type": "string", + "description": "Type allows to describe the GeoLocation form: it could be a point, a line, a polygon, a cylinder, etc" + }, + "spatialRef": { + "type": "string" + }, + "geometry": { + "type": "array", + "items": { + "$ref": "../Common/GeographicPoint.schema.json#GeographicPoint" + } } + }, + "allOf": [ + { + "$ref": "../Common/Place.schema.json#Place" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/GeographicLocationRef.schema.json b/Common/GeographicLocationRef.schema.json index dc25b613..020b89dc 100644 --- a/Common/GeographicLocationRef.schema.json +++ b/Common/GeographicLocationRef.schema.json @@ -1,17 +1,17 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicLocationRef.schema.json", - "title": "GeographicLocationRef", - "definitions": { - "GeographicLocationRef": { - "$id": "#GeographicLocationRef", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "PlaceRef.schema.json#PlaceRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicLocationRef.schema.json", + "title": "GeographicLocationRef", + "definitions": { + "GeographicLocationRef": { + "$id": "#GeographicLocationRef", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} \ No newline at end of file + } +} diff --git a/Common/GeographicPoint.schema.json b/Common/GeographicPoint.schema.json index 819ccfb1..d6181d2b 100644 --- a/Common/GeographicPoint.schema.json +++ b/Common/GeographicPoint.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicPoint.schema.json", - "title": "GeographicPoint", - "definitions": { - "GeographicPoint": { - "$id": "#GeographicPoint", - "description": "A GeographicPoint defines a geographic point through coordinates.", - "type": "object", - "properties": { - "x": { - "type": "string", - "description": "x coordinate (usually latitude)" - }, - "y": { - "type": "string", - "description": "y coordinate (usually longitude)" - }, - "z": { - "type": "string", - "description": "z coordinate (usually elevation)" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicPoint.schema.json", + "title": "GeographicPoint", + "definitions": { + "GeographicPoint": { + "$id": "#GeographicPoint", + "description": "A GeographicPoint defines a geographic point through coordinates.", + "type": "object", + "properties": { + "x": { + "type": "string", + "description": "x coordinate (usually latitude)" + }, + "y": { + "type": "string", + "description": "y coordinate (usually longitude)" + }, + "z": { + "type": "string", + "description": "z coordinate (usually elevation)" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/GeographicSite.schema.json b/Common/GeographicSite.schema.json index 6ad423ec..df10c9ad 100644 --- a/Common/GeographicSite.schema.json +++ b/Common/GeographicSite.schema.json @@ -1,70 +1,70 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicSite.schema.json", - "title": "GeographicSite", - "definitions": { - "GeographicSite": { - "$id": "#GeographicSite", - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "A code that may be used for some addressing schemes eg: [ANSI T1.253-1999]" - }, - "description": { - "type": "string", - "description": "Text describing additional information regarding the site" - }, - "href": { - "type": "string", - "description": "An URI used to access to the site" - }, - "id": { - "type": "string", - "description": "Unique identifier of the site within the server" - }, - "name": { - "type": "string", - "description": "The name that the site is known by" - }, - "status": { - "type": "string", - "description": "The condition of the GeographicSite, such as active, inactive, planned address" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "calendar": { - "type": "array", - "items": { - "$ref": "CalendarPeriod.schema.json#CalendarPeriod" - } - }, - "geographicLocation": { - "$ref": "GeographicLocation.schema.json#GeographicLocation" - }, - "address": { - "$ref": "GeographicAddress.schema.json#GeographicAddress" - }, - "siteRelationship": { - "type": "array", - "items": { - "$ref": "SiteRelationship.schema.json#SiteRelationship" - } - }, - "role": { - "type": "string", - "description": "Role of the place, such as: [home delivery], [shop retrieval])" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicSite.schema.json", + "title": "GeographicSite", + "definitions": { + "GeographicSite": { + "$id": "#GeographicSite", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "A code that may be used for some addressing schemes eg: [ANSI T1.253-1999]" + }, + "description": { + "type": "string", + "description": "Text describing additional information regarding the site" + }, + "href": { + "type": "string", + "description": "An URI used to access to the site" + }, + "id": { + "type": "string", + "description": "Unique identifier of the site within the server" + }, + "name": { + "type": "string", + "description": "The name that the site is known by" + }, + "status": { + "type": "string", + "description": "The condition of the GeographicSite, such as active, inactive, planned address" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "calendar": { + "type": "array", + "items": { + "$ref": "../Common/CalendarPeriod.schema.json#CalendarPeriod" + } + }, + "geographicLocation": { + "$ref": "../Common/GeographicLocation.schema.json#GeographicLocation" + }, + "address": { + "$ref": "../Common/GeographicAddress.schema.json#GeographicAddress" + }, + "siteRelationship": { + "type": "array", + "items": { + "$ref": "../Common/SiteRelationship.schema.json#SiteRelationship" + } + }, + "role": { + "type": "string", + "description": "Role of the place, such as: [home delivery], [shop retrieval])" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/GeographicSiteRef.schema.json b/Common/GeographicSiteRef.schema.json index 38d2ebef..e64127a2 100644 --- a/Common/GeographicSiteRef.schema.json +++ b/Common/GeographicSiteRef.schema.json @@ -1,28 +1,28 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicSiteRef.schema.json", - "title": "GeographicSiteRef", - "definitions": { - "GeographicSiteRef": { - "$id": "#GeographicSiteRef", - "type": "object", - "properties": { - "href": { - "type": "integer" - }, - "id": { - "type": "integer" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicSiteRef.schema.json", + "title": "GeographicSiteRef", + "definitions": { + "GeographicSiteRef": { + "$id": "#GeographicSiteRef", + "type": "object", + "properties": { + "href": { + "type": "integer" + }, + "id": { + "type": "integer" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/GeographicSubAddress.schema.json b/Common/GeographicSubAddress.schema.json index 59a3ecd5..a9df5a85 100644 --- a/Common/GeographicSubAddress.schema.json +++ b/Common/GeographicSubAddress.schema.json @@ -1,63 +1,63 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "GeographicSubAddress.schema.json", - "title": "GeographicSubAddress", - "definitions": { - "GeographicSubAddress": { - "$id": "#GeographicSubAddress", - "description": "Representation of a GeographicSubAddress \nIt is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.", - "type": "object", - "properties": { - "buildingName": { - "type": "string", - "description": "allows for buildings that have well-known names" - }, - "href": { - "type": "string", - "description": "Link to the subAddress" - }, - "id": { - "type": "string", - "description": "Unique Identifier of the subAddress" - }, - "levelNumber": { - "type": "string", - "description": "used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2" - }, - "levelType": { - "type": "string", - "description": "describes level types within a building" - }, - "name": { - "type": "string", - "description": "Name of the subAddress to identify it with a meaningful identification" - }, - "privateStreetName": { - "type": "string", - "description": "private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office." - }, - "privateStreetNumber": { - "type": "string", - "description": "private streets numbers internal to a private street" - }, - "subUnitNumber": { - "type": "string", - "description": "the discriminator used for the subunit\noften just a simple number e.g. FLAT 5, may also be a range" - }, - "subUnitType": { - "type": "string", - "description": "the type of subunit\ne.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF" - }, - "subAddressType": { - "type": "string", - "description": "Type of subAddress : it can be a subunit or a private street" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "GeographicSubAddress.schema.json", + "title": "GeographicSubAddress", + "definitions": { + "GeographicSubAddress": { + "$id": "#GeographicSubAddress", + "description": "Representation of a GeographicSubAddress \nIt is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.", + "type": "object", + "properties": { + "buildingName": { + "type": "string", + "description": "allows for buildings that have well-known names" + }, + "href": { + "type": "string", + "description": "Link to the subAddress" + }, + "id": { + "type": "string", + "description": "Unique Identifier of the subAddress" + }, + "levelNumber": { + "type": "string", + "description": "used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2" + }, + "levelType": { + "type": "string", + "description": "describes level types within a building" + }, + "name": { + "type": "string", + "description": "Name of the subAddress to identify it with a meaningful identification" + }, + "privateStreetName": { + "type": "string", + "description": "private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office." + }, + "privateStreetNumber": { + "type": "string", + "description": "private streets numbers internal to a private street" + }, + "subUnitNumber": { + "type": "string", + "description": "the discriminator used for the subunit\noften just a simple number e.g. FLAT 5, may also be a range" + }, + "subUnitType": { + "type": "string", + "description": "the type of subunit\ne.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF" + }, + "subAddressType": { + "type": "string", + "description": "Type of subAddress : it can be a subunit or a private street" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/HeaderItem.schema.json b/Common/HeaderItem.schema.json index 92be6696..f2aadf60 100644 --- a/Common/HeaderItem.schema.json +++ b/Common/HeaderItem.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "HeaderItem.schema.json", - "title": "HeaderItem", - "definitions": { - "HeaderItem": { - "$id": "#HeaderItem", - "type": "object", - "description": "An item typically included in a request or response", - "properties": { - "name": { - "description": "The name of the header item, e.g. locale", - "type": "string" - }, - "value": { - "description": "The value of the header item, e.g. en-us", - "type": "string" - } - }, - "required": [ - "name", - "value" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "HeaderItem.schema.json", + "title": "HeaderItem", + "definitions": { + "HeaderItem": { + "$id": "#HeaderItem", + "type": "object", + "description": "An item typically included in a request or response", + "properties": { + "name": { + "description": "The name of the header item, e.g. locale", + "type": "string" + }, + "value": { + "description": "The value of the header item, e.g. en-us", + "type": "string" } + }, + "required": [ + "name", + "value" + ] } -} \ No newline at end of file + } +} diff --git a/Common/HourPeriod.schema.json b/Common/HourPeriod.schema.json index f4a13944..9e0f692a 100644 --- a/Common/HourPeriod.schema.json +++ b/Common/HourPeriod.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "HourPeriod.schema.json", - "title": "HourPeriod", - "definitions": { - "HourPeriod": { - "$id": "#HourPeriod", - "type": "object", - "properties": { - "endHour": { - "type": "string", - "description": "The time when the status ends applying" - }, - "startHour": { - "type": "string", - "description": "The time when the status starts applying" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "HourPeriod.schema.json", + "title": "HourPeriod", + "definitions": { + "HourPeriod": { + "$id": "#HourPeriod", + "type": "object", + "properties": { + "endHour": { + "type": "string", + "description": "The time when the status ends applying" + }, + "startHour": { + "type": "string", + "description": "The time when the status starts applying" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Hub.schema.json b/Common/Hub.schema.json index d2d61a7b..ca8d9821 100644 --- a/Common/Hub.schema.json +++ b/Common/Hub.schema.json @@ -1,46 +1,46 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Hub.schema.json", - "title": "Hub", - "definitions": { - "Hub": { - "$id": "#Hub", - "description": "A Hub is used to subscribe to an event notification", - "type": "object", - "required": [ - "id", - "callback" - ], - "properties": { - "id": { - "type": "string", - "description": "The unique-id for your subscription - referenced when updating or deleting a subscription", - "examples": [ - "4aafacbd-11ff-4dc8-b445-305f2215715f", - "2334bc59-726e-4d34-ab96-f50e0561412f" - ] - }, - "callback": { - "type": "string", - "format": "uri", - "description": "The URI that will be POSTed to when a notification is triggered", - "examples": [ - "http://host/resource/id/listener" - ] - }, - "query": { - "type": "string", - "description": "This is a query string used to filter notifications in the context of the notifier", - "examples": [ - "status=active" - ] - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Hub.schema.json", + "title": "Hub", + "definitions": { + "Hub": { + "$id": "#Hub", + "description": "A Hub is used to subscribe to an event notification", + "type": "object", + "required": [ + "id", + "callback" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique-id for your subscription - referenced when updating or deleting a subscription", + "examples": [ + "4aafacbd-11ff-4dc8-b445-305f2215715f", + "2334bc59-726e-4d34-ab96-f50e0561412f" + ] + }, + "callback": { + "type": "string", + "format": "uri", + "description": "The URI that will be POSTed to when a notification is triggered", + "examples": [ + "http://host/resource/id/listener" + ] + }, + "query": { + "type": "string", + "description": "This is a query string used to filter notifications in the context of the notifier", + "examples": [ + "status=active" + ] } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/ImpactEntityRef.schema.json b/Common/ImpactEntityRef.schema.json index e3e4f5a2..d0f059b6 100644 --- a/Common/ImpactEntityRef.schema.json +++ b/Common/ImpactEntityRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ImpactEntityRef.schema.json", - "title": "ImpactEntityRef", - "definitions": { - "ImpactEntityRef": { - "$id": "#ImpactEntityRef", - "description": "Defines the entities (product, service, resource, and other related objects) which will be impacted while the change \nrequest is executed.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description and analysis of the impact of the change request on the Product, Service or Resource." - }, - "href": { - "type": "string", - "description": "Hyperlink to access the impacted party, it could be a party reference or a party role reference." - }, - "id": { - "type": "string", - "description": "Identifier of impacted entity." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ImpactEntityRef.schema.json", + "title": "ImpactEntityRef", + "definitions": { + "ImpactEntityRef": { + "$id": "#ImpactEntityRef", + "description": "Defines the entities (product, service, resource, and other related objects) which will be impacted while the change \nrequest is executed.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description and analysis of the impact of the change request on the Product, Service or Resource." + }, + "href": { + "type": "string", + "description": "Hyperlink to access the impacted party, it could be a party reference or a party role reference." + }, + "id": { + "type": "string", + "description": "Identifier of impacted entity." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/ImportJob.schema.json b/Common/ImportJob.schema.json index e083b9f9..d2f4eb30 100644 --- a/Common/ImportJob.schema.json +++ b/Common/ImportJob.schema.json @@ -1,58 +1,58 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ImportJob.schema.json", - "title": "ImportJob", - "definitions": { - "ImportJob": { - "$id": "#ImportJob", - "description": "Represents a task used to import resources from a file", - "type": "object", - "properties": { - "completionDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the job was completed" - }, - "contentType": { - "type": "string", - "description": "Indicates the format of the imported data" - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the job was created" - }, - "errorLog": { - "type": "string", - "description": "Reason for failure if status is failed" - }, - "href": { - "type": "string", - "description": "Reference of the import job" - }, - "id": { - "type": "string", - "description": "Identifier of the import job" - }, - "path": { - "type": "string", - "description": "URL of the root resource where the content of the file specified by the import job must be applied" - }, - "status": { - "description": "Status of the import job (not started, running, succeeded, failed)", - "$ref": "JobStateType.schema.json#JobStateType" - }, - "url": { - "type": "string", - "format": "uri", - "description": "URL of the file containing the data to be imported" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ImportJob.schema.json", + "title": "ImportJob", + "definitions": { + "ImportJob": { + "$id": "#ImportJob", + "description": "Represents a task used to import resources from a file", + "type": "object", + "properties": { + "completionDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the job was completed" + }, + "contentType": { + "type": "string", + "description": "Indicates the format of the imported data" + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the job was created" + }, + "errorLog": { + "type": "string", + "description": "Reason for failure if status is failed" + }, + "href": { + "type": "string", + "description": "Reference of the import job" + }, + "id": { + "type": "string", + "description": "Identifier of the import job" + }, + "path": { + "type": "string", + "description": "URL of the root resource where the content of the file specified by the import job must be applied" + }, + "status": { + "description": "Status of the import job (not started, running, succeeded, failed)", + "$ref": "../Common/JobStateType.schema.json#JobStateType" + }, + "url": { + "type": "string", + "format": "uri", + "description": "URL of the file containing the data to be imported" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Incident.schema.json b/Common/Incident.schema.json index e8fb6ffe..8c459b54 100644 --- a/Common/Incident.schema.json +++ b/Common/Incident.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Incident.schema.json", - "title": "Incident", - "definitions": { - "Incident": { - "$id": "#Incident", - "description": "An Incident is a record of an event that has altered the operational state of a entity (Resource, Service or Customers Product)", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description of the incident." - }, - "name": { - "type": "string", - "description": "The name of the incident." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Incident.schema.json", + "title": "Incident", + "definitions": { + "Incident": { + "$id": "#Incident", + "description": "An Incident is a record of an event that has altered the operational state of a entity (Resource, Service or Customers Product)", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of the incident." + }, + "name": { + "type": "string", + "description": "The name of the incident." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/IntegerCharacteristic.schema.json b/Common/IntegerCharacteristic.schema.json index 26f21dad..588afec2 100644 --- a/Common/IntegerCharacteristic.schema.json +++ b/Common/IntegerCharacteristic.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "IntegerCharacteristic.schema.json", - "title": "IntegerCharacteristic", - "definitions": { - "IntegerCharacteristic": { - "$id": "#IntegerCharacteristic", - "description": "A characteristic which value is a integer number", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "valueType": { - "type": "string", - "description": "Data type of the value of the characteristic" - }, - "value": { - "type": "integer", - "description": "Value of the characteristic" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "IntegerCharacteristic.schema.json", + "title": "IntegerCharacteristic", + "definitions": { + "IntegerCharacteristic": { + "$id": "#IntegerCharacteristic", + "description": "A characteristic which value is a integer number", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "valueType": { + "type": "string", + "description": "Data type of the value of the characteristic" + }, + "value": { + "type": "integer", + "description": "Value of the characteristic" } + } } -} \ No newline at end of file + } +} diff --git a/Common/JobStateType.schema.json b/Common/JobStateType.schema.json index 991b9393..1a07e2f6 100644 --- a/Common/JobStateType.schema.json +++ b/Common/JobStateType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "JobStateType.schema.json", - "title": "JobStateType", - "definitions": { - "JobStateType": { - "$id": "#JobStateType", - "type": "string", - "description": "Valid values for the state of a batch job (e.g. catalog import)", - "enum": [ - "Not Started", - "Running", - "Succeeded", - "Failed" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "JobStateType.schema.json", + "title": "JobStateType", + "definitions": { + "JobStateType": { + "$id": "#JobStateType", + "type": "string", + "description": "Valid values for the state of a batch job (e.g. catalog import)", + "enum": [ + "Not Started", + "Running", + "Succeeded", + "Failed" + ] } -} \ No newline at end of file + } +} diff --git a/Common/LocationCharacteristic.schema.json b/Common/LocationCharacteristic.schema.json index fe9885c2..09302c2b 100644 --- a/Common/LocationCharacteristic.schema.json +++ b/Common/LocationCharacteristic.schema.json @@ -1,25 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LocationCharacteristic.schema.json", - "title": "LocationCharacteristic", - "definitions": { - "LocationCharacteristic": { - "$id": "#LocationCharacteristic", - "description": "Name/value pairs, used to extra characterized the Area (e.g. if a standard\ncode set has been defined for the GeographicArea type, etc.)", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LocationCharacteristic.schema.json", + "title": "LocationCharacteristic", + "definitions": { + "LocationCharacteristic": { + "$id": "#LocationCharacteristic", + "description": "Name/value pairs, used to extra characterized the Area (e.g. if a standard\ncode set has been defined for the GeographicArea type, etc.)", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/MediumCharacteristic.schema.json b/Common/MediumCharacteristic.schema.json index 9c660f4e..4a6cb633 100644 --- a/Common/MediumCharacteristic.schema.json +++ b/Common/MediumCharacteristic.schema.json @@ -1,63 +1,63 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "MediumCharacteristic.schema.json", - "title": "MediumCharacteristic", - "definitions": { - "MediumCharacteristic": { - "$id": "#MediumCharacteristic", - "type": "object", - "description": "Describes the contact medium characteristics that could be used to contact a party (an individual or an organization)", - "properties": { - "city": { - "type": "string", - "description": "The city" - }, - "country": { - "type": "string", - "description": "The country" - }, - "emailAddress": { - "type": "string", - "description": "Full email address in standard format" - }, - "faxNumber": { - "type": "string", - "description": "The fax number of the contact" - }, - "contactType": { - "type": "string", - "description": "The type of contact, for example: phone number such as mobile, fixed home, fixed office. postal address such as shipping instalation…" - }, - "socialNetworkId": { - "type": "string", - "description": "Identifier as a member of a social network" - }, - "phoneNumber": { - "type": "string", - "description": "The primary phone number of the contact" - }, - "postCode": { - "type": "string", - "description": "Postcode" - }, - "stateOrProvince": { - "type": "string", - "description": "State or province" - }, - "street1": { - "type": "string", - "description": "Describes the street" - }, - "street2": { - "type": "string", - "description": "Complementary street description" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "MediumCharacteristic.schema.json", + "title": "MediumCharacteristic", + "definitions": { + "MediumCharacteristic": { + "$id": "#MediumCharacteristic", + "type": "object", + "description": "Describes the contact medium characteristics that could be used to contact a party (an individual or an organization)", + "properties": { + "city": { + "type": "string", + "description": "The city" + }, + "country": { + "type": "string", + "description": "The country" + }, + "emailAddress": { + "type": "string", + "description": "Full email address in standard format" + }, + "faxNumber": { + "type": "string", + "description": "The fax number of the contact" + }, + "contactType": { + "type": "string", + "description": "The type of contact, for example: phone number such as mobile, fixed home, fixed office. postal address such as shipping instalation…" + }, + "socialNetworkId": { + "type": "string", + "description": "Identifier as a member of a social network" + }, + "phoneNumber": { + "type": "string", + "description": "The primary phone number of the contact" + }, + "postCode": { + "type": "string", + "description": "Postcode" + }, + "stateOrProvince": { + "type": "string", + "description": "State or province" + }, + "street1": { + "type": "string", + "description": "Describes the street" + }, + "street2": { + "type": "string", + "description": "Complementary street description" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Money.schema.json b/Common/Money.schema.json index 07a02780..14946d50 100644 --- a/Common/Money.schema.json +++ b/Common/Money.schema.json @@ -1,28 +1,28 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Money.schema.json", - "title": "Money", - "definitions": { - "Money": { - "$id": "#Money", - "description": "A base / value business entity used to represent money", - "type": "object", - "properties": { - "unit": { - "type": "string", - "description": "Currency (ISO4217 norm uses 3 letters to define the currency)" - }, - "value": { - "type": "number", - "format": "float", - "description": "A positive floating point number" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Money.schema.json", + "title": "Money", + "definitions": { + "Money": { + "$id": "#Money", + "description": "A base / value business entity used to represent money", + "type": "object", + "properties": { + "unit": { + "type": "string", + "description": "Currency (ISO4217 norm uses 3 letters to define the currency)" + }, + "value": { + "type": "number", + "format": "float", + "description": "A positive floating point number" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Monitor.schema.json b/Common/Monitor.schema.json index 817c847f..f6290a11 100644 --- a/Common/Monitor.schema.json +++ b/Common/Monitor.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Monitor.schema.json", - "title": "Monitor", - "definitions": { - "Monitor": { - "$id": "#Monitor", - "type": "object", - "description": "Monitoring of resources", - "properties": { - "href": { - "type": "string", - "description": "reference to this monitor" - }, - "id": { - "type": "string", - "description": "Identifier of an instance of the monitor. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type" - }, - "request": { - "description": "Represents the request", - "$ref": "Request.schema.json#Request" - }, - "response": { - "description": "Represents the response", - "$ref": "Response.schema.json#Response" - }, - "sourceHref": { - "type": "string", - "description": "The monitored resource href" - }, - "state": { - "type": "string", - "description": "The Monitor state of the resource. InProgress, InError, Completed" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Monitor.schema.json", + "title": "Monitor", + "definitions": { + "Monitor": { + "$id": "#Monitor", + "type": "object", + "description": "Monitoring of resources", + "properties": { + "href": { + "type": "string", + "description": "reference to this monitor" + }, + "id": { + "type": "string", + "description": "Identifier of an instance of the monitor. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type" + }, + "request": { + "description": "Represents the request", + "$ref": "../Common/Request.schema.json#Request" + }, + "response": { + "description": "Represents the response", + "$ref": "../Common/Response.schema.json#Response" + }, + "sourceHref": { + "type": "string", + "description": "The monitored resource href" + }, + "state": { + "type": "string", + "description": "The Monitor state of the resource. InProgress, InError, Completed" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/NetworkFunction.schema.json b/Common/NetworkFunction.schema.json index 6d5e279f..e724118f 100644 --- a/Common/NetworkFunction.schema.json +++ b/Common/NetworkFunction.schema.json @@ -1,19 +1,19 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "NetworkFunction.schema.json", - "title": "NetworkFunction", - "definitions": { - "NetworkFunction": { - "$id": "#NetworkFunction", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "id": { - "type": "string" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "NetworkFunction.schema.json", + "title": "NetworkFunction", + "definitions": { + "NetworkFunction": { + "$id": "#NetworkFunction", + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "id": { + "type": "string" } + } } -} \ No newline at end of file + } +} diff --git a/Common/Note.schema.json b/Common/Note.schema.json index f08601da..4e30b172 100644 --- a/Common/Note.schema.json +++ b/Common/Note.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Note.schema.json", - "title": "Note", - "definitions": { - "Note": { - "$id": "#Note", - "description": "Extra information about a given entity", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)" - }, - "author": { - "type": "string", - "description": "Author of the note" - }, - "date": { - "type": "string", - "format": "date-time", - "description": "Date of the note" - }, - "text": { - "type": "string", - "description": "Text of the note" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Note.schema.json", + "title": "Note", + "definitions": { + "Note": { + "$id": "#Note", + "description": "Extra information about a given entity", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)" + }, + "author": { + "type": "string", + "description": "Author of the note" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "Date of the note" + }, + "text": { + "type": "string", + "description": "Text of the note" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Notification.schema.json b/Common/Notification.schema.json index a2737f6a..fe90252c 100644 --- a/Common/Notification.schema.json +++ b/Common/Notification.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Notification.schema.json", - "title": "Notification", - "definitions": { - "Notification": { - "$id": "#Notification", - "description": "The notification is sent to each listener who has subscribed to receive it.", - "type": "object", - "properties": { - "eventId": { - "type": "string", - "description": "Identifier of the event" - }, - "eventTime": { - "type": "string", - "format": "date-time", - "description": "Creation date of the event" - }, - "eventType": { - "type": "string", - "description": "Type of event" - }, - "fieldPath": { - "type": "string", - "description": "details which field is missing, its structure is quite similar to GET filter criteria" - }, - "resourcePath": { - "type": "string", - "description": "To indicate which entity is concerned" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Notification.schema.json", + "title": "Notification", + "definitions": { + "Notification": { + "$id": "#Notification", + "description": "The notification is sent to each listener who has subscribed to receive it.", + "type": "object", + "properties": { + "eventId": { + "type": "string", + "description": "Identifier of the event" + }, + "eventTime": { + "type": "string", + "format": "date-time", + "description": "Creation date of the event" + }, + "eventType": { + "type": "string", + "description": "Type of event" + }, + "fieldPath": { + "type": "string", + "description": "details which field is missing, its structure is quite similar to GET filter criteria" + }, + "resourcePath": { + "type": "string", + "description": "To indicate which entity is concerned" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Object.schema.json b/Common/Object.schema.json index f1ac81cc..8ff22ec5 100644 --- a/Common/Object.schema.json +++ b/Common/Object.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Object.schema.json", - "title": "Object", - "definitions": { - "Object": { - "$id": "#Object", - "type": "object", - "properties": { - "objectType": { - "type": "string", - "description": "The type of object" - }, - "uri": { - "type": "string", - "format": "uri" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Object.schema.json", + "title": "Object", + "definitions": { + "Object": { + "$id": "#Object", + "type": "object", + "properties": { + "objectType": { + "type": "string", + "description": "The type of object" + }, + "uri": { + "type": "string", + "format": "uri" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/ObjectCharacteristic.schema.json b/Common/ObjectCharacteristic.schema.json index cfa35c44..9a3dc1d2 100644 --- a/Common/ObjectCharacteristic.schema.json +++ b/Common/ObjectCharacteristic.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ObjectCharacteristic.schema.json", - "title": "ObjectCharacteristic", - "definitions": { - "ObjectCharacteristic": { - "$id": "#ObjectCharacteristic", - "description": "A characteristic which value is an object", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "valueType": { - "type": "string", - "description": "Data type of the value of the characteristic" - }, - "value": { - "type": "string", - "description": "Value of the characteristic" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ObjectCharacteristic.schema.json", + "title": "ObjectCharacteristic", + "definitions": { + "ObjectCharacteristic": { + "$id": "#ObjectCharacteristic", + "description": "A characteristic which value is an object", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "valueType": { + "type": "string", + "description": "Data type of the value of the characteristic" + }, + "value": { + "type": "string", + "description": "Value of the characteristic" } + } } -} \ No newline at end of file + } +} diff --git a/Common/Place.schema.json b/Common/Place.schema.json index 34bae903..44652962 100644 --- a/Common/Place.schema.json +++ b/Common/Place.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Place.schema.json", - "title": "Place", - "definitions": { - "Place": { - "$id": "#Place", - "description": "Place reference. Place defines the places where the products are sold or delivered.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Unique reference of the place" - }, - "id": { - "type": "string", - "description": "Unique identifier of the place" - }, - "name": { - "type": "string", - "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Place.schema.json", + "title": "Place", + "definitions": { + "Place": { + "$id": "#Place", + "description": "Place reference. Place defines the places where the products are sold or delivered.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Unique reference of the place" + }, + "id": { + "type": "string", + "description": "Unique identifier of the place" + }, + "name": { + "type": "string", + "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/PlaceRef.schema.json b/Common/PlaceRef.schema.json index 2a05e114..e201c92f 100644 --- a/Common/PlaceRef.schema.json +++ b/Common/PlaceRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PlaceRef.schema.json", - "title": "PlaceRef", - "definitions": { - "PlaceRef": { - "$id": "#PlaceRef", - "description": "Place reference. PlaceRef defines the placeRefs where the products are sold or delivered.", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PlaceRef.schema.json", + "title": "PlaceRef", + "definitions": { + "PlaceRef": { + "$id": "#PlaceRef", + "description": "Place reference. PlaceRef defines the placeRefs where the products are sold or delivered.", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} \ No newline at end of file + } +} diff --git a/Common/ProcessFlow.schema.json b/Common/ProcessFlow.schema.json index 0ffa8670..0715603e 100644 --- a/Common/ProcessFlow.schema.json +++ b/Common/ProcessFlow.schema.json @@ -1,74 +1,74 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProcessFlow.schema.json", - "title": "ProcessFlow", - "definitions": { - "ProcessFlow": { - "$id": "#ProcessFlow", - "type": "object", - "properties": { - "channel": { - "type": "array", - "items": { - "$ref": "ChannelRef.schema.json#ChannelRef" - }, - "description": "A list of channel(s) where this processFlow is executed" - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "Characteristic.schema.json#Characteristic" - }, - "description": "A list of characteristic(s) associated to this processFlow" - }, - "href": { - "type": "string", - "description": "Reference of the ProcessFlow" - }, - "id": { - "type": "string", - "description": "Identifier of the Process flow" - }, - "processFlowDate": { - "type": "string", - "format": "date-time", - "description": "Is the date when the processFlow was created in basse (timestamp)" - }, - "processFlowSpecification": { - "type": "string", - "description": "Specification of the processFlow." - }, - "relatedEntity": { - "type": "array", - "items": { - "$ref": "RelatedEntity.schema.json#RelatedEntity" - }, - "description": "A list of related entity(ies) to this processFlow" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "description": "A list of related party(ies) to this processFlow" - }, - "state": { - "$ref": "ProcessFlowStateType.schema.json#ProcessFlowStateType", - "description": "State of the ProcessFlow: described in the state machine diagram." - }, - "taskFlow": { - "type": "array", - "items": { - "$ref": "TaskFlowRef.schema.json#TaskFlowRef" - }, - "description": "A list of taskflow related to this processFlow" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProcessFlow.schema.json", + "title": "ProcessFlow", + "definitions": { + "ProcessFlow": { + "$id": "#ProcessFlow", + "type": "object", + "properties": { + "channel": { + "type": "array", + "items": { + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "description": "A list of channel(s) where this processFlow is executed" + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + }, + "description": "A list of characteristic(s) associated to this processFlow" + }, + "href": { + "type": "string", + "description": "Reference of the ProcessFlow" + }, + "id": { + "type": "string", + "description": "Identifier of the Process flow" + }, + "processFlowDate": { + "type": "string", + "format": "date-time", + "description": "Is the date when the processFlow was created in basse (timestamp)" + }, + "processFlowSpecification": { + "type": "string", + "description": "Specification of the processFlow." + }, + "relatedEntity": { + "type": "array", + "items": { + "$ref": "../Common/RelatedEntity.schema.json#RelatedEntity" + }, + "description": "A list of related entity(ies) to this processFlow" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "A list of related party(ies) to this processFlow" + }, + "state": { + "$ref": "../Common/ProcessFlowStateType.schema.json#ProcessFlowStateType", + "description": "State of the ProcessFlow: described in the state machine diagram." + }, + "taskFlow": { + "type": "array", + "items": { + "$ref": "../Common/TaskFlowRef.schema.json#TaskFlowRef" + }, + "description": "A list of taskflow related to this processFlow" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/ProcessFlowRef.schema.json b/Common/ProcessFlowRef.schema.json index 88b71794..bd2ed7d3 100644 --- a/Common/ProcessFlowRef.schema.json +++ b/Common/ProcessFlowRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProcessFlowRef.schema.json", - "title": "ProcessFlowRef", - "definitions": { - "ProcessFlowRef": { - "$id": "#ProcessFlowRef", - "description": "Process Flow ref class is used to provide process main information from Task sub resource.", - "type": "object", - "properties": { - "state": { - "description": "The life cycle state of the processFlow", - "$ref": "ProcessFlowStateType.schema.json#ProcessFlowStateType" - } - }, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProcessFlowRef.schema.json", + "title": "ProcessFlowRef", + "definitions": { + "ProcessFlowRef": { + "$id": "#ProcessFlowRef", + "description": "Process Flow ref class is used to provide process main information from Task sub resource.", + "type": "object", + "properties": { + "state": { + "description": "The life cycle state of the processFlow", + "$ref": "../Common/ProcessFlowStateType.schema.json#ProcessFlowStateType" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/ProcessFlowStateType.schema.json b/Common/ProcessFlowStateType.schema.json index 661f1acc..063feaf4 100644 --- a/Common/ProcessFlowStateType.schema.json +++ b/Common/ProcessFlowStateType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProcessFlowStateType.schema.json", - "title": "ProcessFlowStateType", - "definitions": { - "ProcessFlowStateType": { - "$id": "#ProcessFlowStateType", - "type": "string", - "description": "Valid values for the lifecycle state of the processFlow", - "enum": [ - "active", - "cancelled", - "hold", - "completed" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProcessFlowStateType.schema.json", + "title": "ProcessFlowStateType", + "definitions": { + "ProcessFlowStateType": { + "$id": "#ProcessFlowStateType", + "type": "string", + "description": "Valid values for the lifecycle state of the processFlow", + "enum": [ + "active", + "cancelled", + "hold", + "completed" + ] } -} \ No newline at end of file + } +} diff --git a/Common/QualificationRef.schema.json b/Common/QualificationRef.schema.json index 8123daf4..44894587 100644 --- a/Common/QualificationRef.schema.json +++ b/Common/QualificationRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QualificationRef.schema.json", - "title": "QualificationRef", - "definitions": { - "QualificationRef": { - "$id": "#QualificationRef", - "type": "object", - "description": "It could be a serviceQualification or a productOfferingQualification that has been executed previously and captured in the productOrder to provide eligibility information", - "properties": { - "qualificationItemId": { - "type": "string", - "description": "Id of an item of a qualification" - } - }, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QualificationRef.schema.json", + "title": "QualificationRef", + "definitions": { + "QualificationRef": { + "$id": "#QualificationRef", + "type": "object", + "description": "It could be a serviceQualification or a productOfferingQualification that has been executed previously and captured in the productOrder to provide eligibility information", + "properties": { + "qualificationItemId": { + "type": "string", + "description": "Id of an item of a qualification" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Quantity.schema.json b/Common/Quantity.schema.json index 7ed03213..1281da45 100644 --- a/Common/Quantity.schema.json +++ b/Common/Quantity.schema.json @@ -1,24 +1,24 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Quantity.schema.json", - "title": "Quantity", - "definitions": { - "Quantity": { - "$id": "#Quantity", - "type": "object", - "description": "An amount in a given unit", - "properties": { - "amount": { - "type": "number", - "format": "float", - "default": 1, - "description": "Numeric value in a given unit" - }, - "units": { - "type": "string", - "description": "Unit" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Quantity.schema.json", + "title": "Quantity", + "definitions": { + "Quantity": { + "$id": "#Quantity", + "type": "object", + "description": "An amount in a given unit", + "properties": { + "amount": { + "type": "number", + "format": "float", + "default": 1, + "description": "Numeric value in a given unit" + }, + "units": { + "type": "string", + "description": "Unit" } + } } -} \ No newline at end of file + } +} diff --git a/Common/QuantityType.schema.json b/Common/QuantityType.schema.json index adc426fe..1cf420f1 100644 --- a/Common/QuantityType.schema.json +++ b/Common/QuantityType.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuantityType.schema.json", - "title": "QuantityType", - "definitions": { - "QuantityType": { - "$id": "#QuantityType", - "description": "Representation of a quantity of something. I can also be used to represent a quantity range", - "properties": { - "amount": { - "type": "number", - "format": "decimal", - "description": "Measured amount" - }, - "units": { - "type": "string", - "description": "Units the quantity is measured in" - } - }, - "required": [ - "units", - "amount" - ], - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuantityType.schema.json", + "title": "QuantityType", + "definitions": { + "QuantityType": { + "$id": "#QuantityType", + "description": "Representation of a quantity of something. I can also be used to represent a quantity range", + "properties": { + "amount": { + "type": "number", + "format": "decimal", + "description": "Measured amount" + }, + "units": { + "type": "string", + "description": "Units the quantity is measured in" } + }, + "required": [ + "units", + "amount" + ], + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Common/RatedProductUsage.schema.json b/Common/RatedProductUsage.schema.json index 423033ff..acb75e68 100644 --- a/Common/RatedProductUsage.schema.json +++ b/Common/RatedProductUsage.schema.json @@ -1,72 +1,72 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RatedProductUsage.schema.json", - "title": "RatedProductUsage", - "definitions": { - "RatedProductUsage": { - "$id": "#RatedProductUsage", - "description": "An occurrence of employing a product for its intended purpose with all rating details", - "type": "object", - "properties": { - "bucketValueConvertedInAmount": { - "type": "number", - "format": "float", - "description": "Monetary value of bucket" - }, - "currencyCode": { - "type": "string", - "description": "A string used as a code for specifying the currency associated to the given amounts. The ISO4217 norm uses 3 letters to define the currency (for example USD for US dollar or EUR for Euro)" - }, - "isBilled": { - "type": "boolean", - "description": "Boolean indicating if usage have been billed or not" - }, - "isTaxExempt": { - "type": "boolean", - "description": "Indicates if the rated amount is exempt of tax" - }, - "offerTariffType": { - "type": "string", - "description": "Type of tariff applied" - }, - "productRef": { - "type": "string", - "description": "Reference of product specification" - }, - "ratingAmountType": { - "type": "string", - "description": "Type of amount" - }, - "ratingDate": { - "type": "string", - "format": "date-time", - "description": "Date of usage rating" - }, - "taxExcludedRatingAmount": { - "type": "number", - "format": "float", - "description": "All taxes excluded rated amount" - }, - "taxIncludedRatingAmount": { - "type": "number", - "format": "float", - "description": "All taxes included rated amount" - }, - "taxRate": { - "type": "number", - "format": "float", - "description": "Tax rate" - }, - "usageRatingTag": { - "type": "string", - "description": "Tag value: [usage]: the usage is always rated outside a usage bundle\n[included usage]: the usage is rated inside a usage bundle\n[non included usage]: the usage bundle is exhausted. The usage is rated outside the usage bundle" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RatedProductUsage.schema.json", + "title": "RatedProductUsage", + "definitions": { + "RatedProductUsage": { + "$id": "#RatedProductUsage", + "description": "An occurrence of employing a product for its intended purpose with all rating details", + "type": "object", + "properties": { + "bucketValueConvertedInAmount": { + "type": "number", + "format": "float", + "description": "Monetary value of bucket" + }, + "currencyCode": { + "type": "string", + "description": "A string used as a code for specifying the currency associated to the given amounts. The ISO4217 norm uses 3 letters to define the currency (for example USD for US dollar or EUR for Euro)" + }, + "isBilled": { + "type": "boolean", + "description": "Boolean indicating if usage have been billed or not" + }, + "isTaxExempt": { + "type": "boolean", + "description": "Indicates if the rated amount is exempt of tax" + }, + "offerTariffType": { + "type": "string", + "description": "Type of tariff applied" + }, + "productRef": { + "type": "string", + "description": "Reference of product specification" + }, + "ratingAmountType": { + "type": "string", + "description": "Type of amount" + }, + "ratingDate": { + "type": "string", + "format": "date-time", + "description": "Date of usage rating" + }, + "taxExcludedRatingAmount": { + "type": "number", + "format": "float", + "description": "All taxes excluded rated amount" + }, + "taxIncludedRatingAmount": { + "type": "number", + "format": "float", + "description": "All taxes included rated amount" + }, + "taxRate": { + "type": "number", + "format": "float", + "description": "Tax rate" + }, + "usageRatingTag": { + "type": "string", + "description": "Tag value: [usage]: the usage is always rated outside a usage bundle\n[included usage]: the usage is rated inside a usage bundle\n[non included usage]: the usage bundle is exhausted. The usage is rated outside the usage bundle" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Receiver.schema.json b/Common/Receiver.schema.json index bbe99c13..2990b818 100644 --- a/Common/Receiver.schema.json +++ b/Common/Receiver.schema.json @@ -1,46 +1,46 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Receiver.schema.json", - "title": "Receiver", - "definitions": { - "Receiver": { - "$id": "#Receiver", - "description": "Receivers of the communication message.", - "type": "object", - "properties": { - "appUserId": { - "type": "string", - "description": "ID of the mobile app user" - }, - "email": { - "type": "string", - "description": "Receiver address of email, if the communication type is email" - }, - "id": { - "type": "string", - "description": "ID of the receiver" - }, - "ip": { - "type": "string", - "description": "IP address of the receiver" - }, - "name": { - "type": "string", - "description": "Name of the receiver" - }, - "phoneNumber": { - "type": "string", - "description": "Phone number of the receiver, if the communication type is SMS." - }, - "party": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Receiver.schema.json", + "title": "Receiver", + "definitions": { + "Receiver": { + "$id": "#Receiver", + "description": "Receivers of the communication message.", + "type": "object", + "properties": { + "appUserId": { + "type": "string", + "description": "ID of the mobile app user" + }, + "email": { + "type": "string", + "description": "Receiver address of email, if the communication type is email" + }, + "id": { + "type": "string", + "description": "ID of the receiver" + }, + "ip": { + "type": "string", + "description": "IP address of the receiver" + }, + "name": { + "type": "string", + "description": "Name of the receiver" + }, + "phoneNumber": { + "type": "string", + "description": "Phone number of the receiver, if the communication type is SMS." + }, + "party": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/ReceiverRef.schema.json b/Common/ReceiverRef.schema.json index e83f2ef8..9997bf13 100644 --- a/Common/ReceiverRef.schema.json +++ b/Common/ReceiverRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ReceiverRef.schema.json", - "title": "ReceiverRef", - "definitions": { - "ReceiverRef": { - "$id": "#ReceiverRef", - "description": "Receiver reference. The receiver is the party role who will receive the settlement note.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the receiver" - }, - "id": { - "type": "string", - "description": "Identifier of the receiver" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ReceiverRef.schema.json", + "title": "ReceiverRef", + "definitions": { + "ReceiverRef": { + "$id": "#ReceiverRef", + "description": "Receiver reference. The receiver is the party role who will receive the settlement note.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the receiver" + }, + "id": { + "type": "string", + "description": "Identifier of the receiver" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Record.schema.json b/Common/Record.schema.json index 80a744fc..bb3e3698 100644 --- a/Common/Record.schema.json +++ b/Common/Record.schema.json @@ -1,32 +1,32 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Record.schema.json", - "title": "Record", - "definitions": { - "Record": { - "$id": "#Record", - "description": "A record in a worklog.", - "type": "object", - "properties": { - "dateTime": { - "type": "string", - "format": "date-time", - "description": "The date time that a record is generated." - }, - "description": { - "type": "string", - "description": "The detail description in a record." - }, - "supportPerson": { - "type": "string", - "description": "The person who logged that record." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Record.schema.json", + "title": "Record", + "definitions": { + "Record": { + "$id": "#Record", + "description": "A record in a worklog.", + "type": "object", + "properties": { + "dateTime": { + "type": "string", + "format": "date-time", + "description": "The date time that a record is generated." + }, + "description": { + "type": "string", + "description": "The detail description in a record." + }, + "supportPerson": { + "type": "string", + "description": "The person who logged that record." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/RelatedChangeRequestRef.schema.json b/Common/RelatedChangeRequestRef.schema.json index fa553b15..cfdd06ae 100644 --- a/Common/RelatedChangeRequestRef.schema.json +++ b/Common/RelatedChangeRequestRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedChangeRequestRef.schema.json", - "title": "RelatedChangeRequestRef", - "definitions": { - "RelatedChangeRequestRef": { - "$id": "#RelatedChangeRequestRef", - "description": "An existing Change Request that has some form of correlation with the given Change Request.", - "type": "object", - "properties": { - "correlation": { - "type": "string", - "description": "The correlation between two change requests" - }, - "description": { - "type": "string", - "description": "Description of a change request." - }, - "href": { - "type": "string", - "description": "Hyper link to access a change request." - }, - "id": { - "type": "string", - "description": "Identifier of an Change Request" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedChangeRequestRef.schema.json", + "title": "RelatedChangeRequestRef", + "definitions": { + "RelatedChangeRequestRef": { + "$id": "#RelatedChangeRequestRef", + "description": "An existing Change Request that has some form of correlation with the given Change Request.", + "type": "object", + "properties": { + "correlation": { + "type": "string", + "description": "The correlation between two change requests" + }, + "description": { + "type": "string", + "description": "Description of a change request." + }, + "href": { + "type": "string", + "description": "Hyper link to access a change request." + }, + "id": { + "type": "string", + "description": "Identifier of an Change Request" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/RelatedChannel.schema.json b/Common/RelatedChannel.schema.json index c1d5f63c..bc057fa9 100644 --- a/Common/RelatedChannel.schema.json +++ b/Common/RelatedChannel.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedChannel.schema.json", - "title": "RelatedChannel", - "definitions": { - "RelatedChannel": { - "$id": "#RelatedChannel", - "type": "object", - "description": "Related channel to another entity. May be online web, mobile app, social ,etc.", - "properties": { - "name": { - "type": "string", - "description": "Name of the channel." - }, - "role": { - "type": "string", - "description": "Role playing by the channel." - } - }, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedChannel.schema.json", + "title": "RelatedChannel", + "definitions": { + "RelatedChannel": { + "$id": "#RelatedChannel", + "type": "object", + "description": "Related channel to another entity. May be online web, mobile app, social ,etc.", + "properties": { + "name": { + "type": "string", + "description": "Name of the channel." + }, + "role": { + "type": "string", + "description": "Role playing by the channel." } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/RelatedEntity.schema.json b/Common/RelatedEntity.schema.json index 50459906..31bc7287 100644 --- a/Common/RelatedEntity.schema.json +++ b/Common/RelatedEntity.schema.json @@ -1,28 +1,28 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedEntity.schema.json", - "title": "RelatedEntity", - "definitions": { - "RelatedEntity": { - "$id": "#RelatedEntity", - "description": "A reference to an entity, where the type of the entity is not known in advance.", - "type": "object", - "required": [ - "id", - "role", - "@referredType" - ], - "properties": { - "role": { - "type": "string", - "description": "The role of an entity." - } - }, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedEntity.schema.json", + "title": "RelatedEntity", + "definitions": { + "RelatedEntity": { + "$id": "#RelatedEntity", + "description": "A reference to an entity, where the type of the entity is not known in advance.", + "type": "object", + "required": [ + "id", + "role", + "@referredType" + ], + "properties": { + "role": { + "type": "string", + "description": "The role of an entity." } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/RelatedEntityRef.schema.json b/Common/RelatedEntityRef.schema.json index a78e480b..ce97489f 100644 --- a/Common/RelatedEntityRef.schema.json +++ b/Common/RelatedEntityRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedEntityRef.schema.json", - "title": "RelatedEntityRef", - "definitions": { - "RelatedEntityRef": { - "$id": "#RelatedEntityRef", - "description": "A reference to an entity, where the type of the entity is not known in advance.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The hyperlink to access an entity." - }, - "id": { - "type": "string", - "description": "The identifier of an entity." - }, - "name": { - "type": "string", - "description": "The name of an entity." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedEntityRef.schema.json", + "title": "RelatedEntityRef", + "definitions": { + "RelatedEntityRef": { + "$id": "#RelatedEntityRef", + "description": "A reference to an entity, where the type of the entity is not known in advance.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The hyperlink to access an entity." + }, + "id": { + "type": "string", + "description": "The identifier of an entity." + }, + "name": { + "type": "string", + "description": "The name of an entity." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/RelatedGeographicAddressRefOrValue.schema.json b/Common/RelatedGeographicAddressRefOrValue.schema.json index 7118427e..c6d9112d 100644 --- a/Common/RelatedGeographicAddressRefOrValue.schema.json +++ b/Common/RelatedGeographicAddressRefOrValue.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedGeographicAddressRefOrValue.schema.json", - "title": "RelatedGeographicAddressRefOrValue", - "definitions": { - "RelatedGeographicAddressRefOrValue": { - "discriminator": "isRef", - "$id": "#RelatedGeographicAddressRefOrValue", - "description": "#TODO", - "type": "object", - "properties": { - "isRef": { - "type": "boolean", - "default": true - }, - "role": { - "type": "string" - } - }, - "required": [ - "role" - ], - "allOf": [ - { - "$ref": "RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedGeographicAddressRefOrValue.schema.json", + "title": "RelatedGeographicAddressRefOrValue", + "definitions": { + "RelatedGeographicAddressRefOrValue": { + "discriminator": "isRef", + "$id": "#RelatedGeographicAddressRefOrValue", + "description": "#TODO", + "type": "object", + "properties": { + "isRef": { + "type": "boolean", + "default": true + }, + "role": { + "type": "string" } + }, + "required": [ + "role" + ], + "allOf": [ + { + "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/RelatedGeographicLocationRefOrValue.schema.json b/Common/RelatedGeographicLocationRefOrValue.schema.json index c336aa94..1e00fe39 100644 --- a/Common/RelatedGeographicLocationRefOrValue.schema.json +++ b/Common/RelatedGeographicLocationRefOrValue.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedGeographicLocationRefOrValue.schema.json", - "title": "RelatedGeographicLocationRefOrValue", - "definitions": { - "RelatedGeographicLocationRefOrValue": { - "discriminator": "isRef", - "$id": "#RelatedGeographicLocationRefOrValue", - "description": "#TODO", - "type": "object", - "properties": { - "isRef": { - "type": "boolean", - "default": true - }, - "role": { - "type": "string" - } - }, - "required": [ - "role" - ], - "allOf": [ - { - "$ref": "RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedGeographicLocationRefOrValue.schema.json", + "title": "RelatedGeographicLocationRefOrValue", + "definitions": { + "RelatedGeographicLocationRefOrValue": { + "discriminator": "isRef", + "$id": "#RelatedGeographicLocationRefOrValue", + "description": "#TODO", + "type": "object", + "properties": { + "isRef": { + "type": "boolean", + "default": true + }, + "role": { + "type": "string" } + }, + "required": [ + "role" + ], + "allOf": [ + { + "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/RelatedObject.schema.json b/Common/RelatedObject.schema.json index d9872e75..b5e407ea 100644 --- a/Common/RelatedObject.schema.json +++ b/Common/RelatedObject.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedObject.schema.json", - "title": "RelatedObject", - "definitions": { - "RelatedObject": { - "$id": "#RelatedObject", - "description": "Defines objects linked with trouble ticket.", - "type": "object", - "properties": { - "involvement": { - "type": "string", - "description": "Consequence of the ticket on the related object (for instance disputed, adjusted...)" - }, - "reference": { - "type": "string", - "description": "Reference of object" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedObject.schema.json", + "title": "RelatedObject", + "definitions": { + "RelatedObject": { + "$id": "#RelatedObject", + "description": "Defines objects linked with trouble ticket.", + "type": "object", + "properties": { + "involvement": { + "type": "string", + "description": "Consequence of the ticket on the related object (for instance disputed, adjusted...)" + }, + "reference": { + "type": "string", + "description": "Reference of object" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/RelatedPlace.schema.json b/Common/RelatedPlace.schema.json index 98388f55..690ee3f3 100644 --- a/Common/RelatedPlace.schema.json +++ b/Common/RelatedPlace.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedPlace.schema.json", - "title": "RelatedPlace", - "definitions": { - "RelatedPlace": { - "$id": "#RelatedPlace", - "description": "A Place and an associated role as installation adress, delivery address, etc....", - "type": "object", - "properties": { - "role": { - "type": "string", - "description": "Role of the place, such as: [home delivery], [shop retrieval])" - }, - "href": { - "type": "string", - "description": "Unique reference of the place" - }, - "id": { - "type": "string", - "description": "Unique identifier of the place" - }, - "name": { - "type": "string", - "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedPlace.schema.json", + "title": "RelatedPlace", + "definitions": { + "RelatedPlace": { + "$id": "#RelatedPlace", + "description": "A Place and an associated role as installation adress, delivery address, etc....", + "type": "object", + "properties": { + "role": { + "type": "string", + "description": "Role of the place, such as: [home delivery], [shop retrieval])" + }, + "href": { + "type": "string", + "description": "Unique reference of the place" + }, + "id": { + "type": "string", + "description": "Unique identifier of the place" + }, + "name": { + "type": "string", + "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/RelatedPlaceRefOrValue.schema.json b/Common/RelatedPlaceRefOrValue.schema.json index ffea8747..c9cf226c 100644 --- a/Common/RelatedPlaceRefOrValue.schema.json +++ b/Common/RelatedPlaceRefOrValue.schema.json @@ -1,29 +1,28 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedPlaceRefOrValue.schema.json", - "title": "RelatedPlaceRefOrValue", - "definitions": { - "RelatedPlaceRefOrValue": { - "discriminator": "isRef", - "$id": "#RelatedPlaceRefOrValue", - "description": "Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself", - "type": "object", - "properties": { - "role": { - "type": "string" - } - }, - "required": [ - "role" - ], - "allOf": [ - { - "$ref": "PlaceRef.schema.json#PlaceRef" - }, - { - "$ref": "Place.schema.json#Place" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedPlaceRefOrValue.schema.json", + "title": "RelatedPlaceRefOrValue", + "definitions": { + "RelatedPlaceRefOrValue": { + "$id": "#RelatedPlaceRefOrValue", + "description": "Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself", + "type": "object", + "properties": { + "role": { + "type": "string" } + }, + "required": [ + "role" + ], + "allOf": [ + { + "$ref": "../Common/PlaceRef.schema.json#PlaceRef" + }, + { + "$ref": "../Common/Place.schema.json#Place" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Request.schema.json b/Common/Request.schema.json index 0e90eb96..ef4d431c 100644 --- a/Common/Request.schema.json +++ b/Common/Request.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Request.schema.json", - "title": "Request", - "definitions": { - "Request": { - "$id": "#Request", - "type": "object", - "description": "A response to a request", - "properties": { - "body": { - "description": "The body of the request. For example for an HTTP request might contain content of a form .", - "type": "string" - }, - "header": { - "type": "array", - "description": "Items included in the header of the request. For example for an HTTP request might contain requested locale, basic authentication.", - "items": { - "$ref": "HeaderItem.schema.json#HeaderItem" - }, - "title": "header" - }, - "method": { - "description": "The protocol of the request, e.g. http", - "type": "string" - }, - "to": { - "description": "The target of the request, e.g. a URL for an HTTP request", - "type": "string" - } - }, - "required": [ - "body", - "header" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Request.schema.json", + "title": "Request", + "definitions": { + "Request": { + "$id": "#Request", + "type": "object", + "description": "A response to a request", + "properties": { + "body": { + "description": "The body of the request. For example for an HTTP request might contain content of a form .", + "type": "string" + }, + "header": { + "type": "array", + "description": "Items included in the header of the request. For example for an HTTP request might contain requested locale, basic authentication.", + "items": { + "$ref": "../Common/HeaderItem.schema.json#HeaderItem" + }, + "title": "header" + }, + "method": { + "description": "The protocol of the request, e.g. http", + "type": "string" + }, + "to": { + "description": "The target of the request, e.g. a URL for an HTTP request", + "type": "string" } + }, + "required": [ + "body", + "header" + ] } -} \ No newline at end of file + } +} diff --git a/Common/Resolution.schema.json b/Common/Resolution.schema.json index 5cdb7d73..e7830435 100644 --- a/Common/Resolution.schema.json +++ b/Common/Resolution.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Resolution.schema.json", - "title": "Resolution", - "definitions": { - "Resolution": { - "$id": "#Resolution", - "description": "The way one or more change request has been implementation through a direct remedy or task", - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The resolutions code, it can be configured as a multiple level hierarchy" - }, - "description": { - "type": "string", - "description": "The description of the resolution" - }, - "name": { - "type": "string", - "description": "The name of the resolution" - }, - "task": { - "type": "array", - "items": { - "$ref": "Task.schema.json#Task" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Resolution.schema.json", + "title": "Resolution", + "definitions": { + "Resolution": { + "$id": "#Resolution", + "description": "The way one or more change request has been implementation through a direct remedy or task", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The resolutions code, it can be configured as a multiple level hierarchy" + }, + "description": { + "type": "string", + "description": "The description of the resolution" + }, + "name": { + "type": "string", + "description": "The name of the resolution" + }, + "task": { + "type": "array", + "items": { + "$ref": "../Common/Task.schema.json#Task" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Response.schema.json b/Common/Response.schema.json index 15cbdccb..f19a221c 100644 --- a/Common/Response.schema.json +++ b/Common/Response.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Response.schema.json", - "title": "Response", - "definitions": { - "Response": { - "$id": "#Response", - "type": "object", - "description": "A response to a request", - "properties": { - "body": { - "description": "The body of the response. For example for an HTTP response might contain HTML for rendering.", - "type": "string" - }, - "header": { - "description": "Items included in the header of the response. For example for an HTTP response might contain negotiated locale.", - "type": "array", - "items": { - "$ref": "HeaderItem.schema.json#HeaderItem" - }, - "title": "header" - }, - "statusCode": { - "description": "The status of the response. For example for an HTTP response would be codes such as 200, 400, etc.", - "type": "string" - } - }, - "required": [ - "body", - "header" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Response.schema.json", + "title": "Response", + "definitions": { + "Response": { + "$id": "#Response", + "type": "object", + "description": "A response to a request", + "properties": { + "body": { + "description": "The body of the response. For example for an HTTP response might contain HTML for rendering.", + "type": "string" + }, + "header": { + "description": "Items included in the header of the response. For example for an HTTP response might contain negotiated locale.", + "type": "array", + "items": { + "$ref": "../Common/HeaderItem.schema.json#HeaderItem" + }, + "title": "header" + }, + "statusCode": { + "description": "The status of the response. For example for an HTTP response would be codes such as 200, 400, etc.", + "type": "string" } + }, + "required": [ + "body", + "header" + ] } -} \ No newline at end of file + } +} diff --git a/Common/RetrieveGeographicLocation.schema.json b/Common/RetrieveGeographicLocation.schema.json index b8eebea3..e1ccf71a 100644 --- a/Common/RetrieveGeographicLocation.schema.json +++ b/Common/RetrieveGeographicLocation.schema.json @@ -1,41 +1,41 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RetrieveGeographicLocation.schema.json", - "title": "RetrieveGeographicLocation", - "definitions": { - "RetrieveGeographicLocation": { - "$id": "#RetrieveGeographicLocation", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "id": { - "type": "string" - }, - "requestedAccuracy": { - "type": "number", - "format": "float" - }, - "status": { - "type": "string" - }, - "time": { - "type": "string", - "format": "date-time" - }, - "geographicLocation": { - "$ref": "GeographicLocation.schema.json#GeographicLocation" - }, - "thing": { - "$ref": "Object.schema.json#Object" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RetrieveGeographicLocation.schema.json", + "title": "RetrieveGeographicLocation", + "definitions": { + "RetrieveGeographicLocation": { + "$id": "#RetrieveGeographicLocation", + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "id": { + "type": "string" + }, + "requestedAccuracy": { + "type": "number", + "format": "float" + }, + "status": { + "type": "string" + }, + "time": { + "type": "string", + "format": "date-time" + }, + "geographicLocation": { + "$ref": "../Common/GeographicLocation.schema.json#GeographicLocation" + }, + "thing": { + "$ref": "../Common/Object.schema.json#Object" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/RetrieveLocationRelation.schema.json b/Common/RetrieveLocationRelation.schema.json index 0b7818ee..b596393c 100644 --- a/Common/RetrieveLocationRelation.schema.json +++ b/Common/RetrieveLocationRelation.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RetrieveLocationRelation.schema.json", - "title": "RetrieveLocationRelation", - "definitions": { - "RetrieveLocationRelation": { - "$id": "#RetrieveLocationRelation", - "type": "object", - "properties": { - "distance": { - "type": "string" - }, - "href": { - "type": "string" - }, - "id": { - "type": "string" - }, - "status": { - "type": "string" - }, - "time": { - "type": "string", - "format": "date-time" - }, - "intersection": { - "type": "array", - "items": { - "$ref": "GeographicLocation.schema.json#GeographicLocation" - } - }, - "location": { - "$ref": "GeographicLocationRef.schema.json#GeographicLocationRef" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RetrieveLocationRelation.schema.json", + "title": "RetrieveLocationRelation", + "definitions": { + "RetrieveLocationRelation": { + "$id": "#RetrieveLocationRelation", + "type": "object", + "properties": { + "distance": { + "type": "string" + }, + "href": { + "type": "string" + }, + "id": { + "type": "string" + }, + "status": { + "type": "string" + }, + "time": { + "type": "string", + "format": "date-time" + }, + "intersection": { + "type": "array", + "items": { + "$ref": "../Common/GeographicLocation.schema.json#GeographicLocation" + } + }, + "location": { + "$ref": "../Common/GeographicLocationRef.schema.json#GeographicLocationRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Sender.schema.json b/Common/Sender.schema.json index 9ae646cf..6ac6a4d1 100644 --- a/Common/Sender.schema.json +++ b/Common/Sender.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Sender.schema.json", - "title": "Sender", - "definitions": { - "Sender": { - "$id": "#Sender", - "description": "Sender of the communication message.", - "type": "object", - "properties": { - "email": { - "type": "string", - "description": "Sender address of email, if the communication type is email" - }, - "id": { - "type": "string", - "description": "ID of the sender" - }, - "name": { - "type": "string", - "description": "Name of the sender" - }, - "phoneNumber": { - "type": "string", - "description": "Phone number of the sender, if the communication type is SMS." - }, - "party": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Sender.schema.json", + "title": "Sender", + "definitions": { + "Sender": { + "$id": "#Sender", + "description": "Sender of the communication message.", + "type": "object", + "properties": { + "email": { + "type": "string", + "description": "Sender address of email, if the communication type is email" + }, + "id": { + "type": "string", + "description": "ID of the sender" + }, + "name": { + "type": "string", + "description": "Name of the sender" + }, + "phoneNumber": { + "type": "string", + "description": "Phone number of the sender, if the communication type is SMS." + }, + "party": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/SiteRelationship.schema.json b/Common/SiteRelationship.schema.json index d6b8ce45..b1f685eb 100644 --- a/Common/SiteRelationship.schema.json +++ b/Common/SiteRelationship.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SiteRelationship.schema.json", - "title": "SiteRelationship", - "definitions": { - "SiteRelationship": { - "$id": "#SiteRelationship", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the related site" - }, - "id": { - "type": "string", - "description": "Unique identifier of the related site entity within the server" - }, - "role": { - "type": "string", - "description": "Role of the related site in the relationship" - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "Validity for the relationship" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SiteRelationship.schema.json", + "title": "SiteRelationship", + "definitions": { + "SiteRelationship": { + "$id": "#SiteRelationship", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the related site" + }, + "id": { + "type": "string", + "description": "Unique identifier of the related site entity within the server" + }, + "role": { + "type": "string", + "description": "Role of the related site in the relationship" + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Validity for the relationship" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/SpecCharRelationship.schema.json b/Common/SpecCharRelationship.schema.json index f20d4964..71d75a0f 100644 --- a/Common/SpecCharRelationship.schema.json +++ b/Common/SpecCharRelationship.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SpecCharRelationship.schema.json", - "title": "SpecCharRelationship", - "definitions": { - "SpecCharRelationship": { - "$id": "#SpecCharRelationship", - "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink reference to the target entity specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the target entity specification" - }, - "name": { - "type": "string", - "description": "Name of the target specCharacteristic" - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which the SpecCharRelationship is valid" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SpecCharRelationship.schema.json", + "title": "SpecCharRelationship", + "definitions": { + "SpecCharRelationship": { + "$id": "#SpecCharRelationship", + "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink reference to the target entity specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the target entity specification" + }, + "name": { + "type": "string", + "description": "Name of the target specCharacteristic" + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the SpecCharRelationship is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/SpecCharacteristic.schema.json b/Common/SpecCharacteristic.schema.json index a1cd39f6..8223341c 100644 --- a/Common/SpecCharacteristic.schema.json +++ b/Common/SpecCharacteristic.schema.json @@ -1,51 +1,51 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SpecCharacteristic.schema.json", - "title": "SpecCharacteristic", - "definitions": { - "SpecCharacteristic": { - "$id": "#SpecCharacteristic", - "description": "A characteristic quality or distinctive feature of a Specification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", - "type": "object", - "properties": { - "configurable": { - "type": "boolean", - "description": "If true, the Boolean indicates that the SpecCharacteristic is configurable" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the SpecCharacteristic is" - }, - "name": { - "type": "string", - "description": "Name of the SpecCharacteristic" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productSpecCharacteristic is valid" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" - }, - "specCharacteristicValue": { - "type": "array", - "items": { - "$ref": "SpecCharacteristicValue.schema.json#SpecCharacteristicValue" - } - }, - "specCharRelationship": { - "type": "array", - "items": { - "$ref": "SpecCharRelationship.schema.json#SpecCharRelationship" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SpecCharacteristic.schema.json", + "title": "SpecCharacteristic", + "definitions": { + "SpecCharacteristic": { + "$id": "#SpecCharacteristic", + "description": "A characteristic quality or distinctive feature of a Specification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", + "type": "object", + "properties": { + "configurable": { + "type": "boolean", + "description": "If true, the Boolean indicates that the SpecCharacteristic is configurable" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the SpecCharacteristic is" + }, + "name": { + "type": "string", + "description": "Name of the SpecCharacteristic" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productSpecCharacteristic is valid" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" + }, + "specCharacteristicValue": { + "type": "array", + "items": { + "$ref": "../Common/SpecCharacteristicValue.schema.json#SpecCharacteristicValue" + } + }, + "specCharRelationship": { + "type": "array", + "items": { + "$ref": "../Common/SpecCharRelationship.schema.json#SpecCharRelationship" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/SpecCharacteristicValue.schema.json b/Common/SpecCharacteristicValue.schema.json index eb3efaed..0b505786 100644 --- a/Common/SpecCharacteristicValue.schema.json +++ b/Common/SpecCharacteristicValue.schema.json @@ -1,55 +1,55 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SpecCharacteristicValue.schema.json", - "title": "SpecCharacteristicValue", - "definitions": { - "SpecCharacteristicValue": { - "$id": "#SpecCharacteristicValue", - "description": "A number or text that can be assigned to a SpecCharacteristic", - "type": "object", - "properties": { - "isDefault": { - "type": "boolean", - "description": "If true, the Boolean Indicates if the value is the default value for a characteristic" - }, - "rangeInterval": { - "type": "string", - "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." - }, - "regex": { - "type": "string", - "description": "A regular expression constraint for given value" - }, - "unitOfMeasure": { - "type": "string", - "description": "unit of measure for the valueCould be minutes, GB, etc" - }, - "validFor": { - "$ref": "TimePeriod.schema.json#TimePeriod", - "description": "The period for which this object is valid" - }, - "value": { - "$ref": "Object.schema.json#Object", - "description": "the value that the characteristic can take on." - }, - "valueFrom": { - "type": "integer", - "description": "The low range value that a characteristic can take on" - }, - "valueTo": { - "type": "integer", - "description": "The upper range value that a characteristic can take on" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic value can take on, such as numeric, text and so forth" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SpecCharacteristicValue.schema.json", + "title": "SpecCharacteristicValue", + "definitions": { + "SpecCharacteristicValue": { + "$id": "#SpecCharacteristicValue", + "description": "A number or text that can be assigned to a SpecCharacteristic", + "type": "object", + "properties": { + "isDefault": { + "type": "boolean", + "description": "If true, the Boolean Indicates if the value is the default value for a characteristic" + }, + "rangeInterval": { + "type": "string", + "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." + }, + "regex": { + "type": "string", + "description": "A regular expression constraint for given value" + }, + "unitOfMeasure": { + "type": "string", + "description": "unit of measure for the valueCould be minutes, GB, etc" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which this object is valid" + }, + "value": { + "$ref": "../Common/Object.schema.json#Object", + "description": "the value that the characteristic can take on." + }, + "valueFrom": { + "type": "integer", + "description": "The low range value that a characteristic can take on" + }, + "valueTo": { + "type": "integer", + "description": "The upper range value that a characteristic can take on" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic value can take on, such as numeric, text and so forth" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/StatusChange.schema.json b/Common/StatusChange.schema.json index 7f52bf2e..5aa0220a 100644 --- a/Common/StatusChange.schema.json +++ b/Common/StatusChange.schema.json @@ -1,32 +1,32 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "StatusChange.schema.json", - "title": "StatusChange", - "definitions": { - "StatusChange": { - "$id": "#StatusChange", - "type": "object", - "description": "Holds the status notification reasons and associated date the status changed, populated by the server", - "properties": { - "changeDate": { - "type": "string", - "format": "date-time", - "description": "The date and time the status changed." - }, - "changeReason": { - "type": "string", - "description": "The reason why the status changed." - }, - "status": { - "type": "string", - "description": "The status of the trouble ticket" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "StatusChange.schema.json", + "title": "StatusChange", + "definitions": { + "StatusChange": { + "$id": "#StatusChange", + "type": "object", + "description": "Holds the status notification reasons and associated date the status changed, populated by the server", + "properties": { + "changeDate": { + "type": "string", + "format": "date-time", + "description": "The date and time the status changed." + }, + "changeReason": { + "type": "string", + "description": "The reason why the status changed." + }, + "status": { + "type": "string", + "description": "The status of the trouble ticket" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Street.schema.json b/Common/Street.schema.json index ef9dd6aa..7ea8b8ed 100644 --- a/Common/Street.schema.json +++ b/Common/Street.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Street.schema.json", - "title": "Street", - "definitions": { - "Street": { - "$id": "#Street", - "description": "A street is a road in a city or locality that has buildings that are usually close together along one or both sides", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the Street" - }, - "name": { - "type": "string", - "description": "The defined name of the street" - }, - "streetType": { - "type": "string", - "description": "Alley, avenue, etc." - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "LocationCharacteristic.schema.json#LocationCharacteristic" - } - }, - "address": { - "type": "array", - "items": { - "$ref": "AddressRef.schema.json#AddressRef" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Street.schema.json", + "title": "Street", + "definitions": { + "Street": { + "$id": "#Street", + "description": "A street is a road in a city or locality that has buildings that are usually close together along one or both sides", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the Street" + }, + "name": { + "type": "string", + "description": "The defined name of the street" + }, + "streetType": { + "type": "string", + "description": "Alley, avenue, etc." + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "../Common/LocationCharacteristic.schema.json#LocationCharacteristic" + } + }, + "address": { + "type": "array", + "items": { + "$ref": "../Common/AddressRef.schema.json#AddressRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/StreetSegment.schema.json b/Common/StreetSegment.schema.json index 421a1add..9d8bc34e 100644 --- a/Common/StreetSegment.schema.json +++ b/Common/StreetSegment.schema.json @@ -1,42 +1,42 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "StreetSegment.schema.json", - "title": "StreetSegment", - "definitions": { - "StreetSegment": { - "$id": "#StreetSegment", - "description": "StreetSegment corresponds to a part of a street referenced by a number or a set of number. Sometimes a suffix is added.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the Street Segment" - }, - "number": { - "type": "string", - "description": "number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" - }, - "numberLast": { - "type": "string", - "description": "the last number in a range of street numbers allocated to a property" - }, - "numberLastSuffix": { - "type": "string", - "description": "the last street number suffix for a ranged address" - }, - "numberSuffix": { - "type": "string", - "description": "the first street number suffix" - }, - "address": { - "$ref": "AddressRef.schema.json#AddressRef" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "StreetSegment.schema.json", + "title": "StreetSegment", + "definitions": { + "StreetSegment": { + "$id": "#StreetSegment", + "description": "StreetSegment corresponds to a part of a street referenced by a number or a set of number. Sometimes a suffix is added.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the Street Segment" + }, + "number": { + "type": "string", + "description": "number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses" + }, + "numberLast": { + "type": "string", + "description": "the last number in a range of street numbers allocated to a property" + }, + "numberLastSuffix": { + "type": "string", + "description": "the last street number suffix for a ranged address" + }, + "numberSuffix": { + "type": "string", + "description": "the first street number suffix" + }, + "address": { + "$ref": "../Common/AddressRef.schema.json#AddressRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/StringCharacteristic.schema.json b/Common/StringCharacteristic.schema.json index 772a232c..a8f2a120 100644 --- a/Common/StringCharacteristic.schema.json +++ b/Common/StringCharacteristic.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "StringCharacteristic.schema.json", - "title": "StringCharacteristic", - "definitions": { - "StringCharacteristic": { - "$id": "#StringCharacteristic", - "description": "A characteristic which value is a string", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "valueType": { - "type": "string", - "description": "Data type of the value of the characteristic" - }, - "value": { - "type": "string", - "description": "Value of the characteristic" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "StringCharacteristic.schema.json", + "title": "StringCharacteristic", + "definitions": { + "StringCharacteristic": { + "$id": "#StringCharacteristic", + "description": "A characteristic which value is a string", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "valueType": { + "type": "string", + "description": "Data type of the value of the characteristic" + }, + "value": { + "type": "string", + "description": "Value of the characteristic" } + } } -} \ No newline at end of file + } +} diff --git a/Common/SubAddress.schema.json b/Common/SubAddress.schema.json index a5c43fa5..c03fec7c 100644 --- a/Common/SubAddress.schema.json +++ b/Common/SubAddress.schema.json @@ -1,62 +1,62 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SubAddress.schema.json", - "title": "SubAddress", - "definitions": { - "SubAddress": { - "$id": "#SubAddress", - "description": "Representation of a SubAddress \nIt is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.", - "type": "object", - "properties": { - "buildingName": { - "type": "string", - "description": "Allows for buildings that have well-known names" - }, - "href": { - "type": "string" - }, - "id": { - "type": "string", - "description": "Unique ID for this SubAddress" - }, - "levelNumber": { - "type": "string", - "description": "Used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2" - }, - "levelType": { - "type": "string", - "description": "Describes level types within a building" - }, - "name": { - "type": "string", - "description": "Name of the subAddress to identify it with a meaningful identification" - }, - "privateStreetName": { - "type": "string", - "description": "Private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office." - }, - "privateStreetNumber": { - "type": "string", - "description": "Private streets numbers internal to a private street" - }, - "subUnitNumber": { - "type": "string", - "description": "The discriminator of the subunit, often just a simple number e.g. FLAT 5, may also be a range" - }, - "subUnitType": { - "type": "string", - "description": "The type of subunit, such as BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF" - }, - "subAddressType": { - "type": "string", - "description": "The type of subaddress : it can be a subunit or a private street" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SubAddress.schema.json", + "title": "SubAddress", + "definitions": { + "SubAddress": { + "$id": "#SubAddress", + "description": "Representation of a SubAddress \nIt is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.", + "type": "object", + "properties": { + "buildingName": { + "type": "string", + "description": "Allows for buildings that have well-known names" + }, + "href": { + "type": "string" + }, + "id": { + "type": "string", + "description": "Unique ID for this SubAddress" + }, + "levelNumber": { + "type": "string", + "description": "Used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2" + }, + "levelType": { + "type": "string", + "description": "Describes level types within a building" + }, + "name": { + "type": "string", + "description": "Name of the subAddress to identify it with a meaningful identification" + }, + "privateStreetName": { + "type": "string", + "description": "Private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office." + }, + "privateStreetNumber": { + "type": "string", + "description": "Private streets numbers internal to a private street" + }, + "subUnitNumber": { + "type": "string", + "description": "The discriminator of the subunit, often just a simple number e.g. FLAT 5, may also be a range" + }, + "subUnitType": { + "type": "string", + "description": "The type of subunit, such as BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF" + }, + "subAddressType": { + "type": "string", + "description": "The type of subaddress : it can be a subunit or a private street" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/TargetEntityRef.schema.json b/Common/TargetEntityRef.schema.json index 4b78a3f3..e0b3dfa3 100644 --- a/Common/TargetEntityRef.schema.json +++ b/Common/TargetEntityRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TargetEntityRef.schema.json", - "title": "TargetEntityRef", - "definitions": { - "TargetEntityRef": { - "$id": "#TargetEntityRef", - "description": "The entity which will be changed or configured while the change request is executed.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description to the related party." - }, - "href": { - "type": "string", - "description": "Hyperlink to access the target entity." - }, - "id": { - "type": "string", - "description": "Identifier of target entity" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TargetEntityRef.schema.json", + "title": "TargetEntityRef", + "definitions": { + "TargetEntityRef": { + "$id": "#TargetEntityRef", + "description": "The entity which will be changed or configured while the change request is executed.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description to the related party." + }, + "href": { + "type": "string", + "description": "Hyperlink to access the target entity." + }, + "id": { + "type": "string", + "description": "Identifier of target entity" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Task.schema.json b/Common/Task.schema.json index a647fba1..d605b08b 100644 --- a/Common/Task.schema.json +++ b/Common/Task.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Task.schema.json", - "title": "Task", - "definitions": { - "Task": { - "$id": "#Task", - "description": "A step or task along in the process of implementation a Change Request.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description of the task." - }, - "name": { - "type": "string", - "description": "The name of the task." - }, - "state": { - "type": "string", - "description": "The state of the task." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Task.schema.json", + "title": "Task", + "definitions": { + "Task": { + "$id": "#Task", + "description": "A step or task along in the process of implementation a Change Request.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of the task." + }, + "name": { + "type": "string", + "description": "The name of the task." + }, + "state": { + "type": "string", + "description": "The state of the task." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/TaskFlow.schema.json b/Common/TaskFlow.schema.json index 3e6e1145..9bb0083c 100644 --- a/Common/TaskFlow.schema.json +++ b/Common/TaskFlow.schema.json @@ -1,85 +1,81 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaskFlow.schema.json", - "title": "TaskFlow", - "definitions": { - "TaskFlow": { - "$id": "#TaskFlow", - "type": "object", - "properties": { - "channel": { - "type": "array", - "items": { - "$ref": "ChannelRef.schema.json#ChannelRef" - }, - "description": "A list of channel(s) where this taskFlow is executed" - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "Characteristic.schema.json#Characteristic" - }, - "description": "A list of characteristic(s) associated to this taskFlow" - }, - "completionMethod": { - "type": "string", - "description": "TaskFlow completion method." - }, - "href": { - "type": "string", - "description": "Reference of the taskFlow" - }, - "id": { - "type": "string", - "description": "Identifier of the taskFlow" - }, - "isMandatory": { - "type": "boolean", - "description": "Indicate mandatory TaskFlow." - }, - "priority": { - "type": "integer", - "description": "TaskFlow priority." - }, - "processFlowId": { - "type": "string", - "description": "Identifier of the processFlow" - }, - "relatedEntity": { - "type": "array", - "items": { - "$ref": "RelatedEntity.schema.json#RelatedEntity" - }, - "description": "A list of related entity(ies) to this taskFlow" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "description": "A list of related party(ies) to this task" - }, - "state": { - "$ref": "TaskFlowStateType.schema.json#TaskFlowStateType", - "description": "State of the taskFlow: described in the state machine diagram." - }, - "taskFlowRelationship": { - "type": "array", - "items": { - "$ref": "TaskFlowRelationship.schema.json#TaskFlowRelationship" - }, - "description": "A list of taskFlows related to this taskFlow" - }, - "taskFlowSpecification": { - "type": "string", - "description": "Specification of the taskFlow." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaskFlow.schema.json", + "title": "TaskFlow", + "definitions": { + "TaskFlow": { + "$id": "#TaskFlow", + "type": "object", + "properties": { + "channel": { + "type": "array", + "items": { + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "description": "A list of channel(s) where this taskFlow is executed" + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + }, + "description": "A list of characteristic(s) associated to this taskFlow" + }, + "completionMethod": { + "type": "string", + "description": "TaskFlow completion method." + }, + "href": { + "type": "string", + "description": "Reference of the taskFlow" + }, + "id": { + "type": "string", + "description": "Identifier of the taskFlow" + }, + "isMandatory": { + "type": "boolean", + "description": "Indicate mandatory TaskFlow." + }, + "priority": { + "type": "integer", + "description": "TaskFlow priority." + }, + "relatedEntity": { + "type": "array", + "items": { + "$ref": "../Common/RelatedEntity.schema.json#RelatedEntity" + }, + "description": "A list of related entity(ies) to this taskFlow" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "A list of related party(ies) to this task" + }, + "state": { + "$ref": "../Common/TaskFlowStateType.schema.json#TaskFlowStateType", + "description": "State of the taskFlow: described in the state machine diagram." + }, + "taskFlowRelationship": { + "type": "array", + "items": { + "$ref": "../Common/TaskFlowRelationship.schema.json#TaskFlowRelationship" + }, + "description": "A list of taskFlows related to this taskFlow" + }, + "taskFlowSpecification": { + "type": "string", + "description": "Specification of the taskFlow." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/TaskFlowRef.schema.json b/Common/TaskFlowRef.schema.json index 4b2a2e50..4dac2cb9 100644 --- a/Common/TaskFlowRef.schema.json +++ b/Common/TaskFlowRef.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaskFlowRef.schema.json", - "title": "TaskFlowRef", - "definitions": { - "TaskFlowRef": { - "$id": "#TaskFlowRef", - "type": "object", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "href": { - "type": "string", - "description": "Reference of the related entity." - }, - "id": { - "type": "string", - "description": "Unique identifier of a related entity." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaskFlowRef.schema.json", + "title": "TaskFlowRef", + "definitions": { + "TaskFlowRef": { + "$id": "#TaskFlowRef", + "type": "object", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "href": { + "type": "string", + "description": "Reference of the related entity." + }, + "id": { + "type": "string", + "description": "Unique identifier of a related entity." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/TaskFlowRelationship.schema.json b/Common/TaskFlowRelationship.schema.json index 5578ba78..88f161f8 100644 --- a/Common/TaskFlowRelationship.schema.json +++ b/Common/TaskFlowRelationship.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaskFlowRelationship.schema.json", - "title": "TaskFlowRelationship", - "definitions": { - "TaskFlowRelationship": { - "$id": "#TaskFlowRelationship", - "description": "Describes relationship between taskFlow", - "type": "object", - "required": [ - "relationshipType", - "taskFlow" - ], - "properties": { - "relationshipType": { - "type": "string", - "description": "The type of taskFlow relationship (requires, triggers, etc.)" - }, - "taskFlow": { - "description": "The taskFlow being referred to", - "$ref": "TaskFlowRef.schema.json#TaskFlowRef" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaskFlowRelationship.schema.json", + "title": "TaskFlowRelationship", + "definitions": { + "TaskFlowRelationship": { + "$id": "#TaskFlowRelationship", + "description": "Describes relationship between taskFlow", + "type": "object", + "required": [ + "relationshipType", + "taskFlow" + ], + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of taskFlow relationship (requires, triggers, etc.)" + }, + "taskFlow": { + "description": "The taskFlow being referred to", + "$ref": "../Common/TaskFlowRef.schema.json#TaskFlowRef" } + } } -} \ No newline at end of file + } +} diff --git a/Common/TaskFlowStateType.schema.json b/Common/TaskFlowStateType.schema.json index 131384f8..ae749906 100644 --- a/Common/TaskFlowStateType.schema.json +++ b/Common/TaskFlowStateType.schema.json @@ -1,19 +1,19 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaskFlowStateType.schema.json", - "title": "TaskFlowStateType", - "definitions": { - "TaskFlowStateType": { - "$id": "#TaskFlowStateType", - "type": "string", - "description": "Valid values for the lifecycle state of the taskFlow", - "enum": [ - "new", - "active", - "hold", - "cancelled", - "completed" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaskFlowStateType.schema.json", + "title": "TaskFlowStateType", + "definitions": { + "TaskFlowStateType": { + "$id": "#TaskFlowStateType", + "type": "string", + "description": "Valid values for the lifecycle state of the taskFlow", + "enum": [ + "new", + "active", + "hold", + "cancelled", + "completed" + ] } -} \ No newline at end of file + } +} diff --git a/Common/TaskStateType.schema.json b/Common/TaskStateType.schema.json index 592ca272..3cca3cc3 100644 --- a/Common/TaskStateType.schema.json +++ b/Common/TaskStateType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaskStateType.schema.json", - "title": "TaskStateType", - "definitions": { - "TaskStateType": { - "$id": "#TaskStateType", - "type": "string", - "description": "Possible values for the state of a task", - "enum": [ - "acknowledged", - "terminatedWithError", - "inProgress", - "done" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaskStateType.schema.json", + "title": "TaskStateType", + "definitions": { + "TaskStateType": { + "$id": "#TaskStateType", + "type": "string", + "description": "Possible values for the state of a task", + "enum": [ + "acknowledged", + "terminatedWithError", + "inProgress", + "done" + ] } -} \ No newline at end of file + } +} diff --git a/Common/TaxDefinition.schema.json b/Common/TaxDefinition.schema.json index ed926fca..0d8df197 100644 --- a/Common/TaxDefinition.schema.json +++ b/Common/TaxDefinition.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaxDefinition.schema.json", - "title": "TaxDefinition", - "definitions": { - "TaxDefinition": { - "$id": "#TaxDefinition", - "type": "object", - "description": "Reference of a tax definition. A tax is levied by an authorized tax jurisdiction. There are many different types of tax (Federal Tax levied by the US Government, State Tax levied by the State of California,…).", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "id": { - "type": "string", - "description": "Unique identifier of the tax." - }, - "name": { - "type": "string", - "description": "Tax name." - }, - "taxType": { - "type": "string", - "description": "Type of the tax." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaxDefinition.schema.json", + "title": "TaxDefinition", + "definitions": { + "TaxDefinition": { + "$id": "#TaxDefinition", + "type": "object", + "description": "Reference of a tax definition. A tax is levied by an authorized tax jurisdiction. There are many different types of tax (Federal Tax levied by the US Government, State Tax levied by the State of California,…).", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "id": { + "type": "string", + "description": "Unique identifier of the tax." + }, + "name": { + "type": "string", + "description": "Tax name." + }, + "taxType": { + "type": "string", + "description": "Type of the tax." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/Ticket.schema.json b/Common/Ticket.schema.json index 37de7be4..a4623aa6 100644 --- a/Common/Ticket.schema.json +++ b/Common/Ticket.schema.json @@ -1,96 +1,96 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Ticket.schema.json", - "title": "Ticket", - "definitions": { - "Ticket": { - "$id": "#Ticket", - "description": "A trouble ticket represents a record used for reporting and managing the resolution of resource problems", - "type": "object", - "properties": { - "correlationId": { - "type": "string", - "description": "Additional identifier coming from an external system" - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "The date on which the trouble was discovered" - }, - "description": { - "type": "string", - "description": "Description of the trouble" - }, - "href": { - "type": "string", - "description": "Reference of the trouble ticket" - }, - "id": { - "type": "string", - "description": "Unique identifier of the trouble ticket" - }, - "resolutionDate": { - "type": "string", - "format": "date-time", - "description": "The date on which the service was brought back to its original condition" - }, - "severity": { - "type": "string", - "description": "The severity of the trouble. It can be for example : minor, major, critical" - }, - "status": { - "type": "string", - "description": "The current status of the Trouble Ticket" - }, - "statusChangeDate": { - "type": "string", - "format": "date-time", - "description": "The date of state change" - }, - "statusChangeReason": { - "type": "string", - "description": "The reason of state change" - }, - "subStatus": { - "type": "string", - "description": "The current sub status of the Trouble Ticket" - }, - "targetResolutionDate": { - "type": "string", - "format": "date-time", - "description": "Foreseen trouble resolution date" - }, - "ticketType": { - "type": "string", - "description": "Type of trouble ticket" - }, - "relatedObject": { - "type": "array", - "description": "Any object(s) associated with this trouble ticket", - "items": { - "$ref": "RelatedObject.schema.json#RelatedObject" - } - }, - "note": { - "type": "array", - "description": "Any note(s) associated with this trouble ticket", - "items": { - "$ref": "Note.schema.json#Note" - } - }, - "relatedParty": { - "type": "array", - "description": "Any Party/Parties associated with this trouble ticket", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Ticket.schema.json", + "title": "Ticket", + "definitions": { + "Ticket": { + "$id": "#Ticket", + "description": "A trouble ticket represents a record used for reporting and managing the resolution of resource problems", + "type": "object", + "properties": { + "correlationId": { + "type": "string", + "description": "Additional identifier coming from an external system" + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "The date on which the trouble was discovered" + }, + "description": { + "type": "string", + "description": "Description of the trouble" + }, + "href": { + "type": "string", + "description": "Reference of the trouble ticket" + }, + "id": { + "type": "string", + "description": "Unique identifier of the trouble ticket" + }, + "resolutionDate": { + "type": "string", + "format": "date-time", + "description": "The date on which the service was brought back to its original condition" + }, + "severity": { + "type": "string", + "description": "The severity of the trouble. It can be for example : minor, major, critical" + }, + "status": { + "type": "string", + "description": "The current status of the Trouble Ticket" + }, + "statusChangeDate": { + "type": "string", + "format": "date-time", + "description": "The date of state change" + }, + "statusChangeReason": { + "type": "string", + "description": "The reason of state change" + }, + "subStatus": { + "type": "string", + "description": "The current sub status of the Trouble Ticket" + }, + "targetResolutionDate": { + "type": "string", + "format": "date-time", + "description": "Foreseen trouble resolution date" + }, + "ticketType": { + "type": "string", + "description": "Type of trouble ticket" + }, + "relatedObject": { + "type": "array", + "description": "Any object(s) associated with this trouble ticket", + "items": { + "$ref": "../Common/RelatedObject.schema.json#RelatedObject" + } + }, + "note": { + "type": "array", + "description": "Any note(s) associated with this trouble ticket", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "relatedParty": { + "type": "array", + "description": "Any Party/Parties associated with this trouble ticket", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/TicketRelationship.schema.json b/Common/TicketRelationship.schema.json index 30109f86..3cb0edf4 100644 --- a/Common/TicketRelationship.schema.json +++ b/Common/TicketRelationship.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TicketRelationship.schema.json", - "title": "TicketRelationship", - "definitions": { - "TicketRelationship": { - "$id": "#TicketRelationship", - "type": "object", - "description": "Represents a relationship between trouble tickets", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of the trouble ticket relationship can be isChiled, dependent etc..." - }, - "product": { - "$ref": "TroubleTicketRef.schema.json#TroubleTicketRef" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TicketRelationship.schema.json", + "title": "TicketRelationship", + "definitions": { + "TicketRelationship": { + "$id": "#TicketRelationship", + "type": "object", + "description": "Represents a relationship between trouble tickets", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of the trouble ticket relationship can be isChiled, dependent etc..." + }, + "product": { + "$ref": "../Common/TroubleTicketRef.schema.json#TroubleTicketRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/TimePeriod.schema.json b/Common/TimePeriod.schema.json index 57900761..d8fecf2f 100644 --- a/Common/TimePeriod.schema.json +++ b/Common/TimePeriod.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TimePeriod.schema.json", - "title": "TimePeriod", - "definitions": { - "TimePeriod": { - "$id": "#TimePeriod", - "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", - "type": "object", - "properties": { - "startDateTime": { - "description": "Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end", - "type": "string", - "format": "date-time", - "examples": [ - "1985-04-12T23:20:50.52Z", - "2018-09-21T09:13:16-07:00" - ] - }, - "endDateTime": { - "description": "End of the time period, using IETC-RFC-3339 format", - "type": "string", - "format": "date-time", - "examples": [ - "1985-04-12T23:20:50.52Z", - "2018-09-21T09:13:16-07:00" - ] - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TimePeriod.schema.json", + "title": "TimePeriod", + "definitions": { + "TimePeriod": { + "$id": "#TimePeriod", + "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", + "type": "object", + "properties": { + "startDateTime": { + "description": "Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end", + "type": "string", + "format": "date-time", + "examples": [ + "1985-04-12T23:20:50.52Z", + "2018-09-21T09:13:16-07:00" + ] + }, + "endDateTime": { + "description": "End of the time period, using IETC-RFC-3339 format", + "type": "string", + "format": "date-time", + "examples": [ + "1985-04-12T23:20:50.52Z", + "2018-09-21T09:13:16-07:00" + ] } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/TimePeriodType.schema.json b/Common/TimePeriodType.schema.json index 1bb16b8b..f61f4338 100644 --- a/Common/TimePeriodType.schema.json +++ b/Common/TimePeriodType.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TimePeriodType.schema.json", - "title": "TimePeriodType", - "definitions": { - "TimePeriodType": { - "$id": "#TimePeriodType", - "description": "Representation of a time period", - "properties": { - "endDateTime": { - "type": "string", - "format": "date-time", - "description": "End date of the period" - }, - "startDateTime": { - "type": "string", - "format": "date-time", - "description": "Start date of the period" - } - }, - "required": [ - "startDateTime" - ], - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TimePeriodType.schema.json", + "title": "TimePeriodType", + "definitions": { + "TimePeriodType": { + "$id": "#TimePeriodType", + "description": "Representation of a time period", + "properties": { + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "End date of the period" + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Start date of the period" } + }, + "required": [ + "startDateTime" + ], + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Common/Topic.schema.json b/Common/Topic.schema.json new file mode 100644 index 00000000..67000d33 --- /dev/null +++ b/Common/Topic.schema.json @@ -0,0 +1,39 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Topic.schema.json", + "title": "Topic", + "definitions": { + "Topic": { + "$id": "#Topic", + "description": "Is a event channel provided by the Event Streaming API", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier of the notification." + }, + "name": { + "type": "string", + "description": "use to identify grouping of events, per domain, per event types, per access control-right and so on." + }, + "href": { + "type": "string", + "description": "Reference of the related entity." + }, + "headerQuery": { + "type": "string", + "description": "is the filter that will be applied on the Event header properties." + }, + "contentQuery": { + "type": "string", + "description": "is the filter that will be applied on the content of the Event." + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] + } + } +} diff --git a/Common/TroubleTicket.schema.json b/Common/TroubleTicket.schema.json index bff3bb6c..4515d579 100755 --- a/Common/TroubleTicket.schema.json +++ b/Common/TroubleTicket.schema.json @@ -1,135 +1,135 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TroubleTicket.schema.json", - "title": "TroubleTicket", - "definitions": { - "TroubleTicket": { - "$id": "#TroubleTicket", - "type": "object", - "description": "A trouble ticket is a record of an issue that is created, tracked, and managed by a trouble ticket management system", - "properties": { - "attachment": { - "type": "array", - "items": { - "$ref": "AttachmentRefOrValue.schema.json#AttachmentRefOrValue" - }, - "description": "File(s) attached to the trouble ticket. e.g. pictur of broken device, scaning of a bill or charge" - }, - "channel": { - "$ref": "ChannelRef.schema.json#ChannelRef", - "description": "The channel that origin the trouble ticket" - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "The date on which the trouble ticket was created" - }, - "description": { - "type": "string", - "description": "Description of the trouble or issue" - }, - "expectedResolutionDate": { - "type": "string", - "format": "date-time", - "description": "The expected resolution date determined by the trouble ticket system" - }, - "externalId": { - "type": "string", - "description": "Additional identifier coming from an external system" - }, - "href": { - "type": "string", - "description": "Hyperlink, a reference to the trouble ticket entity" - }, - "id": { - "type": "string", - "description": "Unique identifier of the trouble ticket" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "The date and time that the trouble ticked was last updated" - }, - "name": { - "type": "string", - "description": "Name of the trouble ticket, typically a short description provided by the user that create the ticket" - }, - "note": { - "type": "array", - "items": { - "$ref": "Note.schema.json#Note" - }, - "description": "The note(s) that are associated to the ticket." - }, - "priority": { - "type": "string", - "description": "The priority of the trouble ticket and how quickly the issue should be resolved. Example: Critical, High, Medium, Low. The value is set by the ticket management system considering the severity, ticket type etc..." - }, - "relatedEntity": { - "type": "array", - "items": { - "$ref": "RelatedEntity.schema.json#RelatedEntity" - }, - "description": "An entity that is related to the ticket such as a bill, a product, etc. The entity against which the ticket is associated." - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "description": "The related party(ies) that are associated to the ticket." - }, - "requestedResolutionDate": { - "type": "string", - "format": "date-time", - "description": "The resolution date requested by the user" - }, - "resolutionDate": { - "type": "string", - "format": "date-time", - "description": "The date and time the trouble ticket was resolved" - }, - "severity": { - "type": "string", - "description": "The severity of the issue. Indicate the implication of the issue on the expected functionality e.g. of a system, application, service etc.. \nSeverity values can be for example : Critical, Major, Minor" - }, - "status": { - "$ref": "TroubleTicketStatusType.schema.json#TroubleTicketStatusType", - "description": "The current status of the trouble ticket" - }, - "statusChange": { - "type": "array", - "items": { - "$ref": "StatusChange.schema.json#StatusChange" - }, - "description": "The status change history that are associated to the ticket.Populated by the server" - }, - "statusChangeDate": { - "type": "string", - "format": "date-time", - "description": "The date and time the status changed." - }, - "statusChangeReason": { - "type": "string", - "description": "The reason for changing the status" - }, - "troubleTicketRelationship": { - "type": "array", - "items": { - "$ref": "TroubleTicketRelationship.schema.json#TroubleTicketRelationship" - }, - "description": "A list of trouble ticket relationships (TroubleTicketRelationship [*]). Represents a relationship between trouble tickets" - }, - "ticketType": { - "type": "string", - "description": "represent a business type of the trouble ticket e.g. incident, complain, request" - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TroubleTicket.schema.json", + "title": "TroubleTicket", + "definitions": { + "TroubleTicket": { + "$id": "#TroubleTicket", + "type": "object", + "description": "A trouble ticket is a record of an issue that is created, tracked, and managed by a trouble ticket management system", + "properties": { + "attachment": { + "type": "array", + "items": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + }, + "description": "File(s) attached to the trouble ticket. e.g. pictur of broken device, scaning of a bill or charge" + }, + "channel": { + "$ref": "../Common/ChannelRef.schema.json#ChannelRef", + "description": "The channel that origin the trouble ticket" + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "The date on which the trouble ticket was created" + }, + "description": { + "type": "string", + "description": "Description of the trouble or issue" + }, + "expectedResolutionDate": { + "type": "string", + "format": "date-time", + "description": "The expected resolution date determined by the trouble ticket system" + }, + "externalId": { + "type": "string", + "description": "Additional identifier coming from an external system" + }, + "href": { + "type": "string", + "description": "Hyperlink, a reference to the trouble ticket entity" + }, + "id": { + "type": "string", + "description": "Unique identifier of the trouble ticket" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "The date and time that the trouble ticked was last updated" + }, + "name": { + "type": "string", + "description": "Name of the trouble ticket, typically a short description provided by the user that create the ticket" + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + }, + "description": "The note(s) that are associated to the ticket." + }, + "priority": { + "type": "string", + "description": "The priority of the trouble ticket and how quickly the issue should be resolved. Example: Critical, High, Medium, Low. The value is set by the ticket management system considering the severity, ticket type etc..." + }, + "relatedEntity": { + "type": "array", + "items": { + "$ref": "../Common/RelatedEntity.schema.json#RelatedEntity" + }, + "description": "An entity that is related to the ticket such as a bill, a product, etc. The entity against which the ticket is associated." + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "The related party(ies) that are associated to the ticket." + }, + "requestedResolutionDate": { + "type": "string", + "format": "date-time", + "description": "The resolution date requested by the user" + }, + "resolutionDate": { + "type": "string", + "format": "date-time", + "description": "The date and time the trouble ticket was resolved" + }, + "severity": { + "type": "string", + "description": "The severity of the issue. Indicate the implication of the issue on the expected functionality e.g. of a system, application, service etc.. \nSeverity values can be for example : Critical, Major, Minor" + }, + "status": { + "$ref": "../Common/TroubleTicketStatusType.schema.json#TroubleTicketStatusType", + "description": "The current status of the trouble ticket" + }, + "statusChange": { + "type": "array", + "items": { + "$ref": "../Common/StatusChange.schema.json#StatusChange" + }, + "description": "The status change history that are associated to the ticket.Populated by the server" + }, + "statusChangeDate": { + "type": "string", + "format": "date-time", + "description": "The date and time the status changed." + }, + "statusChangeReason": { + "type": "string", + "description": "The reason for changing the status" + }, + "troubleTicketRelationship": { + "type": "array", + "items": { + "$ref": "../Common/TroubleTicketRelationship.schema.json#TroubleTicketRelationship" + }, + "description": "A list of trouble ticket relationships (TroubleTicketRelationship [*]). Represents a relationship between trouble tickets" + }, + "ticketType": { + "type": "string", + "description": "represent a business type of the trouble ticket e.g. incident, complain, request" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/TroubleTicketRef.schema.json b/Common/TroubleTicketRef.schema.json index aa297e9e..bcf41351 100644 --- a/Common/TroubleTicketRef.schema.json +++ b/Common/TroubleTicketRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TroubleTicketRef.schema.json", - "title": "TroubleTicketRef", - "definitions": { - "TroubleTicketRef": { - "$id": "#TroubleTicketRef", - "description": "TroubleTicket reference, for when a Trouble Ticket is used by other entities", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TroubleTicketRef.schema.json", + "title": "TroubleTicketRef", + "definitions": { + "TroubleTicketRef": { + "$id": "#TroubleTicketRef", + "description": "TroubleTicket reference, for when a Trouble Ticket is used by other entities", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} \ No newline at end of file + } +} diff --git a/Common/TroubleTicketRelationship.schema.json b/Common/TroubleTicketRelationship.schema.json index bdbbf030..66556034 100755 --- a/Common/TroubleTicketRelationship.schema.json +++ b/Common/TroubleTicketRelationship.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TroubleTicketRelationship.schema.json", - "title": "TroubleTicketRelationship", - "definitions": { - "TroubleTicketRelationship": { - "$id": "#TroubleTicketRelationship", - "type": "object", - "description": "Represents a relationship between trouble TroubleTickets", - "properties": { - "troubleTicket": { - "$ref": "TroubleTicketRef.schema.json#TroubleTicketRef" - }, - "relationshipType": { - "type": "string", - "description": "Type of the Trouble Ticket relationship can be isChiled, dependent etc..." - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TroubleTicketRelationship.schema.json", + "title": "TroubleTicketRelationship", + "definitions": { + "TroubleTicketRelationship": { + "$id": "#TroubleTicketRelationship", + "type": "object", + "description": "Represents a relationship between trouble TroubleTickets", + "properties": { + "troubleTicket": { + "$ref": "../Common/TroubleTicketRef.schema.json#TroubleTicketRef" + }, + "relationshipType": { + "type": "string", + "description": "Type of the Trouble Ticket relationship can be isChiled, dependent etc..." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Common/TroubleTicketStatusType.schema.json b/Common/TroubleTicketStatusType.schema.json index fb50ef62..6b1e898f 100644 --- a/Common/TroubleTicketStatusType.schema.json +++ b/Common/TroubleTicketStatusType.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TroubleTicketStatusType.schema.json", - "title": "TroubleTicketStatusType", - "definitions": { - "TroubleTicketStatusType": { - "$id": "#TroubleTicketStatusType", - "type": "string", - "description": "Possible values for the status of the trouble ticket", - "enum": [ - "acknowledged", - "rejected", - "pending", - "held", - "inProgress", - "cancelled", - "closed", - "resolved" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TroubleTicketStatusType.schema.json", + "title": "TroubleTicketStatusType", + "definitions": { + "TroubleTicketStatusType": { + "$id": "#TroubleTicketStatusType", + "type": "string", + "description": "Possible values for the status of the trouble ticket", + "enum": [ + "acknowledged", + "rejected", + "pending", + "held", + "inProgress", + "cancelled", + "closed", + "resolved" + ] } -} \ No newline at end of file + } +} diff --git a/Common/Value.schema.json b/Common/Value.schema.json index 191e46e1..6dc7f861 100644 --- a/Common/Value.schema.json +++ b/Common/Value.schema.json @@ -1,17 +1,17 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Value.schema.json", - "title": "Value", - "definitions": { - "Value": { - "$id": "#Value", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Value.schema.json", + "title": "Value", + "definitions": { + "Value": { + "$id": "#Value", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" } + ] } -} \ No newline at end of file + } +} diff --git a/Common/WorkLog.schema.json b/Common/WorkLog.schema.json index 0e0b13e1..f084c2d7 100644 --- a/Common/WorkLog.schema.json +++ b/Common/WorkLog.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "WorkLog.schema.json", - "title": "WorkLog", - "definitions": { - "WorkLog": { - "$id": "#WorkLog", - "description": "A record of the work performed on the change request during the investigation and resolution process.", - "type": "object", - "properties": { - "createDateTime": { - "type": "string", - "format": "date-time", - "description": "Date and time of worklog generated." - }, - "description": { - "type": "string", - "description": "The description of the worklog." - }, - "lastUpdateDateTime": { - "type": "string", - "description": "Date and time when the worklog updated." - }, - "record": { - "type": "array", - "items": { - "$ref": "Record.schema.json#Record" - } - } - }, - "allOf": [ - { - "$ref": "Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "WorkLog.schema.json", + "title": "WorkLog", + "definitions": { + "WorkLog": { + "$id": "#WorkLog", + "description": "A record of the work performed on the change request during the investigation and resolution process.", + "type": "object", + "properties": { + "createDateTime": { + "type": "string", + "format": "date-time", + "description": "Date and time of worklog generated." + }, + "description": { + "type": "string", + "description": "The description of the worklog." + }, + "lastUpdateDateTime": { + "type": "string", + "description": "Date and time when the worklog updated." + }, + "record": { + "type": "array", + "items": { + "$ref": "../Common/Record.schema.json#Record" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/AccumulatedBalance.schema.json b/Customer/AccumulatedBalance.schema.json index 8c2b4d49..4637fd7f 100644 --- a/Customer/AccumulatedBalance.schema.json +++ b/Customer/AccumulatedBalance.schema.json @@ -1,60 +1,60 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccumulatedBalance.schema.json", - "title": "AccumulatedBalance", - "definitions": { - "AccumulatedBalance": { - "$id": "#AccumulatedBalance", - "description": "Represents and tracks the aggregated amount remained or owed in certain account which is owned by certain customer for a set of buckets.", - "properties": { - "bucket": { - "type": "array", - "items": { - "$ref": "BucketBalanceRef.schema.json#BucketBalanceRef" - }, - "description": "A reference to the buckets involved in the aggregation" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the aggregated balance" - }, - "name": { - "type": "string", - "description": "Friendly name to identify the aggregated balance" - }, - "partyAccount": { - "type": "array", - "items": { - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - }, - "description": "A reference to the account that owns the buckets aggregated" - }, - "product": { - "type": "array", - "items": { - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "description": "A reference to the product whose consumption is managed by the bucket . This is an array to allow scenarios where a buckets are shared between different products" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "description": "Used to provide information about any other entity with relation to the balance, for instance to define customer hierarchy for the balance (e.g.: customerId, userId, )" - }, - "totalBalance": { - "description": "Aggregated for a set of prepay balance buckets associated to the product", - "$ref": "../Common/QuantityType.schema.json#QuantityType" - } - }, - "required": [ - "name", - "totalBalance", - "bucket", - "product" - ], - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccumulatedBalance.schema.json", + "title": "AccumulatedBalance", + "definitions": { + "AccumulatedBalance": { + "$id": "#AccumulatedBalance", + "description": "Represents and tracks the aggregated amount remained or owed in certain account which is owned by certain customer for a set of buckets.", + "properties": { + "bucket": { + "type": "array", + "items": { + "$ref": "../Customer/BucketBalanceRef.schema.json#BucketBalanceRef" + }, + "description": "A reference to the buckets involved in the aggregation" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the aggregated balance" + }, + "name": { + "type": "string", + "description": "Friendly name to identify the aggregated balance" + }, + "partyAccount": { + "type": "array", + "items": { + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "description": "A reference to the account that owns the buckets aggregated" + }, + "product": { + "type": "array", + "items": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "description": "A reference to the product whose consumption is managed by the bucket . This is an array to allow scenarios where a buckets are shared between different products" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "Used to provide information about any other entity with relation to the balance, for instance to define customer hierarchy for the balance (e.g.: customerId, userId, )" + }, + "totalBalance": { + "description": "Aggregated for a set of prepay balance buckets associated to the product", + "$ref": "../Common/QuantityType.schema.json#QuantityType" } + }, + "required": [ + "name", + "totalBalance", + "bucket", + "product" + ], + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Customer/AppliedBillingRate.schema.json b/Customer/AppliedBillingRate.schema.json index 09bddfe0..7281f630 100644 --- a/Customer/AppliedBillingRate.schema.json +++ b/Customer/AppliedBillingRate.schema.json @@ -1,67 +1,67 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppliedBillingRate.schema.json", - "title": "AppliedBillingRate", - "definitions": { - "AppliedBillingRate": { - "$id": "#AppliedBillingRate", - "description": "An applied billing rate presented on a bill. It is created before or during the billing process", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time", - "description": "Creation date of the applied billing charge" - }, - "description": { - "type": "string", - "description": "Additional data to be displayed on the bill for this applied billing charge" - }, - "href": { - "type": "string", - "description": "Reference of the applied billing charge" - }, - "id": { - "type": "string", - "description": "Unique identifier of the applied billing charge" - }, - "name": { - "type": "string", - "description": "Name of the applied billing rate" - }, - "taxExcludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Tax excluded amount to be charged on the bill (expresses in the given currency) for this applied billing rate" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "All taxes included amount to be charged on the bill (expressed in the given currency) for this applied billing rate" - }, - "rateType": { - "type": "string", - "description": "Type of the applied billing rate : appliedBillingCharge (any kind of charge except taxation charges : recurringCharge, oneTimeCharge, usageCharge), appliedBillingCredit (any kind of credit : rebate or productAlteration) or appliedPenaltyCharge (penalty charges such as late fees, payment rejection fees,...)" - }, - "appliedTax": { - "type": "array", - "items": { - "$ref": "AppliedBillingTaxRate.schema.json#AppliedBillingTaxRate" - } - }, - "bill": { - "$ref": "BillRef.schema.json#BillRef" - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "AppliedBillingRateCharacteristic.schema.json#AppliedBillingRateCharacteristic" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppliedBillingRate.schema.json", + "title": "AppliedBillingRate", + "definitions": { + "AppliedBillingRate": { + "$id": "#AppliedBillingRate", + "description": "An applied billing rate presented on a bill. It is created before or during the billing process", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "Creation date of the applied billing charge" + }, + "description": { + "type": "string", + "description": "Additional data to be displayed on the bill for this applied billing charge" + }, + "href": { + "type": "string", + "description": "Reference of the applied billing charge" + }, + "id": { + "type": "string", + "description": "Unique identifier of the applied billing charge" + }, + "name": { + "type": "string", + "description": "Name of the applied billing rate" + }, + "taxExcludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Tax excluded amount to be charged on the bill (expresses in the given currency) for this applied billing rate" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "All taxes included amount to be charged on the bill (expressed in the given currency) for this applied billing rate" + }, + "rateType": { + "type": "string", + "description": "Type of the applied billing rate : appliedBillingCharge (any kind of charge except taxation charges : recurringCharge, oneTimeCharge, usageCharge), appliedBillingCredit (any kind of credit : rebate or productAlteration) or appliedPenaltyCharge (penalty charges such as late fees, payment rejection fees,...)" + }, + "appliedTax": { + "type": "array", + "items": { + "$ref": "../Customer/AppliedBillingTaxRate.schema.json#AppliedBillingTaxRate" + } + }, + "bill": { + "$ref": "../Customer/BillRef.schema.json#BillRef" + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "../Customer/AppliedBillingRateCharacteristic.schema.json#AppliedBillingRateCharacteristic" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/AppliedBillingRateCharacteristic.schema.json b/Customer/AppliedBillingRateCharacteristic.schema.json index 82f8f41e..e6c52f0d 100644 --- a/Customer/AppliedBillingRateCharacteristic.schema.json +++ b/Customer/AppliedBillingRateCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppliedBillingRateCharacteristic.schema.json", - "title": "AppliedBillingRateCharacteristic", - "definitions": { - "AppliedBillingRateCharacteristic": { - "$id": "#AppliedBillingRateCharacteristic", - "description": "An applied billing rate has dynamic characteristics according to the its type (characteristics are based on the service type, line of business or on others parameters)", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Characteristic name" - }, - "value": { - "type": "string", - "description": "Value affected to the characteristic" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppliedBillingRateCharacteristic.schema.json", + "title": "AppliedBillingRateCharacteristic", + "definitions": { + "AppliedBillingRateCharacteristic": { + "$id": "#AppliedBillingRateCharacteristic", + "description": "An applied billing rate has dynamic characteristics according to the its type (characteristics are based on the service type, line of business or on others parameters)", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Characteristic name" + }, + "value": { + "type": "string", + "description": "Value affected to the characteristic" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/AppliedBillingTaxRate.schema.json b/Customer/AppliedBillingTaxRate.schema.json index 844d41c5..53eb1afe 100644 --- a/Customer/AppliedBillingTaxRate.schema.json +++ b/Customer/AppliedBillingTaxRate.schema.json @@ -1,32 +1,32 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppliedBillingTaxRate.schema.json", - "title": "AppliedBillingTaxRate", - "definitions": { - "AppliedBillingTaxRate": { - "$id": "#AppliedBillingTaxRate", - "description": "The applied billing tax rate represents taxes applied billing rate it refers to. It is calculated during the billing process.", - "type": "object", - "properties": { - "taxAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Tax amount expressed in the given currency" - }, - "taxCategory": { - "type": "string", - "description": "A categorization of the tax rate" - }, - "taxRate": { - "type": "number", - "format": "float", - "description": "Applied rate" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppliedBillingTaxRate.schema.json", + "title": "AppliedBillingTaxRate", + "definitions": { + "AppliedBillingTaxRate": { + "$id": "#AppliedBillingTaxRate", + "description": "The applied billing tax rate represents taxes applied billing rate it refers to. It is calculated during the billing process.", + "type": "object", + "properties": { + "taxAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Tax amount expressed in the given currency" + }, + "taxCategory": { + "type": "string", + "description": "A categorization of the tax rate" + }, + "taxRate": { + "type": "number", + "format": "float", + "description": "Applied rate" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/AppliedCustomerBillingRate.schema.json b/Customer/AppliedCustomerBillingRate.schema.json index 77eec26f..8a1867f7 100644 --- a/Customer/AppliedCustomerBillingRate.schema.json +++ b/Customer/AppliedCustomerBillingRate.schema.json @@ -1,67 +1,67 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppliedCustomerBillingRate.schema.json", - "title": "AppliedCustomerBillingRate", - "definitions": { - "AppliedCustomerBillingRate": { - "$id": "#AppliedCustomerBillingRate", - "description": "An applied billing rate presented on a customer bill. It is created before or during the billing process.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time", - "description": "Creation date of the applied billing charge" - }, - "description": { - "type": "string", - "description": "Additional data to be displayed on the bill for this applied billing charge" - }, - "href": { - "type": "string", - "description": "Reference of the applied billing charge" - }, - "id": { - "type": "string", - "description": "Unique identifier of the applied billing charge" - }, - "name": { - "type": "string", - "description": "Name of the applied billing rate" - }, - "taxExcludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Tax excluded amount to be charged on the bill (expresses in the given currency) for this applied billing rate" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "All taxes included amount to be charged on the bill (expressed in the given currency) for this applied billing rate" - }, - "rateType": { - "type": "string", - "description": "Type of the applied billing rate : appliedBillingCharge (any kind of charge except taxation charges : recurringCharge, oneTimeCharge, usageCharge), appliedBillingCredit (any kind of credit : rebate or productAlteration) or appliedPenaltyCharge (penalty charges such as late fees, payment rejection fees,...)" - }, - "appliedTax": { - "type": "array", - "items": { - "$ref": "AppliedBillingTaxRate.schema.json#AppliedBillingTaxRate" - } - }, - "bill": { - "$ref": "BillRef.schema.json#BillRef" - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "AppliedBillingRateCharacteristic.schema.json#AppliedBillingRateCharacteristic" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppliedCustomerBillingRate.schema.json", + "title": "AppliedCustomerBillingRate", + "definitions": { + "AppliedCustomerBillingRate": { + "$id": "#AppliedCustomerBillingRate", + "description": "An applied billing rate presented on a customer bill. It is created before or during the billing process.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "Creation date of the applied billing charge" + }, + "description": { + "type": "string", + "description": "Additional data to be displayed on the bill for this applied billing charge" + }, + "href": { + "type": "string", + "description": "Reference of the applied billing charge" + }, + "id": { + "type": "string", + "description": "Unique identifier of the applied billing charge" + }, + "name": { + "type": "string", + "description": "Name of the applied billing rate" + }, + "taxExcludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Tax excluded amount to be charged on the bill (expresses in the given currency) for this applied billing rate" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "All taxes included amount to be charged on the bill (expressed in the given currency) for this applied billing rate" + }, + "rateType": { + "type": "string", + "description": "Type of the applied billing rate : appliedBillingCharge (any kind of charge except taxation charges : recurringCharge, oneTimeCharge, usageCharge), appliedBillingCredit (any kind of credit : rebate or productAlteration) or appliedPenaltyCharge (penalty charges such as late fees, payment rejection fees,...)" + }, + "appliedTax": { + "type": "array", + "items": { + "$ref": "../Customer/AppliedBillingTaxRate.schema.json#AppliedBillingTaxRate" + } + }, + "bill": { + "$ref": "../Customer/BillRef.schema.json#BillRef" + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "../Customer/AppliedBillingRateCharacteristic.schema.json#AppliedBillingRateCharacteristic" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/AppliedPartyBillingRate.schema.json b/Customer/AppliedPartyBillingRate.schema.json index 063aac46..86dab9e7 100644 --- a/Customer/AppliedPartyBillingRate.schema.json +++ b/Customer/AppliedPartyBillingRate.schema.json @@ -1,67 +1,67 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppliedPartyBillingRate.schema.json", - "title": "AppliedPartyBillingRate", - "definitions": { - "AppliedPartyBillingRate": { - "$id": "#AppliedPartyBillingRate", - "description": "An applied billing rate presented on a party bill. It is created before or during the billing process.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time", - "description": "Creation date of the applied billing charge" - }, - "description": { - "type": "string", - "description": "Additional data to be displayed on the bill for this applied billing charge" - }, - "href": { - "type": "string", - "description": "Reference of the applied billing charge" - }, - "id": { - "type": "string", - "description": "Unique identifier of the applied billing charge" - }, - "name": { - "type": "string", - "description": "Name of the applied billing rate" - }, - "taxExcludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Tax excluded amount to be charged on the bill (expresses in the given currency) for this applied billing rate" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "All taxes included amount to be charged on the bill (expressed in the given currency) for this applied billing rate" - }, - "rateType": { - "type": "string", - "description": "Type of the applied billing rate : appliedBillingCharge (any kind of charge except taxation charges : recurringCharge, oneTimeCharge, usageCharge), appliedBillingCredit (any kind of credit : rebate or productAlteration) or appliedPenaltyCharge (penalty charges such as late fees, payment rejection fees,...)" - }, - "appliedTax": { - "type": "array", - "items": { - "$ref": "AppliedBillingTaxRate.schema.json#AppliedBillingTaxRate" - } - }, - "bill": { - "$ref": "BillRef.schema.json#BillRef" - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "AppliedBillingRateCharacteristic.schema.json#AppliedBillingRateCharacteristic" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppliedPartyBillingRate.schema.json", + "title": "AppliedPartyBillingRate", + "definitions": { + "AppliedPartyBillingRate": { + "$id": "#AppliedPartyBillingRate", + "description": "An applied billing rate presented on a party bill. It is created before or during the billing process.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "Creation date of the applied billing charge" + }, + "description": { + "type": "string", + "description": "Additional data to be displayed on the bill for this applied billing charge" + }, + "href": { + "type": "string", + "description": "Reference of the applied billing charge" + }, + "id": { + "type": "string", + "description": "Unique identifier of the applied billing charge" + }, + "name": { + "type": "string", + "description": "Name of the applied billing rate" + }, + "taxExcludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Tax excluded amount to be charged on the bill (expresses in the given currency) for this applied billing rate" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "All taxes included amount to be charged on the bill (expressed in the given currency) for this applied billing rate" + }, + "rateType": { + "type": "string", + "description": "Type of the applied billing rate : appliedBillingCharge (any kind of charge except taxation charges : recurringCharge, oneTimeCharge, usageCharge), appliedBillingCredit (any kind of credit : rebate or productAlteration) or appliedPenaltyCharge (penalty charges such as late fees, payment rejection fees,...)" + }, + "appliedTax": { + "type": "array", + "items": { + "$ref": "../Customer/AppliedBillingTaxRate.schema.json#AppliedBillingTaxRate" + } + }, + "bill": { + "$ref": "../Customer/BillRef.schema.json#BillRef" + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "../Customer/AppliedBillingRateCharacteristic.schema.json#AppliedBillingRateCharacteristic" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/Appointment.schema.json b/Customer/Appointment.schema.json index e200a81e..1a730e66 100644 --- a/Customer/Appointment.schema.json +++ b/Customer/Appointment.schema.json @@ -1,96 +1,96 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Appointment.schema.json", - "title": "Appointment", - "definitions": { - "Appointment": { - "$id": "#Appointment", - "type": "object", - "description": "An Appointment is an arrangement to do something or meet someone at a particular time, at a place (for face to face appointment) or in a contact medium (for phone appointment).", - "properties": { - "attachment": { - "type": "array", - "items": { - "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" - } - }, - "calendarEvent": { - "$ref": "../Common/CalendarEventRef.schema.json#CalendarEventRef", - "description": "A calendar event reference (CalendarEventRef). The appointment is associated with a calendar event (an happening at a point of time) associated to a calendar entry." - }, - "category": { - "type": "string", - "description": "Business category : intervention for example or to be more precise after SalesIntervention, orderDeliveryIntervention,..." - }, - "contactMedium": { - "type": "array", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "Appointment creation date" - }, - "description": { - "type": "string", - "description": "Short free text describing the appointment" - }, - "externalId": { - "type": "string", - "description": "External reference known by the customer" - }, - "href": { - "type": "string", - "description": "Unique URI used to access to the appointment resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of the appointment" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date of last appointment update" - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "relatedPlace": { - "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue", - "description": "Related place defines (by reference or value) the place where the appointment will take place." - }, - "relatedEntity": { - "type": "array", - "items": { - "$ref": "../Common/RelatedEntity.schema.json#RelatedEntity" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "status": { - "$ref": "AppointmentStateType.schema.json#AppointmentStateType" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ], - "required": [ - "validFor" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Appointment.schema.json", + "title": "Appointment", + "definitions": { + "Appointment": { + "$id": "#Appointment", + "type": "object", + "description": "An Appointment is an arrangement to do something or meet someone at a particular time, at a place (for face to face appointment) or in a contact medium (for phone appointment).", + "properties": { + "attachment": { + "type": "array", + "items": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + } + }, + "calendarEvent": { + "$ref": "../Common/CalendarEventRef.schema.json#CalendarEventRef", + "description": "A calendar event reference (CalendarEventRef). The appointment is associated with a calendar event (an happening at a point of time) associated to a calendar entry." + }, + "category": { + "type": "string", + "description": "Business category : intervention for example or to be more precise after SalesIntervention, orderDeliveryIntervention,..." + }, + "contactMedium": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "Appointment creation date" + }, + "description": { + "type": "string", + "description": "Short free text describing the appointment" + }, + "externalId": { + "type": "string", + "description": "External reference known by the customer" + }, + "href": { + "type": "string", + "description": "Unique URI used to access to the appointment resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of the appointment" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date of last appointment update" + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "relatedPlace": { + "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue", + "description": "Related place defines (by reference or value) the place where the appointment will take place." + }, + "relatedEntity": { + "type": "array", + "items": { + "$ref": "../Common/RelatedEntity.schema.json#RelatedEntity" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "status": { + "$ref": "../Customer/AppointmentStateType.schema.json#AppointmentStateType" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ], + "required": [ + "validFor" + ] } -} \ No newline at end of file + } +} diff --git a/Customer/AppointmentRef.schema.json b/Customer/AppointmentRef.schema.json index aeb0465b..f3cbb033 100644 --- a/Customer/AppointmentRef.schema.json +++ b/Customer/AppointmentRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppointmentRef.schema.json", - "title": "AppointmentRef", - "definitions": { - "AppointmentRef": { - "$id": "#AppointmentRef", - "description": "Refers an appointment, such as a Customer presentation or internal meeting or site visit", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "An explanatory text regarding the appointment made with a party" - }, - "href": { - "type": "string", - "description": "The reference of the appointment" - }, - "id": { - "type": "string", - "description": "The identifier of the referred appointment" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppointmentRef.schema.json", + "title": "AppointmentRef", + "definitions": { + "AppointmentRef": { + "$id": "#AppointmentRef", + "description": "Refers an appointment, such as a Customer presentation or internal meeting or site visit", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "An explanatory text regarding the appointment made with a party" + }, + "href": { + "type": "string", + "description": "The reference of the appointment" + }, + "id": { + "type": "string", + "description": "The identifier of the referred appointment" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/AppointmentStateType.schema.json b/Customer/AppointmentStateType.schema.json index 68ad3075..a495822f 100644 --- a/Customer/AppointmentStateType.schema.json +++ b/Customer/AppointmentStateType.schema.json @@ -1,19 +1,19 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppointmentStateType.schema.json", - "title": "AppointmentStateType", - "definitions": { - "AppointmentStateType": { - "$id": "#AppointmentStateType", - "type": "string", - "description": "Valid values for the lifecycle state of the appointment", - "enum": [ - "initialized", - "confirmed", - "cancelled", - "completed", - "failed" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppointmentStateType.schema.json", + "title": "AppointmentStateType", + "definitions": { + "AppointmentStateType": { + "$id": "#AppointmentStateType", + "type": "string", + "description": "Valid values for the lifecycle state of the appointment", + "enum": [ + "initialized", + "confirmed", + "cancelled", + "completed", + "failed" + ] } -} \ No newline at end of file + } +} diff --git a/Customer/AppointmentStateValues.schema.json b/Customer/AppointmentStateValues.schema.json index 2bffbd92..ce362482 100644 --- a/Customer/AppointmentStateValues.schema.json +++ b/Customer/AppointmentStateValues.schema.json @@ -1,19 +1,19 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppointmentStateValues.schema.json", - "title": "AppointmentStateValues", - "definitions": { - "AppointmentStateValues": { - "$id": "#AppointmentStateValues", - "type": "string", - "description": "", - "enum": [ - "initialized", - "confirmed", - "cancelled", - "completed", - "failed" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppointmentStateValues.schema.json", + "title": "AppointmentStateValues", + "definitions": { + "AppointmentStateValues": { + "$id": "#AppointmentStateValues", + "type": "string", + "description": "", + "enum": [ + "initialized", + "confirmed", + "cancelled", + "completed", + "failed" + ] } -} \ No newline at end of file + } +} diff --git a/Customer/Authorization.schema.json b/Customer/Authorization.schema.json index 0ab5e8e4..da2cdaf6 100644 --- a/Customer/Authorization.schema.json +++ b/Customer/Authorization.schema.json @@ -1,47 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Authorization.schema.json", - "title": "Authorization", - "definitions": { - "Authorization": { - "$id": "#Authorization", - "description": "If special discount or special product offering price or specific condition need an approval for ISP sale representative it is described here.", - "type": "object", - "properties": { - "givenDate": { - "type": "string", - "format": "date-time", - "description": "Date when the authorization (approved or declined) was done" - }, - "name": { - "type": "string", - "description": "Name of the required authorization" - }, - "requestedDate": { - "type": "string", - "format": "date-time", - "description": "Date when the authorization is requested for" - }, - "signatureRepresentation": { - "type": "string", - "description": "To describe a digital or manual signature" - }, - "state": { - "type": "string", - "description": "State of the authorization, such as: approved or declined" - }, - "approver": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Authorization.schema.json", + "title": "Authorization", + "definitions": { + "Authorization": { + "$id": "#Authorization", + "description": "If special discount or special product offering price or specific condition need an approval for ISP sale representative it is described here.", + "type": "object", + "properties": { + "givenDate": { + "type": "string", + "format": "date-time", + "description": "Date when the authorization (approved or declined) was done" + }, + "name": { + "type": "string", + "description": "Name of the required authorization" + }, + "requestedDate": { + "type": "string", + "format": "date-time", + "description": "Date when the authorization is requested for" + }, + "signatureRepresentation": { + "type": "string", + "description": "To describe a digital or manual signature" + }, + "state": { + "type": "string", + "description": "State of the authorization, such as: approved or declined" + }, + "approver": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BalanceActionRequestRef.schema.json b/Customer/BalanceActionRequestRef.schema.json index e393aa95..26b42671 100644 --- a/Customer/BalanceActionRequestRef.schema.json +++ b/Customer/BalanceActionRequestRef.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceActionRequestRef.schema.json", - "title": "BalanceActionRequestRef", - "definitions": { - "BalanceActionRequestRef": { - "$id": "#BalanceActionRequestRef", - "description": "link to the resource that holds balance-related request information", - "properties": { - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the request information for the balance-related action" - }, - "id": { - "type": "string", - "description": "Unique identifier for the balance related action request" - } - }, - "required": [ - "id", - "href" - ], - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceActionRequestRef.schema.json", + "title": "BalanceActionRequestRef", + "definitions": { + "BalanceActionRequestRef": { + "$id": "#BalanceActionRequestRef", + "description": "link to the resource that holds balance-related request information", + "properties": { + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the request information for the balance-related action" + }, + "id": { + "type": "string", + "description": "Unique identifier for the balance related action request" } + }, + "required": [ + "id", + "href" + ], + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Customer/BalanceActivity.schema.json b/Customer/BalanceActivity.schema.json index 9a7cba2c..231b5da7 100644 --- a/Customer/BalanceActivity.schema.json +++ b/Customer/BalanceActivity.schema.json @@ -1,65 +1,65 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceActivity.schema.json", - "title": "BalanceActivity", - "definitions": { - "BalanceActivity": { - "$id": "#BalanceActivity", - "description": "The BalanceActivity resource is a detailed description of a specific balance-related action that has happened over a given bucket balance. Typically a recharge/transfer/adjustment request creates one activity, but a request for an auto-topup operation actually triggers multiple periodic balance-related activities.", - "properties": { - "action": { - "description": "A reference to the balance-related operation that triggered the action", - "$ref": "BalanceActionRequestRef.schema.json#BalanceActionRequestRef" - }, - "amount": { - "description": "Amount (can be monetary or non-monetary) that was involved in the balance operation", - "$ref": "../Common/QuantityType.schema.json#QuantityType" - }, - "amountAfter": { - "description": "Remained amount in the bucket involved in the operation after it took place", - "$ref": "../Common/QuantityType.schema.json#QuantityType" - }, - "amountBefore": { - "description": "Remained amount in the bucket involved in the operation before it took place", - "$ref": "../Common/QuantityType.schema.json#QuantityType" - }, - "bucketBalance": { - "description": "A reference to the bucket involved in the balance-related operation", - "$ref": "BucketBalanceRef.schema.json#BucketBalanceRef" - }, - "date": { - "type": "string", - "description": "Date when the balance related operation took place" - }, - "partyAccount": { - "description": "A reference to the account that owns the bucket impacted by the balance activity", - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - }, - "product": { - "description": "A reference to the product related to the bucket that is impacted by the balance activity", - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - }, - "description": "Used to provide information about any other entity with relation to the balance activity" - }, - "type": { - "type": "string", - "description": "A preconfigured value that describes a type of balance-related performed (topup, transfer, adjustment)" - } - }, - "required": [ - "type", - "date", - "action", - "amount", - "bucketBalance", - "product" - ], - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceActivity.schema.json", + "title": "BalanceActivity", + "definitions": { + "BalanceActivity": { + "$id": "#BalanceActivity", + "description": "The BalanceActivity resource is a detailed description of a specific balance-related action that has happened over a given bucket balance. Typically a recharge/transfer/adjustment request creates one activity, but a request for an auto-topup operation actually triggers multiple periodic balance-related activities.", + "properties": { + "action": { + "description": "A reference to the balance-related operation that triggered the action", + "$ref": "../Customer/BalanceActionRequestRef.schema.json#BalanceActionRequestRef" + }, + "amount": { + "description": "Amount (can be monetary or non-monetary) that was involved in the balance operation", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "amountAfter": { + "description": "Remained amount in the bucket involved in the operation after it took place", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "amountBefore": { + "description": "Remained amount in the bucket involved in the operation before it took place", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "bucketBalance": { + "description": "A reference to the bucket involved in the balance-related operation", + "$ref": "../Customer/BucketBalanceRef.schema.json#BucketBalanceRef" + }, + "date": { + "type": "string", + "description": "Date when the balance related operation took place" + }, + "partyAccount": { + "description": "A reference to the account that owns the bucket impacted by the balance activity", + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "product": { + "description": "A reference to the product related to the bucket that is impacted by the balance activity", + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "description": "Used to provide information about any other entity with relation to the balance activity" + }, + "type": { + "type": "string", + "description": "A preconfigured value that describes a type of balance-related performed (topup, transfer, adjustment)" } + }, + "required": [ + "type", + "date", + "action", + "amount", + "bucketBalance", + "product" + ], + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Customer/BalanceAdjustment.schema.json b/Customer/BalanceAdjustment.schema.json index 2f29e208..ee3bf06b 100644 --- a/Customer/BalanceAdjustment.schema.json +++ b/Customer/BalanceAdjustment.schema.json @@ -1,12 +1,12 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceAdjustment.schema.json", - "title": "BalanceAdjustment", - "definitions": { - "BalanceAdjustment": { - "$id": "#BalanceAdjustment", - "description": "#TODO", - "type": "object" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceAdjustment.schema.json", + "title": "BalanceAdjustment", + "definitions": { + "BalanceAdjustment": { + "$id": "#BalanceAdjustment", + "description": "#TODO", + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Customer/BalanceAdjustmentBody.schema.json b/Customer/BalanceAdjustmentBody.schema.json index f03bd09f..b302e432 100644 --- a/Customer/BalanceAdjustmentBody.schema.json +++ b/Customer/BalanceAdjustmentBody.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceAdjustmentBody.schema.json", - "title": "BalanceAdjustmentBody", - "definitions": { - "BalanceAdjustmentBody": { - "$id": "#BalanceAdjustmentBody", - "properties": { - "amount": { - "description": "Amount (can be monetary or non-monetary) to be recharged in the bucket. It could refer to positive (increment) or negative (decrement) values", - "$ref": "../Common/QuantityType.schema.json#QuantityType" - }, - "product": { - "description": "A reference to the product related to the bucket that is impacted by the balance related operation", - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "reason": { - "type": "string", - "description": "Text describing the reason for the adjustment" - }, - "type": { - "type": "string", - "description": "A preconfigured value that describes a TopUp type which determines the prepay balance bucket in which the top-up is done (national-voice, roaming-voice, promotional-voice, data, ....)" - } - }, - "required": [ - "type", - "reason", - "amount" - ], - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceAdjustmentBody.schema.json", + "title": "BalanceAdjustmentBody", + "definitions": { + "BalanceAdjustmentBody": { + "$id": "#BalanceAdjustmentBody", + "properties": { + "amount": { + "description": "Amount (can be monetary or non-monetary) to be recharged in the bucket. It could refer to positive (increment) or negative (decrement) values", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "product": { + "description": "A reference to the product related to the bucket that is impacted by the balance related operation", + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "reason": { + "type": "string", + "description": "Text describing the reason for the adjustment" + }, + "type": { + "type": "string", + "description": "A preconfigured value that describes a TopUp type which determines the prepay balance bucket in which the top-up is done (national-voice, roaming-voice, promotional-voice, data, ....)" } + }, + "required": [ + "type", + "reason", + "amount" + ], + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Customer/BalanceAdjustmentRequest.schema.json b/Customer/BalanceAdjustmentRequest.schema.json index cadb3614..567aa923 100644 --- a/Customer/BalanceAdjustmentRequest.schema.json +++ b/Customer/BalanceAdjustmentRequest.schema.json @@ -1,64 +1,64 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceAdjustmentRequest.schema.json", - "title": "BalanceAdjustmentRequest", - "definitions": { - "BalanceAdjustmentRequest": { - "$id": "#BalanceAdjustmentRequest", - "description": "the BalanceAdjustment resource is a detailed description of credit adjustment operation erformed on a given bucket (defined by a specific product or reference to a product (i.e.: a commercial id such as an msisidn) and a service type)", - "properties": { - "bucket": { - "description": "A reference to the bucket impacted by the request. This is used in scenarios where the requestor knows beforehand the bucket that is going to be impacted instead of just referring to the commercial identifier of the impacted product and the type of bucket created under that product", - "$ref": "BucketBalanceRef.schema.json#BucketBalanceRef" - }, - "description": { - "type": "string", - "description": "Description of the recharge operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information. This is typically the resource url to retrieve individual top-up operation details" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the balance adjustment operation request" - }, - "partyAccount": { - "description": "A reference to the account that owns the bucket impacted by the balance related operation", - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - }, - "description": "Used to provide information about any other entity with relation to the operation" - }, - "requestedDate": { - "type": "string", - "description": "Date when the top-up request was received in the server" - }, - "requestor": { - "description": "Identifier for the user/customer/entity that performs the top-up action. This can be used to indicate the identifier of an agent that performs the operation on behalf of a user via a customer service channel. Structure including at least attributes �role� and �name�.", - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - }, - "validFor": { - "description": "The period defined for the adjusted amount to be part of the prepay balance. This could be used to define expiration times to remove balance not consumed.", - "$ref": "../Common/TimePeriodType.schema.json#TimePeriodType" - } - }, - "allOf": [ - { - "$ref": "BalanceAdjustmentBody.schema.json#BalanceAdjustmentBody" - } - ], - "required": [ - "id", - "href", - "requestedDate", - "product" - ], - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceAdjustmentRequest.schema.json", + "title": "BalanceAdjustmentRequest", + "definitions": { + "BalanceAdjustmentRequest": { + "$id": "#BalanceAdjustmentRequest", + "description": "the BalanceAdjustment resource is a detailed description of credit adjustment operation erformed on a given bucket (defined by a specific product or reference to a product (i.e.: a commercial id such as an msisidn) and a service type)", + "properties": { + "bucket": { + "description": "A reference to the bucket impacted by the request. This is used in scenarios where the requestor knows beforehand the bucket that is going to be impacted instead of just referring to the commercial identifier of the impacted product and the type of bucket created under that product", + "$ref": "../Customer/BucketBalanceRef.schema.json#BucketBalanceRef" + }, + "description": { + "type": "string", + "description": "Description of the recharge operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information. This is typically the resource url to retrieve individual top-up operation details" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the balance adjustment operation request" + }, + "partyAccount": { + "description": "A reference to the account that owns the bucket impacted by the balance related operation", + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "description": "Used to provide information about any other entity with relation to the operation" + }, + "requestedDate": { + "type": "string", + "description": "Date when the top-up request was received in the server" + }, + "requestor": { + "description": "Identifier for the user/customer/entity that performs the top-up action. This can be used to indicate the identifier of an agent that performs the operation on behalf of a user via a customer service channel. Structure including at least attributes �role� and �name�.", + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "validFor": { + "description": "The period defined for the adjusted amount to be part of the prepay balance. This could be used to define expiration times to remove balance not consumed.", + "$ref": "../Common/TimePeriodType.schema.json#TimePeriodType" } + }, + "allOf": [ + { + "$ref": "../Customer/BalanceAdjustmentBody.schema.json#BalanceAdjustmentBody" + } + ], + "required": [ + "id", + "href", + "requestedDate", + "product" + ], + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Customer/BalanceDeduct.schema.json b/Customer/BalanceDeduct.schema.json index ee2cabb9..53ec6c6d 100644 --- a/Customer/BalanceDeduct.schema.json +++ b/Customer/BalanceDeduct.schema.json @@ -1,64 +1,64 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceDeduct.schema.json", - "title": "BalanceDeduct", - "definitions": { - "BalanceDeduct": { - "$id": "#BalanceDeduct", - "description": "The Balance Deduct task resource is a detailed description of deduction operation. If balanceReserve Resource ID is contained in the deduct request message, the reserved balance will be performed deduct operation (if part of the reserved balance is deducted, the remain amount will be released); if balanceReserve Resource ID is not contained in the deduct request message, the balance will be deducted directly.", - "type": "object", - "properties": { - "confirmationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the deduction was confirmed in the server" - }, - "description": { - "type": "string", - "description": "Description of the deduct operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a deduction" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the deduction operation request" - }, - "requestedDate": { - "type": "string", - "format": "date-time", - "description": "Date when the deduction request was received in the server" - }, - "status": { - "type": "string", - "description": "Status of the deduction operation" - }, - "deductType": { - "type": "string", - "description": "A preconfigured value that describes a deduct type which determines the prepay balance bucket in which the deduct is done" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "product": { - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "balanceReserve": { - "$ref": "BalanceReserveRef.schema.json#BalanceReserveRef" - }, - "requestor": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "partyAccount": { - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceDeduct.schema.json", + "title": "BalanceDeduct", + "definitions": { + "BalanceDeduct": { + "$id": "#BalanceDeduct", + "description": "The Balance Deduct task resource is a detailed description of deduction operation. If balanceReserve Resource ID is contained in the deduct request message, the reserved balance will be performed deduct operation (if part of the reserved balance is deducted, the remain amount will be released); if balanceReserve Resource ID is not contained in the deduct request message, the balance will be deducted directly.", + "type": "object", + "properties": { + "confirmationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the deduction was confirmed in the server" + }, + "description": { + "type": "string", + "description": "Description of the deduct operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a deduction" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the deduction operation request" + }, + "requestedDate": { + "type": "string", + "format": "date-time", + "description": "Date when the deduction request was received in the server" + }, + "status": { + "type": "string", + "description": "Status of the deduction operation" + }, + "deductType": { + "type": "string", + "description": "A preconfigured value that describes a deduct type which determines the prepay balance bucket in which the deduct is done" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "product": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "balanceReserve": { + "$ref": "../Customer/BalanceReserveRef.schema.json#BalanceReserveRef" + }, + "requestor": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "partyAccount": { + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BalanceDeductRef.schema.json b/Customer/BalanceDeductRef.schema.json index 5050f4f2..15cfd412 100644 --- a/Customer/BalanceDeductRef.schema.json +++ b/Customer/BalanceDeductRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceDeductRef.schema.json", - "title": "BalanceDeductRef", - "definitions": { - "BalanceDeductRef": { - "$id": "#BalanceDeductRef", - "description": "the resource that deduct balance information", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the balance information for a subscription" - }, - "id": { - "type": "string", - "description": "Unique identifier for the balancededuct entity" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceDeductRef.schema.json", + "title": "BalanceDeductRef", + "definitions": { + "BalanceDeductRef": { + "$id": "#BalanceDeductRef", + "description": "the resource that deduct balance information", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the balance information for a subscription" + }, + "id": { + "type": "string", + "description": "Unique identifier for the balancededuct entity" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BalanceDeductRollback.schema.json b/Customer/BalanceDeductRollback.schema.json index 738fba98..755ec50f 100644 --- a/Customer/BalanceDeductRollback.schema.json +++ b/Customer/BalanceDeductRollback.schema.json @@ -1,55 +1,55 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceDeductRollback.schema.json", - "title": "BalanceDeductRollback", - "definitions": { - "BalanceDeductRollback": { - "$id": "#BalanceDeductRollback", - "description": "The Rollback Balance Deduct task resource is a detailed description of rollback deduction", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the rollback deduct operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a rollback deduction" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the rollback deduction operation request" - }, - "requestedDate": { - "type": "string", - "format": "date-time", - "description": "Date when the rollback deduction request was received in the server" - }, - "status": { - "type": "string", - "description": "Status of the rollback deduction operation" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "product": { - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "partyAccount": { - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - }, - "balanceDeduct": { - "$ref": "BalanceDeductRef.schema.json#BalanceDeductRef" - }, - "requestor": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceDeductRollback.schema.json", + "title": "BalanceDeductRollback", + "definitions": { + "BalanceDeductRollback": { + "$id": "#BalanceDeductRollback", + "description": "The Rollback Balance Deduct task resource is a detailed description of rollback deduction", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the rollback deduct operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a rollback deduction" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the rollback deduction operation request" + }, + "requestedDate": { + "type": "string", + "format": "date-time", + "description": "Date when the rollback deduction request was received in the server" + }, + "status": { + "type": "string", + "description": "Status of the rollback deduction operation" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "product": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "partyAccount": { + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "balanceDeduct": { + "$ref": "../Customer/BalanceDeductRef.schema.json#BalanceDeductRef" + }, + "requestor": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BalanceReserve.schema.json b/Customer/BalanceReserve.schema.json index 5024416f..e1f50460 100644 --- a/Customer/BalanceReserve.schema.json +++ b/Customer/BalanceReserve.schema.json @@ -1,79 +1,79 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceReserve.schema.json", - "title": "BalanceReserve", - "definitions": { - "BalanceReserve": { - "$id": "#BalanceReserve", - "description": "The Balance Reserve Operation resource is a detailed description of a balance reserve operation requested over a subscription", - "type": "object", - "properties": { - "confirmationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the reserve request was confirmed in the server" - }, - "description": { - "type": "string", - "description": "Description of the reserve operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a reserve" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the reserve operation request" - }, - "isAutoDeduct": { - "type": "boolean", - "description": "Indicates if the reserved balance is auto deducted after a time period" - }, - "remainedAmount": { - "type": "number", - "format": "float", - "description": "Amount (can be monetary or non-monetary) to be remained in the bucket" - }, - "requestedDate": { - "type": "string", - "format": "date-time", - "description": "Date when the reserve request was received in the server" - }, - "reservedAmount": { - "type": "number", - "format": "float", - "description": "Amount (can be monetary or non-monetary) to be reserved in the bucket" - }, - "status": { - "type": "string", - "description": "Status of the reserve operation" - }, - "reserveType": { - "type": "string", - "description": "A preconfigured value that describes a reserve type which determines the prepay balance bucket in which the reserve is done" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Indicates if the reserved balance is auto deducted after a time period" - }, - "requestor": { - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - }, - "product": { - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "partyAccount": { - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceReserve.schema.json", + "title": "BalanceReserve", + "definitions": { + "BalanceReserve": { + "$id": "#BalanceReserve", + "description": "The Balance Reserve Operation resource is a detailed description of a balance reserve operation requested over a subscription", + "type": "object", + "properties": { + "confirmationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the reserve request was confirmed in the server" + }, + "description": { + "type": "string", + "description": "Description of the reserve operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a reserve" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the reserve operation request" + }, + "isAutoDeduct": { + "type": "boolean", + "description": "Indicates if the reserved balance is auto deducted after a time period" + }, + "remainedAmount": { + "type": "number", + "format": "float", + "description": "Amount (can be monetary or non-monetary) to be remained in the bucket" + }, + "requestedDate": { + "type": "string", + "format": "date-time", + "description": "Date when the reserve request was received in the server" + }, + "reservedAmount": { + "type": "number", + "format": "float", + "description": "Amount (can be monetary or non-monetary) to be reserved in the bucket" + }, + "status": { + "type": "string", + "description": "Status of the reserve operation" + }, + "reserveType": { + "type": "string", + "description": "A preconfigured value that describes a reserve type which determines the prepay balance bucket in which the reserve is done" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Indicates if the reserved balance is auto deducted after a time period" + }, + "requestor": { + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "product": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "partyAccount": { + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BalanceReserveRef.schema.json b/Customer/BalanceReserveRef.schema.json index d82f6fd8..e602e23d 100644 --- a/Customer/BalanceReserveRef.schema.json +++ b/Customer/BalanceReserveRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceReserveRef.schema.json", - "title": "BalanceReserveRef", - "definitions": { - "BalanceReserveRef": { - "$id": "#BalanceReserveRef", - "description": "the resource that holds reserved balance information", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the balance information for a subscription" - }, - "id": { - "type": "string", - "description": "Unique identifier for the balancereserve entity" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceReserveRef.schema.json", + "title": "BalanceReserveRef", + "definitions": { + "BalanceReserveRef": { + "$id": "#BalanceReserveRef", + "description": "the resource that holds reserved balance information", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the balance information for a subscription" + }, + "id": { + "type": "string", + "description": "Unique identifier for the balancereserve entity" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BalanceTopup.schema.json b/Customer/BalanceTopup.schema.json index 45a2ef23..3befb34a 100644 --- a/Customer/BalanceTopup.schema.json +++ b/Customer/BalanceTopup.schema.json @@ -1,12 +1,12 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTopup.schema.json", - "title": "BalanceTopup", - "definitions": { - "BalanceTopup": { - "$id": "#BalanceTopup", - "description": "#TODO", - "type": "object" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTopup.schema.json", + "title": "BalanceTopup", + "definitions": { + "BalanceTopup": { + "$id": "#BalanceTopup", + "description": "#TODO", + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Customer/BalanceTopupBody.schema.json b/Customer/BalanceTopupBody.schema.json index 3dd3e384..7f08675c 100644 --- a/Customer/BalanceTopupBody.schema.json +++ b/Customer/BalanceTopupBody.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTopupBody.schema.json", - "title": "BalanceTopupBody", - "definitions": { - "BalanceTopupBody": { - "$id": "#BalanceTopupBody", - "properties": { - "amount": { - "description": "Amount (can be monetary or non-monetary) to be recharged in the bucket", - "$ref": "../Common/QuantityType.schema.json#QuantityType" - }, - "channel": { - "description": "Indicator for the channel used to request the top-up operation. Structure including at least attribute �name�", - "$ref": "../Common/ChannelRef.schema.json#ChannelRef" - }, - "product": { - "description": "A reference to the product related to the bucket that is impacted by the balance related operation", - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "type": { - "type": "string", - "description": "A preconfigured value that describes a TopUp type which determines the prepay balance bucket in which the top-up is done (national-voice, roaming-voice, promotional-voice, data, ....)" - } - }, - "required": [ - "type", - "channel", - "amount" - ], - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTopupBody.schema.json", + "title": "BalanceTopupBody", + "definitions": { + "BalanceTopupBody": { + "$id": "#BalanceTopupBody", + "properties": { + "amount": { + "description": "Amount (can be monetary or non-monetary) to be recharged in the bucket", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "channel": { + "description": "Indicator for the channel used to request the top-up operation. Structure including at least attribute �name�", + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "product": { + "description": "A reference to the product related to the bucket that is impacted by the balance related operation", + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "type": { + "type": "string", + "description": "A preconfigured value that describes a TopUp type which determines the prepay balance bucket in which the top-up is done (national-voice, roaming-voice, promotional-voice, data, ....)" } + }, + "required": [ + "type", + "channel", + "amount" + ], + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Customer/BalanceTopupRequest.schema.json b/Customer/BalanceTopupRequest.schema.json index 0a7c5ed8..4c1fbbd6 100644 --- a/Customer/BalanceTopupRequest.schema.json +++ b/Customer/BalanceTopupRequest.schema.json @@ -1,99 +1,99 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTopupRequest.schema.json", - "title": "BalanceTopupRequest", - "definitions": { - "BalanceTopupRequest": { - "$id": "#BalanceTopupRequest", - "description": "Represents a detailed description of a recharge operation requested over a bucket (defined by a specific product or reference to a product (i.e.: a commercial id such as an msisidn) and a service type)", - "properties": { - "bucket": { - "description": "A reference to the bucket impacted by the request. This is used in scenarios where the requestor knows beforehand the bucket that is going to be impacted instead of just referring to the commercial identifier of the impacted product and the type of bucket created under that product", - "$ref": "BucketBalanceRef.schema.json#BucketBalanceRef" - }, - "confirmationDate": { - "type": "string", - "description": "Date when the top-up was confirmed in the server" - }, - "description": { - "type": "string", - "description": "Description of the recharge operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information. This is typically the resource url to retrieve individual top-up operation details" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the recharge operation request" - }, - "isAutoTopup": { - "type": "boolean", - "description": "Indicates if the topup requested is an autotopup (to be processed periodically)" - }, - "nrOfPeriods": { - "type": "integer", - "description": "For autotopup indicates the number of occurrences of the period the recharge operation must be executed. If not included then no limit is set to stop the executionof the topup every period" - }, - "partyAccount": { - "description": "A reference to the account that owns the bucket impacted by the balance related operation", - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - }, - "paymentMethod": { - "description": "Payment method used for the recharge operation (e.g.: cash, credit card, �). Structure including at least attribute �name�. Notice that the use of a voucher can be managed as a specific methodtype, where he voucher code can be passed as value.", - "$ref": "PaymentMethodRefOrValue.schema.json#PaymentMethodRefOrValue" - }, - "recurringPeriod": { - "type": "string", - "description": "For autotopup indicates the periodicity for the recharge operation (monthly, weekly, )" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - }, - "description": "Used to provide information about any other entity with relation to the operation" - }, - "requestedDate": { - "type": "string", - "description": "Date when the top-up request was received in the server" - }, - "requestor": { - "description": "Identifier for the user/customer/entity that performs the top-up action. This can be used to indicate the identifier of an agent that performs the operation on behalf of a user via a customer service channel. Structure including at least attributes �role� and �name�.", - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - }, - "status": { - "type": "string", - "description": "Status of the top-up operation Supported values are: - confirmed - cancelled - in progress", - "enum": [ - "confirmed", - "cancelled", - "in progress" - ] - }, - "validFor": { - "description": "The period defined for the recharged amount to be part of the prepay balance. This could be used to define expiration times to remove balance not consumed.", - "$ref": "../Common/TimePeriodType.schema.json#TimePeriodType" - }, - "voucher": { - "type": "string", - "description": "Identifier for the voucher when the topup can be perfomed by this means (referenced by a voucher based payment mean). This attribute is left in this release to keep compatibility with previous version and for implementations that do not relay on paymentMethods. A voucher can be managed as a specific methodtype, where he voucher code can be passed as value." - } - }, - "allOf": [ - { - "$ref": "BalanceTopupBody.schema.json#BalanceTopupBody" - } - ], - "required": [ - "id", - "href", - "validFor", - "requestedDate", - "confirmationDate", - "status" - ], - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTopupRequest.schema.json", + "title": "BalanceTopupRequest", + "definitions": { + "BalanceTopupRequest": { + "$id": "#BalanceTopupRequest", + "description": "Represents a detailed description of a recharge operation requested over a bucket (defined by a specific product or reference to a product (i.e.: a commercial id such as an msisidn) and a service type)", + "properties": { + "bucket": { + "description": "A reference to the bucket impacted by the request. This is used in scenarios where the requestor knows beforehand the bucket that is going to be impacted instead of just referring to the commercial identifier of the impacted product and the type of bucket created under that product", + "$ref": "../Customer/BucketBalanceRef.schema.json#BucketBalanceRef" + }, + "confirmationDate": { + "type": "string", + "description": "Date when the top-up was confirmed in the server" + }, + "description": { + "type": "string", + "description": "Description of the recharge operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information. This is typically the resource url to retrieve individual top-up operation details" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the recharge operation request" + }, + "isAutoTopup": { + "type": "boolean", + "description": "Indicates if the topup requested is an autotopup (to be processed periodically)" + }, + "nrOfPeriods": { + "type": "integer", + "description": "For autotopup indicates the number of occurrences of the period the recharge operation must be executed. If not included then no limit is set to stop the executionof the topup every period" + }, + "partyAccount": { + "description": "A reference to the account that owns the bucket impacted by the balance related operation", + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "paymentMethod": { + "description": "Payment method used for the recharge operation (e.g.: cash, credit card, �). Structure including at least attribute �name�. Notice that the use of a voucher can be managed as a specific methodtype, where he voucher code can be passed as value.", + "$ref": "../Customer/PaymentMethodRefOrValue.schema.json#PaymentMethodRefOrValue" + }, + "recurringPeriod": { + "type": "string", + "description": "For autotopup indicates the periodicity for the recharge operation (monthly, weekly, )" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "description": "Used to provide information about any other entity with relation to the operation" + }, + "requestedDate": { + "type": "string", + "description": "Date when the top-up request was received in the server" + }, + "requestor": { + "description": "Identifier for the user/customer/entity that performs the top-up action. This can be used to indicate the identifier of an agent that performs the operation on behalf of a user via a customer service channel. Structure including at least attributes �role� and �name�.", + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "status": { + "type": "string", + "description": "Status of the top-up operation Supported values are: - confirmed - cancelled - in progress", + "enum": [ + "confirmed", + "cancelled", + "in progress" + ] + }, + "validFor": { + "description": "The period defined for the recharged amount to be part of the prepay balance. This could be used to define expiration times to remove balance not consumed.", + "$ref": "../Common/TimePeriodType.schema.json#TimePeriodType" + }, + "voucher": { + "type": "string", + "description": "Identifier for the voucher when the topup can be perfomed by this means (referenced by a voucher based payment mean). This attribute is left in this release to keep compatibility with previous version and for implementations that do not relay on paymentMethods. A voucher can be managed as a specific methodtype, where he voucher code can be passed as value." } + }, + "allOf": [ + { + "$ref": "../Customer/BalanceTopupBody.schema.json#BalanceTopupBody" + } + ], + "required": [ + "id", + "href", + "validFor", + "requestedDate", + "confirmationDate", + "status" + ], + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Customer/BalanceTopupStatus.schema.json b/Customer/BalanceTopupStatus.schema.json index d3f34716..a3ba4985 100644 --- a/Customer/BalanceTopupStatus.schema.json +++ b/Customer/BalanceTopupStatus.schema.json @@ -1,24 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTopupStatus.schema.json", - "title": "BalanceTopupStatus", - "definitions": { - "BalanceTopupStatus": { - "description": "Structure including specific information about change of status for the topup operation", - "properties": { - "statusChangeDate": { - "type": "string", - "description": "Date in which the latest change of status was requested" - } - }, - "allOf": [ - { - "$ref": "BalanceTopupStatusTypeModify.schema.json#/definitions/BalanceTopupStatusTypeModify" - } - ], - "required": [ - "statusChangeDate" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTopupStatus.schema.json", + "title": "BalanceTopupStatus", + "definitions": { + "BalanceTopupStatusType": { + "$id": "#BalanceTopupStatusType", + "description": "Structure including specific information about change of status for the topup operation", + "properties": { + "statusChangeDate": { + "type": "string", + "description": "Date in which the latest change of status was requested" } + }, + "allOf": [ + { + "$ref": "../Customer/BalanceTopupStatusTypeModify.schema.json#BalanceTopupStatusTypeModify" + } + ], + "required": [ + "statusChangeDate" + ], + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Customer/BalanceTopupStatusTypeModify.schema.json b/Customer/BalanceTopupStatusTypeModify.schema.json index 4b3b36a2..43cafccb 100644 --- a/Customer/BalanceTopupStatusTypeModify.schema.json +++ b/Customer/BalanceTopupStatusTypeModify.schema.json @@ -1,20 +1,20 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTopupStatusTypeModify.schema.json", - "title": "BalanceTopupStatusTypeModify", - "definitions": { - "BalanceTopupStatusTypeModify": { - "$id": "#BalanceTopupStatusTypeModify", - "properties": { - "status": { - "type": "string", - "description": "Current status of the operation request" - } - }, - "required": [ - "status" - ], - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTopupStatusTypeModify.schema.json", + "title": "BalanceTopupStatusTypeModify", + "definitions": { + "BalanceTopupStatusTypeModify": { + "$id": "#BalanceTopupStatusTypeModify", + "properties": { + "status": { + "type": "string", + "description": "Current status of the operation request" } + }, + "required": [ + "status" + ], + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Customer/BalanceTransfer.schema.json b/Customer/BalanceTransfer.schema.json index b08ec8b7..d28843ce 100644 --- a/Customer/BalanceTransfer.schema.json +++ b/Customer/BalanceTransfer.schema.json @@ -1,12 +1,12 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTransfer.schema.json", - "title": "BalanceTransfer", - "definitions": { - "BalanceTransfer": { - "$id": "#BalanceTransfer", - "description": "#TODO", - "type": "object" - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTransfer.schema.json", + "title": "BalanceTransfer", + "definitions": { + "BalanceTransfer": { + "$id": "#BalanceTransfer", + "description": "#TODO", + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Customer/BalanceTransferBody.schema.json b/Customer/BalanceTransferBody.schema.json index c8d6d9ae..9e366614 100644 --- a/Customer/BalanceTransferBody.schema.json +++ b/Customer/BalanceTransferBody.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTransferBody.schema.json", - "title": "BalanceTransferBody", - "definitions": { - "BalanceTransferBody": { - "$id": "#BalanceTransferBody", - "properties": { - "amount": { - "description": "Amount (can be monetary or non-monetary) to be transferred", - "$ref": "../Common/QuantityType.schema.json#QuantityType" - }, - "channel": { - "description": "Indicator for the channel used to request the top-up operation. Structure including at least attribute �name�", - "$ref": "../Common/ChannelRef.schema.json#ChannelRef" - }, - "product": { - "description": "A reference to the product related to the bucket that is impacted by the balance related operation", - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "targetId": { - "type": "string", - "description": "Identifier for the entity that receives the transfer (reference to a product via a commercial identifier such as an msisidn that relates to an internal product id)" - }, - "type": { - "type": "string", - "description": "A preconfigured value that describes a TopUp type which determines the prepay balance bucket in which the top-up is done (national-voice, roaming-voice, promotional-voice, data, ....)" - } - }, - "required": [ - "type", - "channel", - "targetId", - "amount" - ], - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTransferBody.schema.json", + "title": "BalanceTransferBody", + "definitions": { + "BalanceTransferBody": { + "$id": "#BalanceTransferBody", + "properties": { + "amount": { + "description": "Amount (can be monetary or non-monetary) to be transferred", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "channel": { + "description": "Indicator for the channel used to request the top-up operation. Structure including at least attribute �name�", + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "product": { + "description": "A reference to the product related to the bucket that is impacted by the balance related operation", + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "targetId": { + "type": "string", + "description": "Identifier for the entity that receives the transfer (reference to a product via a commercial identifier such as an msisidn that relates to an internal product id)" + }, + "type": { + "type": "string", + "description": "A preconfigured value that describes a TopUp type which determines the prepay balance bucket in which the top-up is done (national-voice, roaming-voice, promotional-voice, data, ....)" } + }, + "required": [ + "type", + "channel", + "targetId", + "amount" + ], + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Customer/BalanceTransferRequest.schema.json b/Customer/BalanceTransferRequest.schema.json index badb405f..05823b01 100644 --- a/Customer/BalanceTransferRequest.schema.json +++ b/Customer/BalanceTransferRequest.schema.json @@ -1,100 +1,100 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTransferRequest.schema.json", - "title": "BalanceTransferRequest", - "definitions": { - "BalanceTransferRequest": { - "$id": "#BalanceTransferRequest", - "description": "The BalanceTransfer resource is a detailed description of credit transfer operation requested between two buckets (reference to products owned by customers and consuming credit when using a service).", - "properties": { - "bucket": { - "description": "A reference to the bucket impacted by the request. This is used in scenarios where the requestor knows beforehand the bucket that is going to be impacted instead of just referring to the commercial identifier of the impacted product and the type of bucket created under that product", - "$ref": "BucketBalanceRef.schema.json#BucketBalanceRef" - }, - "confirmationDate": { - "type": "string", - "description": "Date when the transfer was confirmed in the server" - }, - "costOwner": { - "type": "string", - "description": "Indicates the entity responsible to assume the cost of the transfer operation", - "enum": [ - "originator", - "receiver" - ] - }, - "description": { - "type": "string", - "description": "Description of the transfer operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information. This is typically the resource url to retrieve individual transfer operation details" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the balance transfer operation request." - }, - "partyAccount": { - "description": "A reference to the account that owns the bucket impacted by the balance related operation", - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - }, - "reason": { - "type": "string", - "description": "Text describing the reason for the adjustment" - }, - "receiver": { - "description": "Identifier for the user/customer/entity that receives the transfer action when it is required to indicate additional customer hierarchy information regarding the entity receiving the balance transfer", - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - }, - "description": "Used to provide information about any other entity with relation to the operation" - }, - "requestedDate": { - "type": "string", - "description": "Date when the transfer request was received in the server" - }, - "requestor": { - "description": "Identifier for the user/customer/entity that performs the top-up action. This can be used to indicate the identifier of an agent that performs the operation on behalf of a user via a customer service channel. Structure including at least attributes �role� and �name�.", - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - }, - "status": { - "type": "string", - "description": "Status of the top-up.", - "enum": [ - "confirmed", - "cancelled", - "in progress" - ] - }, - "targetType": { - "type": "string", - "description": "Intended for scenarios where the transfer is done from one bucket type to another (from voice to data). A preconfigured value that describes a Transfer type which determines the prepay balance bucket in which the transfer is done" - }, - "transferCost": { - "description": "Associated cost to be charged for the transfer operation (can be monetary or non-monetary)", - "$ref": "../Common/QuantityType.schema.json#QuantityType" - } - }, - "allOf": [ - { - "$ref": "BalanceTransferBody.schema.json#BalanceTransferBody" - } - ], - "required": [ - "id", - "href", - "reason", - "requestedDate", - "confirmationDate", - "status", - "product" - ], - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTransferRequest.schema.json", + "title": "BalanceTransferRequest", + "definitions": { + "BalanceTransferRequest": { + "$id": "#BalanceTransferRequest", + "description": "The BalanceTransfer resource is a detailed description of credit transfer operation requested between two buckets (reference to products owned by customers and consuming credit when using a service).", + "properties": { + "bucket": { + "description": "A reference to the bucket impacted by the request. This is used in scenarios where the requestor knows beforehand the bucket that is going to be impacted instead of just referring to the commercial identifier of the impacted product and the type of bucket created under that product", + "$ref": "../Customer/BucketBalanceRef.schema.json#BucketBalanceRef" + }, + "confirmationDate": { + "type": "string", + "description": "Date when the transfer was confirmed in the server" + }, + "costOwner": { + "type": "string", + "description": "Indicates the entity responsible to assume the cost of the transfer operation", + "enum": [ + "originator", + "receiver" + ] + }, + "description": { + "type": "string", + "description": "Description of the transfer operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information. This is typically the resource url to retrieve individual transfer operation details" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the balance transfer operation request." + }, + "partyAccount": { + "description": "A reference to the account that owns the bucket impacted by the balance related operation", + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "reason": { + "type": "string", + "description": "Text describing the reason for the adjustment" + }, + "receiver": { + "description": "Identifier for the user/customer/entity that receives the transfer action when it is required to indicate additional customer hierarchy information regarding the entity receiving the balance transfer", + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "description": "Used to provide information about any other entity with relation to the operation" + }, + "requestedDate": { + "type": "string", + "description": "Date when the transfer request was received in the server" + }, + "requestor": { + "description": "Identifier for the user/customer/entity that performs the top-up action. This can be used to indicate the identifier of an agent that performs the operation on behalf of a user via a customer service channel. Structure including at least attributes �role� and �name�.", + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "status": { + "type": "string", + "description": "Status of the top-up.", + "enum": [ + "confirmed", + "cancelled", + "in progress" + ] + }, + "targetType": { + "type": "string", + "description": "Intended for scenarios where the transfer is done from one bucket type to another (from voice to data). A preconfigured value that describes a Transfer type which determines the prepay balance bucket in which the transfer is done" + }, + "transferCost": { + "description": "Associated cost to be charged for the transfer operation (can be monetary or non-monetary)", + "$ref": "../Common/QuantityType.schema.json#QuantityType" } + }, + "allOf": [ + { + "$ref": "../Customer/BalanceTransferBody.schema.json#BalanceTransferBody" + } + ], + "required": [ + "id", + "href", + "reason", + "requestedDate", + "confirmationDate", + "status", + "product" + ], + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Customer/BalanceTransferStatusTypeModify.schema.json b/Customer/BalanceTransferStatusTypeModify.schema.json index 98c211ae..2fab0702 100644 --- a/Customer/BalanceTransferStatusTypeModify.schema.json +++ b/Customer/BalanceTransferStatusTypeModify.schema.json @@ -1,19 +1,19 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceTransferStatusTypeModify.schema.json", - "title": "BalanceTransferStatusTypeModify", - "definitions": { - "BalanceTransferStatusTypeModify": { - "$id": "#BalanceTransferStatusTypeModify", - "properties": { - "status": { - "type": "string" - } - }, - "required": [ - "status" - ], - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceTransferStatusTypeModify.schema.json", + "title": "BalanceTransferStatusTypeModify", + "definitions": { + "BalanceTransferStatusTypeModify": { + "$id": "#BalanceTransferStatusTypeModify", + "properties": { + "status": { + "type": "string" } + }, + "required": [ + "status" + ], + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Customer/BalanceUnreserve.schema.json b/Customer/BalanceUnreserve.schema.json index 249de9e5..396d07c9 100644 --- a/Customer/BalanceUnreserve.schema.json +++ b/Customer/BalanceUnreserve.schema.json @@ -1,52 +1,52 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BalanceUnreserve.schema.json", - "title": "BalanceUnreserve", - "definitions": { - "BalanceUnreserve": { - "$id": "#BalanceUnreserve", - "description": "The Balance Unreserve Operation resource is a detailed description of a balance unreserve operation requested over a subscription", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the unreserve operation" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a unreserve" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the unreserve operation request" - }, - "requestedDate": { - "type": "string", - "format": "date-time", - "description": "Date when the unreserve request was received in the server" - }, - "status": { - "type": "string", - "description": "Status of the unreserve operation" - }, - "balanceReserve": { - "$ref": "BalanceReserveRef.schema.json#BalanceReserveRef" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "requestor": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "product": { - "$ref": "../Product/ProductRef.schema.json#ProductRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BalanceUnreserve.schema.json", + "title": "BalanceUnreserve", + "definitions": { + "BalanceUnreserve": { + "$id": "#BalanceUnreserve", + "description": "The Balance Unreserve Operation resource is a detailed description of a balance unreserve operation requested over a subscription", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the unreserve operation" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information about a unreserve" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the unreserve operation request" + }, + "requestedDate": { + "type": "string", + "format": "date-time", + "description": "Date when the unreserve request was received in the server" + }, + "status": { + "type": "string", + "description": "Status of the unreserve operation" + }, + "balanceReserve": { + "$ref": "../Customer/BalanceReserveRef.schema.json#BalanceReserveRef" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "requestor": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "product": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BankCardDetails.schema.json b/Customer/BankCardDetails.schema.json index 6ea1f2a2..58d91eb0 100644 --- a/Customer/BankCardDetails.schema.json +++ b/Customer/BankCardDetails.schema.json @@ -1,52 +1,52 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankCardDetails.schema.json", - "title": "BankCardDetails", - "definitions": { - "BankCardDetails": { - "$id": "#BankCardDetails", - "description": "Detailed information for a bank card", - "type": "object", - "properties": { - "bank": { - "type": "string", - "description": "Bank that issued the card" - }, - "brand": { - "type": "string", - "description": "Card brand, such as Visa, MasterCard, AmericanExpress" - }, - "cardNumber": { - "type": "string", - "description": "Credit long card number" - }, - "cvv": { - "type": "string", - "description": "The security code (e.g.: CVV, CVV2) of the card" - }, - "expirationDate": { - "type": "string", - "format": "date-time", - "description": "Expiration date of the card" - }, - "lastFourDigits": { - "type": "string", - "description": "Last four digits of the credit card" - }, - "nameOnCard": { - "type": "string", - "description": "Name on the card" - }, - "cardType": { - "type": "string", - "description": "Type of the card, such as Credit, Debit" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankCardDetails.schema.json", + "title": "BankCardDetails", + "definitions": { + "BankCardDetails": { + "$id": "#BankCardDetails", + "description": "Detailed information for a bank card", + "type": "object", + "properties": { + "bank": { + "type": "string", + "description": "Bank that issued the card" + }, + "brand": { + "type": "string", + "description": "Card brand, such as Visa, MasterCard, AmericanExpress" + }, + "cardNumber": { + "type": "string", + "description": "Credit long card number" + }, + "cvv": { + "type": "string", + "description": "The security code (e.g.: CVV, CVV2) of the card" + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "Expiration date of the card" + }, + "lastFourDigits": { + "type": "string", + "description": "Last four digits of the credit card" + }, + "nameOnCard": { + "type": "string", + "description": "Name on the card" + }, + "cardType": { + "type": "string", + "description": "Type of the card, such as Credit, Debit" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BankCardMethod.schema.json b/Customer/BankCardMethod.schema.json index f8d15da2..efe67099 100644 --- a/Customer/BankCardMethod.schema.json +++ b/Customer/BankCardMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankCardMethod.schema.json", - "title": "BankCardMethod", - "definitions": { - "BankCardMethod": { - "$id": "#BankCardMethod", - "type": "object", - "properties": { - "details": { - "$ref": "BankCardDetails.schema.json#BankCardDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankCardMethod.schema.json", + "title": "BankCardMethod", + "definitions": { + "BankCardMethod": { + "$id": "#BankCardMethod", + "type": "object", + "properties": { + "details": { + "$ref": "../Customer/BankCardDetails.schema.json#BankCardDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/Bill.schema.json b/Customer/Bill.schema.json index c408be29..678a8238 100644 --- a/Customer/Bill.schema.json +++ b/Customer/Bill.schema.json @@ -1,118 +1,118 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Bill.schema.json", - "title": "Bill", - "definitions": { - "Bill": { - "$id": "#Bill", - "description": "The Bill entity is used to model a bill (aka an invoice). It represents a total amount due for all products during the billing period and all significant date.", - "type": "object", - "properties": { - "amountDue": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Amount due for this bill expressed in the given currency" - }, - "billDate": { - "type": "string", - "format": "date-time", - "description": "Bill date" - }, - "billingPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Billing period of the bill (used for onCycle bill only)" - }, - "billNo": { - "type": "string", - "description": "Bill reference known by the customer or the party and displayed on the bill. Could be different from the id." - }, - "category": { - "type": "string", - "description": "Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note" - }, - "href": { - "type": "string", - "description": "Bill unique reference" - }, - "id": { - "type": "string", - "description": "Bill unique identifier" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date of bill last update" - }, - "nextBillDate": { - "type": "string", - "format": "date-time", - "description": "Approximate date of the next bill production given for information (only used for onCycle bill)" - }, - "paymentDueDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the amount due should have been paid" - }, - "remainingAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Remaining amount to be paid for this bill expressed in the given currency" - }, - "runType": { - "type": "string", - "description": "onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close)" - }, - "state": { - "type": "string", - "description": "State that a bill could take during its lifecycle : New, Validated, On Hold, Sent, Partially paid or Settled" - }, - "taxExcludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Total tax excluded amount expressed in the given currency" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Total tax included amount expressed in the given" - }, - "billDocument": { - "type": "array", - "items": { - "$ref": "../Common/FileDocument.schema.json#FileDocument" - }, - "description": "Document(s) associated to the bill" - }, - "paymentItem": { - "type": "array", - "items": { - "$ref": "PaymentItem.schema.json#PaymentItem" - }, - "description": "Payment items already lettered on this bill." - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef" - }, - "taxItem": { - "type": "array", - "items": { - "$ref": "TaxItem.schema.json#TaxItem" - } - }, - "paymentMethod": { - "$ref": "PaymentMethodRef.schema.json#PaymentMethodRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "financialAccount": { - "$ref": "../EngagedParty/FinancialAccountRef.schema.json#FinancialAccountRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Bill.schema.json", + "title": "Bill", + "definitions": { + "Bill": { + "$id": "#Bill", + "description": "The Bill entity is used to model a bill (aka an invoice). It represents a total amount due for all products during the billing period and all significant date.", + "type": "object", + "properties": { + "amountDue": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Amount due for this bill expressed in the given currency" + }, + "billDate": { + "type": "string", + "format": "date-time", + "description": "Bill date" + }, + "billingPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Billing period of the bill (used for onCycle bill only)" + }, + "billNo": { + "type": "string", + "description": "Bill reference known by the customer or the party and displayed on the bill. Could be different from the id." + }, + "category": { + "type": "string", + "description": "Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note" + }, + "href": { + "type": "string", + "description": "Bill unique reference" + }, + "id": { + "type": "string", + "description": "Bill unique identifier" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date of bill last update" + }, + "nextBillDate": { + "type": "string", + "format": "date-time", + "description": "Approximate date of the next bill production given for information (only used for onCycle bill)" + }, + "paymentDueDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the amount due should have been paid" + }, + "remainingAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Remaining amount to be paid for this bill expressed in the given currency" + }, + "runType": { + "type": "string", + "description": "onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close)" + }, + "state": { + "type": "string", + "description": "State that a bill could take during its lifecycle : New, Validated, On Hold, Sent, Partially paid or Settled" + }, + "taxExcludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Total tax excluded amount expressed in the given currency" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Total tax included amount expressed in the given" + }, + "billDocument": { + "type": "array", + "items": { + "$ref": "../Common/FileDocument.schema.json#FileDocument" + }, + "description": "Document(s) associated to the bill" + }, + "paymentItem": { + "type": "array", + "items": { + "$ref": "../Customer/PaymentItem.schema.json#PaymentItem" + }, + "description": "Payment items already lettered on this bill." + }, + "billingAccount": { + "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" + }, + "taxItem": { + "type": "array", + "items": { + "$ref": "../Customer/TaxItem.schema.json#TaxItem" + } + }, + "paymentMethod": { + "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "financialAccount": { + "$ref": "../EngagedParty/FinancialAccountRef.schema.json#FinancialAccountRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BillFormat.schema.json b/Customer/BillFormat.schema.json index 604c782a..2ba9c8c0 100644 --- a/Customer/BillFormat.schema.json +++ b/Customer/BillFormat.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillFormat.schema.json", - "title": "BillFormat", - "definitions": { - "BillFormat": { - "$id": "#BillFormat", - "description": "A detailed description of the way in which a bill is presented.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "description": { - "type": "string", - "description": "An explanatory text for this bill format" - }, - "href": { - "type": "string", - "description": "Reference of the bill format" - }, - "id": { - "type": "string", - "description": "Unique identifier of the bill format" - }, - "name": { - "type": "string", - "description": "A short descriptive name" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillFormat.schema.json", + "title": "BillFormat", + "definitions": { + "BillFormat": { + "$id": "#BillFormat", + "description": "A detailed description of the way in which a bill is presented.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "description": { + "type": "string", + "description": "An explanatory text for this bill format" + }, + "href": { + "type": "string", + "description": "Reference of the bill format" + }, + "id": { + "type": "string", + "description": "Unique identifier of the bill format" + }, + "name": { + "type": "string", + "description": "A short descriptive name" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BillFormatRef.schema.json b/Customer/BillFormatRef.schema.json index 5b63a1c3..89e8535a 100644 --- a/Customer/BillFormatRef.schema.json +++ b/Customer/BillFormatRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillFormatRef.schema.json", - "title": "BillFormatRef", - "definitions": { - "BillFormatRef": { - "$id": "#BillFormatRef", - "description": "BillFormat reference. A bill format is a description of the way in which a bill is presented.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the bill format" - }, - "id": { - "type": "string", - "description": "Unique identifier of the bill format" - }, - "name": { - "type": "string", - "description": "A short descriptive name" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillFormatRef.schema.json", + "title": "BillFormatRef", + "definitions": { + "BillFormatRef": { + "$id": "#BillFormatRef", + "description": "BillFormat reference. A bill format is a description of the way in which a bill is presented.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the bill format" + }, + "id": { + "type": "string", + "description": "Unique identifier of the bill format" + }, + "name": { + "type": "string", + "description": "A short descriptive name" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BillFormatRefOrValue.schema.json b/Customer/BillFormatRefOrValue.schema.json index dfed3a83..845af13f 100644 --- a/Customer/BillFormatRefOrValue.schema.json +++ b/Customer/BillFormatRefOrValue.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillFormatRefOrValue.schema.json", - "title": "BillFormatRefOrValue", - "definitions": { - "BillFormatRefOrValue": { - "discriminator": "isRef", - "$id": "#BillFormatRefOrValue", - "description": "An attachment by value or by reference.", - "type": "object", - "properties": { - "isRef": { - "type": "boolean", - "default": true - } - }, - "required": [ - "isRef", - "role" - ], - "allOf": [ - { - "$ref": "BillFormatRef.schema.json#BillFormatRef" - }, - { - "$ref": "BillFormat.schema.json#BillFormat" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillFormatRefOrValue.schema.json", + "title": "BillFormatRefOrValue", + "definitions": { + "BillFormatRefOrValue": { + "discriminator": "isRef", + "$id": "#BillFormatRefOrValue", + "description": "An attachment by value or by reference.", + "type": "object", + "properties": { + "isRef": { + "type": "boolean", + "default": true } + }, + "required": [ + "isRef", + "role" + ], + "allOf": [ + { + "$ref": "../Customer/BillFormatRef.schema.json#BillFormatRef" + }, + { + "$ref": "../Customer/BillFormat.schema.json#BillFormat" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BillPresentationMedia.schema.json b/Customer/BillPresentationMedia.schema.json index b6caf7db..fc605dab 100644 --- a/Customer/BillPresentationMedia.schema.json +++ b/Customer/BillPresentationMedia.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillPresentationMedia.schema.json", - "title": "BillPresentationMedia", - "definitions": { - "BillPresentationMedia": { - "$id": "#BillPresentationMedia", - "description": "A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "description": { - "type": "string", - "description": "An explanatory text describing this bill presentation media" - }, - "href": { - "type": "string", - "description": "Reference of the bill presentation media" - }, - "id": { - "type": "string", - "description": "Unique identifier of the bill presentation media" - }, - "name": { - "type": "string", - "description": "A short descriptive name" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillPresentationMedia.schema.json", + "title": "BillPresentationMedia", + "definitions": { + "BillPresentationMedia": { + "$id": "#BillPresentationMedia", + "description": "A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "description": { + "type": "string", + "description": "An explanatory text describing this bill presentation media" + }, + "href": { + "type": "string", + "description": "Reference of the bill presentation media" + }, + "id": { + "type": "string", + "description": "Unique identifier of the bill presentation media" + }, + "name": { + "type": "string", + "description": "A short descriptive name" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BillPresentationMediaRef.schema.json b/Customer/BillPresentationMediaRef.schema.json index 8b4cc306..d8a23f87 100644 --- a/Customer/BillPresentationMediaRef.schema.json +++ b/Customer/BillPresentationMediaRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillPresentationMediaRef.schema.json", - "title": "BillPresentationMediaRef", - "definitions": { - "BillPresentationMediaRef": { - "$id": "#BillPresentationMediaRef", - "description": "PresentationMedia reference. A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the bill presentation media" - }, - "id": { - "type": "string", - "description": "Unique identifier of the bill presentation media" - }, - "name": { - "type": "string", - "description": "A short descriptive name" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillPresentationMediaRef.schema.json", + "title": "BillPresentationMediaRef", + "definitions": { + "BillPresentationMediaRef": { + "$id": "#BillPresentationMediaRef", + "description": "PresentationMedia reference. A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the bill presentation media" + }, + "id": { + "type": "string", + "description": "Unique identifier of the bill presentation media" + }, + "name": { + "type": "string", + "description": "A short descriptive name" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BillPresentationMediaRefOrValue.schema.json b/Customer/BillPresentationMediaRefOrValue.schema.json index 37f9ba21..3cf9f753 100644 --- a/Customer/BillPresentationMediaRefOrValue.schema.json +++ b/Customer/BillPresentationMediaRefOrValue.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillPresentationMediaRefOrValue.schema.json", - "title": "BillPresentationMediaRefOrValue", - "definitions": { - "BillPresentationMediaRefOrValue": { - "discriminator": "isRef", - "$id": "#BillPresentationMediaRefOrValue", - "description": "An attachment by value or by reference.", - "type": "object", - "properties": { - "isRef": { - "type": "boolean", - "default": true - } - }, - "required": [ - "isRef", - "role" - ], - "allOf": [ - { - "$ref": "BillPresentationMediaRef.schema.json#BillPresentationMediaRef" - }, - { - "$ref": "BillPresentationMedia.schema.json#BillPresentationMedia" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillPresentationMediaRefOrValue.schema.json", + "title": "BillPresentationMediaRefOrValue", + "definitions": { + "BillPresentationMediaRefOrValue": { + "discriminator": "isRef", + "$id": "#BillPresentationMediaRefOrValue", + "description": "An attachment by value or by reference.", + "type": "object", + "properties": { + "isRef": { + "type": "boolean", + "default": true } + }, + "required": [ + "isRef", + "role" + ], + "allOf": [ + { + "$ref": "../Customer/BillPresentationMediaRef.schema.json#BillPresentationMediaRef" + }, + { + "$ref": "../Customer/BillPresentationMedia.schema.json#BillPresentationMedia" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BillRef.schema.json b/Customer/BillRef.schema.json index 76823980..7122c5a5 100644 --- a/Customer/BillRef.schema.json +++ b/Customer/BillRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillRef.schema.json", - "title": "BillRef", - "definitions": { - "BillRef": { - "$id": "#BillRef", - "description": "Bill reference.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Unique reference of the bill." - }, - "id": { - "type": "string", - "description": "Unique identifier of the bill" - }, - "name": { - "type": "string", - "description": "Name of the bill" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillRef.schema.json", + "title": "BillRef", + "definitions": { + "BillRef": { + "$id": "#BillRef", + "description": "Bill reference.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Unique reference of the bill." + }, + "id": { + "type": "string", + "description": "Unique identifier of the bill" + }, + "name": { + "type": "string", + "description": "Name of the bill" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BillStructure.schema.json b/Customer/BillStructure.schema.json index df2706e1..29c982de 100644 --- a/Customer/BillStructure.schema.json +++ b/Customer/BillStructure.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillStructure.schema.json", - "title": "BillStructure", - "definitions": { - "BillStructure": { - "$id": "#BillStructure", - "description": "The structure of the bill for party accounts (billing or settlement).", - "type": "object", - "properties": { - "presentationMedia": { - "type": "array", - "items": { - "$ref": "BillPresentationMediaRefOrValue.schema.json#BillPresentationMediaRefOrValue" - } - }, - "format": { - "$ref": "BillFormatRefOrValue.schema.json#BillFormatRefOrValue" - }, - "cycleSpecification": { - "$ref": "BillingCycleSpecificationRefOrValue.schema.json#BillingCycleSpecificationRefOrValue" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillStructure.schema.json", + "title": "BillStructure", + "definitions": { + "BillStructure": { + "$id": "#BillStructure", + "description": "The structure of the bill for party accounts (billing or settlement).", + "type": "object", + "properties": { + "presentationMedia": { + "type": "array", + "items": { + "$ref": "../Customer/BillPresentationMediaRefOrValue.schema.json#BillPresentationMediaRefOrValue" + } + }, + "format": { + "$ref": "../Customer/BillFormatRefOrValue.schema.json#BillFormatRefOrValue" + }, + "cycleSpecification": { + "$ref": "../Customer/BillingCycleSpecificationRefOrValue.schema.json#BillingCycleSpecificationRefOrValue" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BillingAccount.schema.json b/Customer/BillingAccount.schema.json index f16cf127..efc450c0 100644 --- a/Customer/BillingAccount.schema.json +++ b/Customer/BillingAccount.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillingAccount.schema.json", - "title": "BillingAccount", - "definitions": { - "BillingAccount": { - "$id": "#BillingAccount", - "description": "A party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.", - "type": "object", - "required": [ - "name", - "relatedParty" - ], - "properties": {}, - "allOf": [ - { - "$ref": "../EngagedParty/PartyAccount.schema.json#PartyAccount" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillingAccount.schema.json", + "title": "BillingAccount", + "definitions": { + "BillingAccount": { + "$id": "#BillingAccount", + "description": "A party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.", + "type": "object", + "required": [ + "name", + "relatedParty" + ], + "properties": {}, + "allOf": [ + { + "$ref": "../EngagedParty/PartyAccount.schema.json#PartyAccount" } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BillingAccountRef.schema.json b/Customer/BillingAccountRef.schema.json index e169a82b..0972f3f0 100644 --- a/Customer/BillingAccountRef.schema.json +++ b/Customer/BillingAccountRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillingAccountRef.schema.json", - "title": "BillingAccountRef", - "definitions": { - "BillingAccountRef": { - "$id": "#BillingAccountRef", - "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the billing account" - }, - "id": { - "type": "string", - "description": "Unique identifier of the billing account" - }, - "name": { - "type": "string", - "description": "Name of the billing account" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillingAccountRef.schema.json", + "title": "BillingAccountRef", + "definitions": { + "BillingAccountRef": { + "$id": "#BillingAccountRef", + "description": "BillingAccount reference. A BillingAccount is a detailed description of a bill structure.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the billing account" + }, + "id": { + "type": "string", + "description": "Unique identifier of the billing account" + }, + "name": { + "type": "string", + "description": "Name of the billing account" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BillingCycleSpecification.schema.json b/Customer/BillingCycleSpecification.schema.json index 9bff8903..6682a8d5 100644 --- a/Customer/BillingCycleSpecification.schema.json +++ b/Customer/BillingCycleSpecification.schema.json @@ -1,70 +1,70 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillingCycleSpecification.schema.json", - "title": "BillingCycleSpecification", - "definitions": { - "BillingCycleSpecification": { - "$id": "#BillingCycleSpecification", - "description": "A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "billingDateShift": { - "type": "integer", - "description": "An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period." - }, - "billingPeriod": { - "type": "string", - "description": "A billing time period. It can be recurring, for example: week, month, quarter of year, year ." - }, - "chargeDateOffset": { - "type": "integer", - "description": "An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod." - }, - "creditDateOffset": { - "type": "integer", - "description": "An offset of a date through which credits previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod." - }, - "description": { - "type": "string", - "description": "An explanation regarding this billing cycle specification" - }, - "frequency": { - "type": "string", - "description": "Frequency of the billing cycle (monthly for instance)" - }, - "href": { - "type": "string", - "description": "Reference of the billing cycle specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the billing cycle specification" - }, - "mailingDateOffset": { - "type": "integer", - "description": "An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod." - }, - "name": { - "type": "string", - "description": "A short descriptive name" - }, - "paymentDueDateOffset": { - "type": "integer", - "description": "An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the billing specification cycle is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillingCycleSpecification.schema.json", + "title": "BillingCycleSpecification", + "definitions": { + "BillingCycleSpecification": { + "$id": "#BillingCycleSpecification", + "description": "A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "billingDateShift": { + "type": "integer", + "description": "An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period." + }, + "billingPeriod": { + "type": "string", + "description": "A billing time period. It can be recurring, for example: week, month, quarter of year, year ." + }, + "chargeDateOffset": { + "type": "integer", + "description": "An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod." + }, + "creditDateOffset": { + "type": "integer", + "description": "An offset of a date through which credits previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod." + }, + "description": { + "type": "string", + "description": "An explanation regarding this billing cycle specification" + }, + "frequency": { + "type": "string", + "description": "Frequency of the billing cycle (monthly for instance)" + }, + "href": { + "type": "string", + "description": "Reference of the billing cycle specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the billing cycle specification" + }, + "mailingDateOffset": { + "type": "integer", + "description": "An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod." + }, + "name": { + "type": "string", + "description": "A short descriptive name" + }, + "paymentDueDateOffset": { + "type": "integer", + "description": "An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the billing specification cycle is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BillingCycleSpecificationRef.schema.json b/Customer/BillingCycleSpecificationRef.schema.json index 5e4fbd83..275fc163 100644 --- a/Customer/BillingCycleSpecificationRef.schema.json +++ b/Customer/BillingCycleSpecificationRef.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillingCycleSpecificationRef.schema.json", - "title": "BillingCycleSpecificationRef", - "definitions": { - "BillingCycleSpecificationRef": { - "$id": "#BillingCycleSpecificationRef", - "description": "BillingCycleSpecification reference. A description of when to initiate a billing cycle and the various sub steps of a billing cycle.", - "type": "object", - "properties": { - "dateShift": { - "type": "integer", - "description": "An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period." - }, - "frequency": { - "type": "string", - "description": "Frequency of the billing cycle (monthly for instance)" - }, - "href": { - "type": "string", - "description": "Reference of the billing cycle specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the billing cycle specification" - }, - "name": { - "type": "string", - "description": "A short descriptive name" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillingCycleSpecificationRef.schema.json", + "title": "BillingCycleSpecificationRef", + "definitions": { + "BillingCycleSpecificationRef": { + "$id": "#BillingCycleSpecificationRef", + "description": "BillingCycleSpecification reference. A description of when to initiate a billing cycle and the various sub steps of a billing cycle.", + "type": "object", + "properties": { + "dateShift": { + "type": "integer", + "description": "An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period." + }, + "frequency": { + "type": "string", + "description": "Frequency of the billing cycle (monthly for instance)" + }, + "href": { + "type": "string", + "description": "Reference of the billing cycle specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the billing cycle specification" + }, + "name": { + "type": "string", + "description": "A short descriptive name" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/BillingCycleSpecificationRefOrValue.schema.json b/Customer/BillingCycleSpecificationRefOrValue.schema.json index 76c5679b..7fa9b92d 100644 --- a/Customer/BillingCycleSpecificationRefOrValue.schema.json +++ b/Customer/BillingCycleSpecificationRefOrValue.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BillingCycleSpecificationRefOrValue.schema.json", - "title": "BillingCycleSpecificationRefOrValue", - "definitions": { - "BillingCycleSpecificationRefOrValue": { - "discriminator": "isRef", - "$id": "#BillingCycleSpecificationRefOrValue", - "description": "An attachment by value or by reference.", - "type": "object", - "properties": { - "isRef": { - "type": "boolean", - "default": true - } - }, - "required": [ - "isRef", - "role" - ], - "allOf": [ - { - "$ref": "BillingCycleSpecificationRef.schema.json#BillingCycleSpecificationRef" - }, - { - "$ref": "BillingCycleSpecification.schema.json#BillingCycleSpecification" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BillingCycleSpecificationRefOrValue.schema.json", + "title": "BillingCycleSpecificationRefOrValue", + "definitions": { + "BillingCycleSpecificationRefOrValue": { + "discriminator": "isRef", + "$id": "#BillingCycleSpecificationRefOrValue", + "description": "An attachment by value or by reference.", + "type": "object", + "properties": { + "isRef": { + "type": "boolean", + "default": true } + }, + "required": [ + "isRef", + "role" + ], + "allOf": [ + { + "$ref": "../Customer/BillingCycleSpecificationRef.schema.json#BillingCycleSpecificationRef" + }, + { + "$ref": "../Customer/BillingCycleSpecification.schema.json#BillingCycleSpecification" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/Bucket.schema.json b/Customer/Bucket.schema.json index d3197229..0cc448a1 100644 --- a/Customer/Bucket.schema.json +++ b/Customer/Bucket.schema.json @@ -1,17 +1,17 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Bucket.schema.json", - "title": "Bucket", - "definitions": { - "Bucket": { - "$id": "#Bucket", - "description": "desc", - "allOf": [ - { - "$ref": "BucketBalance.schema.json#BucketBalance" - } - ], - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Bucket.schema.json", + "title": "Bucket", + "definitions": { + "Bucket": { + "$id": "#Bucket", + "description": "desc", + "allOf": [ + { + "$ref": "../Customer/BucketBalance.schema.json#BucketBalance" } + ], + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Customer/BucketBalance.schema.json b/Customer/BucketBalance.schema.json index 1c86d978..06fca108 100644 --- a/Customer/BucketBalance.schema.json +++ b/Customer/BucketBalance.schema.json @@ -1,83 +1,83 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BucketBalance.schema.json", - "title": "BucketBalance", - "definitions": { - "BucketBalance": { - "$id": "#BucketBalance", - "description": "Represents and tracks the amount remained or owed for a certain type of service by certain customer", - "properties": { - "bucketType": { - "type": "string", - "description": "Type of prepay balance bucket (e.g.: promotion, deposit, bonus, data, voice, or any other service type)" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the balance managed by the bucket" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the detailed information for the bucket" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the bucket" - }, - "name": { - "type": "string", - "description": "Friendly name to identify the bucket" - }, - "partyAccount": { - "description": "A reference to the account that owns the bucket", - "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" - }, - "product": { - "type": "array", - "items": { - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "description": "A reference to the product whose consumption is managed by the bucket. This is an array to allow scenarios where a given bucket is shared between different products." - }, - "realizingResource": { - "type": "array", - "items": { - "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" - }, - "description": "A reference to the resource that realizes a product. This is an array to allow scenarios where a given bucket is shared between different resources." - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "description": "Used to provide information about any other entity with relation to the balance, for instance to define customer hierarchy for the balance (e.g.: customerId, userId, )" - }, - "remainedAmount": { - "description": "Amount remained in the bucket", - "$ref": "../Common/QuantityType.schema.json#QuantityType" - }, - "reservedAmount": { - "description": "Indicate the reserved amount on the bucket", - "$ref": "../Common/QuantityType.schema.json#QuantityType" - }, - "status": { - "type": "string", - "description": "Status for the balance (active, expired, suspended)" - }, - "validFor": { - "description": "The period for which the balance in the bucket is valid", - "$ref": "../Common/TimePeriodType.schema.json#TimePeriodType" - } - }, - "required": [ - "id", - "href", - "bucketType", - "validFor", - "status", - "product" - ], - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BucketBalance.schema.json", + "title": "BucketBalance", + "definitions": { + "BucketBalance": { + "$id": "#BucketBalance", + "description": "Represents and tracks the amount remained or owed for a certain type of service by certain customer", + "properties": { + "bucketType": { + "type": "string", + "description": "Type of prepay balance bucket (e.g.: promotion, deposit, bonus, data, voice, or any other service type)" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the balance managed by the bucket" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the detailed information for the bucket" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the bucket" + }, + "name": { + "type": "string", + "description": "Friendly name to identify the bucket" + }, + "partyAccount": { + "description": "A reference to the account that owns the bucket", + "$ref": "../EngagedParty/PartyAccountRef.schema.json#PartyAccountRef" + }, + "product": { + "type": "array", + "items": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "description": "A reference to the product whose consumption is managed by the bucket. This is an array to allow scenarios where a given bucket is shared between different products." + }, + "realizingResource": { + "type": "array", + "items": { + "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" + }, + "description": "A reference to the resource that realizes a product. This is an array to allow scenarios where a given bucket is shared between different resources." + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "Used to provide information about any other entity with relation to the balance, for instance to define customer hierarchy for the balance (e.g.: customerId, userId, )" + }, + "remainedAmount": { + "description": "Amount remained in the bucket", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "reservedAmount": { + "description": "Indicate the reserved amount on the bucket", + "$ref": "../Common/QuantityType.schema.json#QuantityType" + }, + "status": { + "type": "string", + "description": "Status for the balance (active, expired, suspended)" + }, + "validFor": { + "description": "The period for which the balance in the bucket is valid", + "$ref": "../Common/TimePeriodType.schema.json#TimePeriodType" } + }, + "required": [ + "id", + "href", + "bucketType", + "validFor", + "status", + "product" + ], + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Customer/BucketBalanceRef.schema.json b/Customer/BucketBalanceRef.schema.json index 3bbaf4cd..e2790c65 100644 --- a/Customer/BucketBalanceRef.schema.json +++ b/Customer/BucketBalanceRef.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BucketBalanceRef.schema.json", - "title": "BucketBalanceRef", - "definitions": { - "BucketBalanceRef": { - "$id": "#BucketBalanceRef", - "description": "link to the resource that holds bucket balance information", - "properties": { - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the balance information for a bucket" - }, - "id": { - "type": "string", - "description": "Unique identifier for the bucket entity" - } - }, - "required": [ - "id", - "href" - ], - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BucketBalanceRef.schema.json", + "title": "BucketBalanceRef", + "definitions": { + "BucketBalanceRef": { + "$id": "#BucketBalanceRef", + "description": "link to the resource that holds bucket balance information", + "properties": { + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the balance information for a bucket" + }, + "id": { + "type": "string", + "description": "Unique identifier for the bucket entity" } + }, + "required": [ + "id", + "href" + ], + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Customer/CartItem.schema.json b/Customer/CartItem.schema.json index 37fc74e0..7197d3ff 100755 --- a/Customer/CartItem.schema.json +++ b/Customer/CartItem.schema.json @@ -1,77 +1,77 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartItem.schema.json", - "title": "CartItem", - "definitions": { - "CartItem": { - "$id": "#CartItem", - "description": "An identified part of the shopping cart. A shopping cart is decomposed into one or more shopping cart item. Cart item represents a product offering or bundled product offering that user wish to purchase, as well as the pricing of the product offering, reference to product in case of configured characteristic or installation address. Cart items can be related to other cart item to related bundled offerings or reference cart Items to a shipping options", - "type": "object", - "properties": { - "action": { - "$ref": "CartItemActionType.schema.json#CartItemActionType", - "description": "The action to be carried out on the Product. Can be: add, modify, delete, noChange" - }, - "id": { - "type": "string", - "description": "Identifier of the cart item (generally it is a sequence number 01, 02, 03, ...) in the shopping cart" - }, - "quantity": { - "type": "integer", - "description": "Quantity of cart items" - }, - "status": { - "$ref": "CartItemStatusType.schema.json#CartItemStatusType", - "description": "status of cart item. e.g \"active\" , \"savedForLater\"." - }, - "itemTerm": { - "type": "array", - "items": { - "$ref": "CartTerm.schema.json#CartTerm" - } - }, - "cartItem": { - "type": "array", - "items": { - "$ref": "CartItem.schema.json#CartItem" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "ItemTotalPrice": { - "type": "array", - "items": { - "$ref": "CartPrice.schema.json#CartPrice" - } - }, - "product": { - "$ref": "../Product/ProductRefOrValue.schema.json#ProductRefOrValue" - }, - "itemPrice": { - "type": "array", - "items": { - "$ref": "CartPrice.schema.json#CartPrice" - } - }, - "productOffering": { - "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "cartItemRelationship": { - "type": "array", - "items": { - "$ref": "CartItemRelationship.schema.json#CartItemRelationship" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartItem.schema.json", + "title": "CartItem", + "definitions": { + "CartItem": { + "$id": "#CartItem", + "description": "An identified part of the shopping cart. A shopping cart is decomposed into one or more shopping cart item. Cart item represents a product offering or bundled product offering that user wish to purchase, as well as the pricing of the product offering, reference to product in case of configured characteristic or installation address. Cart items can be related to other cart item to related bundled offerings or reference cart Items to a shipping options", + "type": "object", + "properties": { + "action": { + "$ref": "../Customer/CartItemActionType.schema.json#CartItemActionType", + "description": "The action to be carried out on the Product. Can be: add, modify, delete, noChange" + }, + "id": { + "type": "string", + "description": "Identifier of the cart item (generally it is a sequence number 01, 02, 03, ...) in the shopping cart" + }, + "quantity": { + "type": "integer", + "description": "Quantity of cart items" + }, + "status": { + "$ref": "../Customer/CartItemStatusType.schema.json#CartItemStatusType", + "description": "status of cart item. e.g \"active\" , \"savedForLater\"." + }, + "itemTerm": { + "type": "array", + "items": { + "$ref": "../Customer/CartTerm.schema.json#CartTerm" + } + }, + "cartItem": { + "type": "array", + "items": { + "$ref": "../Customer/CartItem.schema.json#CartItem" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "ItemTotalPrice": { + "type": "array", + "items": { + "$ref": "../Customer/CartPrice.schema.json#CartPrice" + } + }, + "product": { + "$ref": "../Product/ProductRefOrValue.schema.json#ProductRefOrValue" + }, + "itemPrice": { + "type": "array", + "items": { + "$ref": "../Customer/CartPrice.schema.json#CartPrice" + } + }, + "productOffering": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "cartItemRelationship": { + "type": "array", + "items": { + "$ref": "../Customer/CartItemRelationship.schema.json#CartItemRelationship" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/CartItemActionType.schema.json b/Customer/CartItemActionType.schema.json index 4da5e5da..ac331fd3 100644 --- a/Customer/CartItemActionType.schema.json +++ b/Customer/CartItemActionType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartItemActionType.schema.json", - "title": "CartItemActionType", - "definitions": { - "CartItemActionType": { - "$id": "#CartItemActionType", - "description": "action to be performed on the product", - "type": "string", - "enum": [ - "add", - "modify", - "delete", - "noChange" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartItemActionType.schema.json", + "title": "CartItemActionType", + "definitions": { + "CartItemActionType": { + "$id": "#CartItemActionType", + "description": "action to be performed on the product", + "type": "string", + "enum": [ + "add", + "modify", + "delete", + "noChange" + ] } -} \ No newline at end of file + } +} diff --git a/Customer/CartItemRef.schema.json b/Customer/CartItemRef.schema.json index a538db9b..b4ba3d58 100644 --- a/Customer/CartItemRef.schema.json +++ b/Customer/CartItemRef.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartItemRef.schema.json", - "title": "CartItemRef", - "definitions": { - "CartItemRef": { - "$id": "#CartItemRef", - "description": "CartIIem reference. A CartItem is an identified part of the shopping cart.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the cart item" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartItemRef.schema.json", + "title": "CartItemRef", + "definitions": { + "CartItemRef": { + "$id": "#CartItemRef", + "description": "CartIIem reference. A CartItem is an identified part of the shopping cart.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the cart item" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/CartItemRelationship.schema.json b/Customer/CartItemRelationship.schema.json index 463b2f4b..386cfcc4 100644 --- a/Customer/CartItemRelationship.schema.json +++ b/Customer/CartItemRelationship.schema.json @@ -1,33 +1,33 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartItemRelationship.schema.json", - "title": "CartItemRelationship", - "definitions": { - "CartItemRelationship": { - "$id": "#CartItemRelationship", - "description": "Relationship among cart items mainly other than hierarchical relationships such as \"RelyOn\", \"DependentOn\", \"Shipping\" etc.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the referred cart item" - }, - "relationshipType": { - "type": "string", - "description": "Type of the cart item relationship" - }, - "cartItem": { - "type": "array", - "items": { - "$ref": "CartItemRef.schema.json#CartItemRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartItemRelationship.schema.json", + "title": "CartItemRelationship", + "definitions": { + "CartItemRelationship": { + "$id": "#CartItemRelationship", + "description": "Relationship among cart items mainly other than hierarchical relationships such as \"RelyOn\", \"DependentOn\", \"Shipping\" etc.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the referred cart item" + }, + "relationshipType": { + "type": "string", + "description": "Type of the cart item relationship" + }, + "cartItem": { + "type": "array", + "items": { + "$ref": "../Customer/CartItemRef.schema.json#CartItemRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/CartItemStatusType.schema.json b/Customer/CartItemStatusType.schema.json index d13d7bdf..9d739535 100644 --- a/Customer/CartItemStatusType.schema.json +++ b/Customer/CartItemStatusType.schema.json @@ -1,16 +1,16 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartItemStatusType.schema.json", - "title": "CartItemStatusType", - "definitions": { - "CartItemStatusType": { - "$id": "#CartItemStatusType", - "type": "string", - "description": "Possible values for the status of the cart item", - "enum": [ - "active", - "saveForLater" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartItemStatusType.schema.json", + "title": "CartItemStatusType", + "definitions": { + "CartItemStatusType": { + "$id": "#CartItemStatusType", + "type": "string", + "description": "Possible values for the status of the cart item", + "enum": [ + "active", + "saveForLater" + ] } -} \ No newline at end of file + } +} diff --git a/Customer/CartPrice.schema.json b/Customer/CartPrice.schema.json index 2e9b8373..a5657fdd 100755 --- a/Customer/CartPrice.schema.json +++ b/Customer/CartPrice.schema.json @@ -1,52 +1,52 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartPrice.schema.json", - "title": "CartPrice", - "definitions": { - "CartPrice": { - "$id": "#CartPrice", - "description": "An amount, usually of money, that represents the actual price paid by the customer for this item. May represent the total price of the shopping cart or the total of the cart item depending on the relation", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail the semantics of this order item price." - }, - "name": { - "type": "string", - "description": "A short descriptive name such as \"Subscription price\"." - }, - "priceType": { - "type": "string", - "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth" - }, - "productOfferingPrice": { - "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef", - "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time." - }, - "recurringChargePeriod": { - "type": "string", - "description": "Could be month, week..." - }, - "unitOfMeasure": { - "type": "string", - "description": "Could be minutes, GB..." - }, - "price": { - "$ref": "Price.schema.json#Price" - }, - "priceAlteration": { - "type": "array", - "items": { - "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartPrice.schema.json", + "title": "CartPrice", + "definitions": { + "CartPrice": { + "$id": "#CartPrice", + "description": "An amount, usually of money, that represents the actual price paid by the customer for this item. May represent the total price of the shopping cart or the total of the cart item depending on the relation", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail the semantics of this order item price." + }, + "name": { + "type": "string", + "description": "A short descriptive name such as \"Subscription price\"." + }, + "priceType": { + "type": "string", + "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth" + }, + "productOfferingPrice": { + "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef", + "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time." + }, + "recurringChargePeriod": { + "type": "string", + "description": "Could be month, week..." + }, + "unitOfMeasure": { + "type": "string", + "description": "Could be minutes, GB..." + }, + "price": { + "$ref": "../Customer/Price.schema.json#Price" + }, + "priceAlteration": { + "type": "array", + "items": { + "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/CartTerm.schema.json b/Customer/CartTerm.schema.json index e5ffe6b9..c415b321 100644 --- a/Customer/CartTerm.schema.json +++ b/Customer/CartTerm.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CartTerm.schema.json", - "title": "CartTerm", - "definitions": { - "CartTerm": { - "$id": "#CartTerm", - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "duration": { - "$ref": "../Common/Quantity.schema.json#Quantity" - }, - "name": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CartTerm.schema.json", + "title": "CartTerm", + "definitions": { + "CartTerm": { + "$id": "#CartTerm", + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "duration": { + "$ref": "../Common/Quantity.schema.json#Quantity" + }, + "name": { + "type": "string" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/CashDetails.schema.json b/Customer/CashDetails.schema.json index 2b8bec3a..72b13c0c 100644 --- a/Customer/CashDetails.schema.json +++ b/Customer/CashDetails.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CashDetails.schema.json", - "title": "CashDetails", - "definitions": { - "CashDetails": { - "$id": "#CashDetails", - "description": "Cash has no additional data, but it could be extended to add information (e.g.: the cashier who took the payment, the person who paid, etc)", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CashDetails.schema.json", + "title": "CashDetails", + "definitions": { + "CashDetails": { + "$id": "#CashDetails", + "description": "Cash has no additional data, but it could be extended to add information (e.g.: the cashier who took the payment, the person who paid, etc)", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/CashMethod.schema.json b/Customer/CashMethod.schema.json index 1b1a5e7d..92ce0ad8 100644 --- a/Customer/CashMethod.schema.json +++ b/Customer/CashMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CashMethod.schema.json", - "title": "CashMethod", - "definitions": { - "CashMethod": { - "$id": "#CashMethod", - "type": "object", - "properties": { - "details": { - "$ref": "CashDetails.schema.json#CashDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CashMethod.schema.json", + "title": "CashMethod", + "definitions": { + "CashMethod": { + "$id": "#CashMethod", + "type": "object", + "properties": { + "details": { + "$ref": "../Customer/CashDetails.schema.json#CashDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/CheckDetails.schema.json b/Customer/CheckDetails.schema.json index 926f9fd1..e485f6b6 100644 --- a/Customer/CheckDetails.schema.json +++ b/Customer/CheckDetails.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CheckDetails.schema.json", - "title": "CheckDetails", - "definitions": { - "CheckDetails": { - "$id": "#CheckDetails", - "description": "Detailed information of a check", - "type": "object", - "properties": { - "bank": { - "type": "string", - "description": "Bank performing the payment of the check" - }, - "code": { - "type": "string", - "description": "Unique identifier of the check" - }, - "date": { - "type": "string", - "format": "date-time", - "description": "Date when the check was signed" - }, - "drawer": { - "type": "string", - "description": "Person or entity writing the check" - }, - "payee": { - "type": "string", - "description": "Person or entity the check is addressed to" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CheckDetails.schema.json", + "title": "CheckDetails", + "definitions": { + "CheckDetails": { + "$id": "#CheckDetails", + "description": "Detailed information of a check", + "type": "object", + "properties": { + "bank": { + "type": "string", + "description": "Bank performing the payment of the check" + }, + "code": { + "type": "string", + "description": "Unique identifier of the check" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "Date when the check was signed" + }, + "drawer": { + "type": "string", + "description": "Person or entity writing the check" + }, + "payee": { + "type": "string", + "description": "Person or entity the check is addressed to" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/CheckMethod.schema.json b/Customer/CheckMethod.schema.json index 93285f55..b72bb1e9 100644 --- a/Customer/CheckMethod.schema.json +++ b/Customer/CheckMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CheckMethod.schema.json", - "title": "CheckMethod", - "definitions": { - "CheckMethod": { - "$id": "#CheckMethod", - "type": "object", - "properties": { - "details": { - "$ref": "CheckDetails.schema.json#CheckDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CheckMethod.schema.json", + "title": "CheckMethod", + "definitions": { + "CheckMethod": { + "$id": "#CheckMethod", + "type": "object", + "properties": { + "details": { + "$ref": "../Customer/CheckDetails.schema.json#CheckDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/CreditProfile.schema.json b/Customer/CreditProfile.schema.json index 572f9061..7775c9f4 100644 --- a/Customer/CreditProfile.schema.json +++ b/Customer/CreditProfile.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CreditProfile.schema.json", - "title": "CreditProfile", - "definitions": { - "CreditProfile": { - "$id": "#CreditProfile", - "description": "Credit profile for the party (containing credit scoring, ...). By default only the current credit profile is retrieved. It can be used as a list to give the party credit profiles history, the first one in the list will be the current one.", - "type": "object", - "properties": { - "creditProfileDate": { - "type": "string", - "format": "date-time", - "description": "The date the profile was established" - }, - "creditRiskRating": { - "type": "integer", - "description": "This is an integer whose value is used to rate the risk" - }, - "creditScore": { - "type": "integer", - "description": "A measure of a person or organizations creditworthiness calculated on the basis of a combination of factors such as their income and credit history" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the profile is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CreditProfile.schema.json", + "title": "CreditProfile", + "definitions": { + "CreditProfile": { + "$id": "#CreditProfile", + "description": "Credit profile for the party (containing credit scoring, ...). By default only the current credit profile is retrieved. It can be used as a list to give the party credit profiles history, the first one in the list will be the current one.", + "type": "object", + "properties": { + "creditProfileDate": { + "type": "string", + "format": "date-time", + "description": "The date the profile was established" + }, + "creditRiskRating": { + "type": "integer", + "description": "This is an integer whose value is used to rate the risk" + }, + "creditScore": { + "type": "integer", + "description": "A measure of a person or organizations creditworthiness calculated on the basis of a combination of factors such as their income and credit history" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the profile is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/Customer.schema.json b/Customer/Customer.schema.json index 411c9994..84e83db8 100644 --- a/Customer/Customer.schema.json +++ b/Customer/Customer.schema.json @@ -1,91 +1,88 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Customer.schema.json", - "title": "Customer", - "definitions": { - "Customer": { - "$id": "#Customer", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Url used to reference the customer." - }, - "id": { - "type": "string", - "description": "Unique identifier for Customers" - }, - "name": { - "type": "string", - "description": "A word, term, or phrase by which the Customer is known and distinguished from other Customers." - }, - "status": { - "type": "string", - "description": "Used to track the lifecycle status of the customer." - }, - "statusReason": { - "type": "string", - "description": "A string providing an explanation on the value of the status lifecycle. For instance if the status is Rejected, statusReason will provide the reason for rejection." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The time period that the Customer is valid for." - }, - "engagedParty": { - "$ref": "../EngagedParty/PartyRef.schema.json#PartyRef" - }, - "roleType": { - "$ref": "../EngagedParty/RoleTypeRef.schema.json#RoleTypeRef" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } - }, - "paymentMethod": { - "type": "array", - "items": { - "$ref": "PaymentMethodRef.schema.json#PaymentMethodRef" - } - }, - "contactMedium": { - "type": "array", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - }, - "description": "Describes the characteristic of a customer." - }, - "creditProfile": { - "type": "array", - "items": { - "$ref": "CreditProfile.schema.json#CreditProfile" - } - }, - "agreement": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Customer.schema.json", + "title": "Customer", + "definitions": { + "Customer": { + "$id": "#Customer", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Url used to reference the customer." + }, + "id": { + "type": "string", + "description": "Unique identifier for Customers" + }, + "name": { + "type": "string", + "description": "A word, term, or phrase by which the Customer is known and distinguished from other Customers." + }, + "status": { + "type": "string", + "description": "Used to track the lifecycle status of the customer." + }, + "statusReason": { + "type": "string", + "description": "A string providing an explanation on the value of the status lifecycle. For instance if the status is Rejected, statusReason will provide the reason for rejection." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The time period that the Customer is valid for." + }, + "engagedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } + }, + "paymentMethod": { + "type": "array", + "items": { + "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" + } + }, + "contactMedium": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + }, + "description": "Describes the characteristic of a customer." + }, + "creditProfile": { + "type": "array", + "items": { + "$ref": "../Customer/CreditProfile.schema.json#CreditProfile" + } + }, + "agreement": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/CustomerBill.schema.json b/Customer/CustomerBill.schema.json index f641f252..4475183b 100644 --- a/Customer/CustomerBill.schema.json +++ b/Customer/CustomerBill.schema.json @@ -1,117 +1,117 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CustomerBill.schema.json", - "title": "CustomerBill", - "definitions": { - "CustomerBill": { - "$id": "#CustomerBill", - "type": "object", - "properties": { - "amountDue": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Amount due for this bill expressed in the given currency" - }, - "billDate": { - "type": "string", - "format": "date-time", - "description": "Bill date" - }, - "billingPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Billing period of the bill (used for onCycle bill only)" - }, - "billNo": { - "type": "string", - "description": "Bill reference known by the customer or the party and displayed on the bill. Could be different from the id." - }, - "category": { - "type": "string", - "description": "Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note" - }, - "href": { - "type": "string", - "description": "Bill unique reference" - }, - "id": { - "type": "string", - "description": "Bill unique identifier" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date of bill last update" - }, - "nextBillDate": { - "type": "string", - "format": "date-time", - "description": "Approximate date of the next bill production given for information (only used for onCycle bill)" - }, - "paymentDueDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the amount due should have been paid" - }, - "remainingAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Remaining amount to be paid for this bill expressed in the given currency" - }, - "runType": { - "type": "string", - "description": "onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close)" - }, - "state": { - "type": "string", - "description": "State that a bill could take during its lifecycle : New, Validated, On Hold, Sent, Partially paid or Settled" - }, - "taxExcludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Total tax excluded amount expressed in the given currency" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Total tax included amount expressed in the given" - }, - "billDocument": { - "type": "array", - "items": { - "$ref": "../Common/FileDocument.schema.json#FileDocument" - }, - "description": "Document(s) associated to the bill" - }, - "paymentItem": { - "type": "array", - "items": { - "$ref": "PaymentItem.schema.json#PaymentItem" - }, - "description": "Payment items already lettered on this bill." - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef" - }, - "taxItem": { - "type": "array", - "items": { - "$ref": "TaxItem.schema.json#TaxItem" - } - }, - "paymentMethod": { - "$ref": "PaymentMethodRef.schema.json#PaymentMethodRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "financialAccount": { - "$ref": "../EngagedParty/FinancialAccountRef.schema.json#FinancialAccountRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CustomerBill.schema.json", + "title": "CustomerBill", + "definitions": { + "CustomerBill": { + "$id": "#CustomerBill", + "type": "object", + "properties": { + "amountDue": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Amount due for this bill expressed in the given currency" + }, + "billDate": { + "type": "string", + "format": "date-time", + "description": "Bill date" + }, + "billingPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Billing period of the bill (used for onCycle bill only)" + }, + "billNo": { + "type": "string", + "description": "Bill reference known by the customer or the party and displayed on the bill. Could be different from the id." + }, + "category": { + "type": "string", + "description": "Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note" + }, + "href": { + "type": "string", + "description": "Bill unique reference" + }, + "id": { + "type": "string", + "description": "Bill unique identifier" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date of bill last update" + }, + "nextBillDate": { + "type": "string", + "format": "date-time", + "description": "Approximate date of the next bill production given for information (only used for onCycle bill)" + }, + "paymentDueDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the amount due should have been paid" + }, + "remainingAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Remaining amount to be paid for this bill expressed in the given currency" + }, + "runType": { + "type": "string", + "description": "onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close)" + }, + "state": { + "type": "string", + "description": "State that a bill could take during its lifecycle : New, Validated, On Hold, Sent, Partially paid or Settled" + }, + "taxExcludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Total tax excluded amount expressed in the given currency" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Total tax included amount expressed in the given" + }, + "billDocument": { + "type": "array", + "items": { + "$ref": "../Common/FileDocument.schema.json#FileDocument" + }, + "description": "Document(s) associated to the bill" + }, + "paymentItem": { + "type": "array", + "items": { + "$ref": "../Customer/PaymentItem.schema.json#PaymentItem" + }, + "description": "Payment items already lettered on this bill." + }, + "billingAccount": { + "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" + }, + "taxItem": { + "type": "array", + "items": { + "$ref": "../Customer/TaxItem.schema.json#TaxItem" + } + }, + "paymentMethod": { + "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "financialAccount": { + "$ref": "../EngagedParty/FinancialAccountRef.schema.json#FinancialAccountRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/DigitalWalletDetails.schema.json b/Customer/DigitalWalletDetails.schema.json index 8abe1eb4..2296b1fa 100644 --- a/Customer/DigitalWalletDetails.schema.json +++ b/Customer/DigitalWalletDetails.schema.json @@ -1,32 +1,32 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DigitalWalletDetails.schema.json", - "title": "DigitalWalletDetails", - "definitions": { - "DigitalWalletDetails": { - "$id": "#DigitalWalletDetails", - "description": "Detailed information of a check", - "type": "object", - "properties": { - "service": { - "type": "string", - "description": "Organization, platform or currency backing the wallet (e.g.: PayPal, Yandex, BitCoin...)" - }, - "walletId": { - "type": "string", - "description": "account identifier in that service" - }, - "walletUrl": { - "type": "string", - "format": "uri", - "description": "URI pointing at the digital wallet (e.g.: https://paypal.me/johndoe)" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DigitalWalletDetails.schema.json", + "title": "DigitalWalletDetails", + "definitions": { + "DigitalWalletDetails": { + "$id": "#DigitalWalletDetails", + "description": "Detailed information of a check", + "type": "object", + "properties": { + "service": { + "type": "string", + "description": "Organization, platform or currency backing the wallet (e.g.: PayPal, Yandex, BitCoin...)" + }, + "walletId": { + "type": "string", + "description": "account identifier in that service" + }, + "walletUrl": { + "type": "string", + "format": "uri", + "description": "URI pointing at the digital wallet (e.g.: https://paypal.me/johndoe)" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/DigitalWalletMethod.schema.json b/Customer/DigitalWalletMethod.schema.json index bfe5f6af..df878805 100644 --- a/Customer/DigitalWalletMethod.schema.json +++ b/Customer/DigitalWalletMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "DigitalWalletMethod.schema.json", - "title": "DigitalWalletMethod", - "definitions": { - "DigitalWalletMethod": { - "$id": "#DigitalWalletMethod", - "type": "object", - "properties": { - "details": { - "$ref": "DigitalWalletDetails.schema.json#DigitalWalletDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "DigitalWalletMethod.schema.json", + "title": "DigitalWalletMethod", + "definitions": { + "DigitalWalletMethod": { + "$id": "#DigitalWalletMethod", + "type": "object", + "properties": { + "details": { + "$ref": "../Customer/DigitalWalletDetails.schema.json#DigitalWalletDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/Disability.schema.json b/Customer/Disability.schema.json index fdb6f269..694ffede 100644 --- a/Customer/Disability.schema.json +++ b/Customer/Disability.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Disability.schema.json", - "title": "Disability", - "definitions": { - "Disability": { - "$id": "#Disability", - "type": "object", - "description": "Lack or inadequate strength or ability.", - "properties": { - "disabilityCode": { - "type": "string", - "description": "Code of the disability" - }, - "disabilityName": { - "type": "string", - "description": "Name of the disability" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Disability.schema.json", + "title": "Disability", + "definitions": { + "Disability": { + "$id": "#Disability", + "type": "object", + "description": "Lack or inadequate strength or ability.", + "properties": { + "disabilityCode": { + "type": "string", + "description": "Code of the disability" + }, + "disabilityName": { + "type": "string", + "description": "Name of the disability" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/OrderItem.schema.json b/Customer/OrderItem.schema.json index 0544e252..2a5ff67b 100644 --- a/Customer/OrderItem.schema.json +++ b/Customer/OrderItem.schema.json @@ -1,89 +1,89 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderItem.schema.json", - "title": "OrderItem", - "definitions": { - "OrderItem": { - "$id": "#OrderItem", - "description": "An identified part of the order. A product order is decomposed into one or more order items.", - "type": "object", - "properties": { - "action": { - "type": "string", - "description": "Can be \"add\" / \"modify\" / \"no_change\"/ \"delete\"" - }, - "id": { - "type": "string", - "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" - }, - "quantity": { - "type": "integer", - "description": "Quantity ordered" - }, - "state": { - "type": "string", - "description": "State of the order item : described in the state machine diagram" - }, - "appointment": { - "$ref": "AppointmentRef.schema.json#AppointmentRef" - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef" - }, - "itemPrice": { - "type": "array", - "items": { - "$ref": "OrderPrice.schema.json#OrderPrice" - } - }, - "orderItem": { - "type": "array", - "items": { - "$ref": "OrderItem.schema.json#OrderItem" - } - }, - "orderItemRelationship": { - "type": "array", - "items": { - "$ref": "OrderItemRelationship.schema.json#OrderItemRelationship" - } - }, - "itemTotalPrice": { - "type": "array", - "items": { - "$ref": "OrderPrice.schema.json#OrderPrice" - } - }, - "payment": { - "type": "array", - "items": { - "$ref": "PaymentRef.schema.json#PaymentRef" - } - }, - "productOffering": { - "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "product": { - "$ref": "../Product/Product.schema.json#Product" - }, - "qualification": { - "type": "array", - "items": { - "$ref": "../Common/QualificationRef.schema.json#QualificationRef" - } - }, - "itemTerm": { - "type": "array", - "items": { - "$ref": "OrderTerm.schema.json#OrderTerm" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderItem.schema.json", + "title": "OrderItem", + "definitions": { + "OrderItem": { + "$id": "#OrderItem", + "description": "An identified part of the order. A product order is decomposed into one or more order items.", + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "Can be \"add\" / \"modify\" / \"no_change\"/ \"delete\"" + }, + "id": { + "type": "string", + "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" + }, + "quantity": { + "type": "integer", + "description": "Quantity ordered" + }, + "state": { + "type": "string", + "description": "State of the order item : described in the state machine diagram" + }, + "appointment": { + "$ref": "../Customer/AppointmentRef.schema.json#AppointmentRef" + }, + "billingAccount": { + "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" + }, + "itemPrice": { + "type": "array", + "items": { + "$ref": "../Customer/OrderPrice.schema.json#OrderPrice" + } + }, + "orderItem": { + "type": "array", + "items": { + "$ref": "../Customer/OrderItem.schema.json#OrderItem" + } + }, + "orderItemRelationship": { + "type": "array", + "items": { + "$ref": "../Customer/OrderItemRelationship.schema.json#OrderItemRelationship" + } + }, + "itemTotalPrice": { + "type": "array", + "items": { + "$ref": "../Customer/OrderPrice.schema.json#OrderPrice" + } + }, + "payment": { + "type": "array", + "items": { + "$ref": "../Customer/PaymentRef.schema.json#PaymentRef" + } + }, + "productOffering": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "product": { + "$ref": "../Product/Product.schema.json#Product" + }, + "qualification": { + "type": "array", + "items": { + "$ref": "../Common/QualificationRef.schema.json#QualificationRef" + } + }, + "itemTerm": { + "type": "array", + "items": { + "$ref": "../Customer/OrderTerm.schema.json#OrderTerm" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/OrderItemActionType.schema.json b/Customer/OrderItemActionType.schema.json index 7a8cfd87..4a1880d1 100644 --- a/Customer/OrderItemActionType.schema.json +++ b/Customer/OrderItemActionType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderItemActionType.schema.json", - "title": "OrderItemActionType", - "definitions": { - "OrderItemActionType": { - "$id": "#OrderItemActionType", - "description": "action to be performed on the product", - "type": "string", - "enum": [ - "add", - "modify", - "delete", - "noChange" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderItemActionType.schema.json", + "title": "OrderItemActionType", + "definitions": { + "OrderItemActionType": { + "$id": "#OrderItemActionType", + "description": "action to be performed on the product", + "type": "string", + "enum": [ + "add", + "modify", + "delete", + "noChange" + ] } -} \ No newline at end of file + } +} diff --git a/Customer/OrderItemPrice.schema.json b/Customer/OrderItemPrice.schema.json index 7c0aaf0e..f2522dc7 100644 --- a/Customer/OrderItemPrice.schema.json +++ b/Customer/OrderItemPrice.schema.json @@ -1,58 +1,58 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderItemPrice.schema.json", - "title": "OrderItemPrice", - "definitions": { - "OrderItemPrice": { - "$id": "#OrderItemPrice", - "description": "An amount, usually of money, that represents the actual price paid by the Customer for this item or this order", - "type": "object", - "required": [ - "priceType", - "price" - ], - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail the semantics of this order item price." - }, - "name": { - "type": "string", - "description": "Name of the order item price" - }, - "productOfferingPrice": { - "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" - }, - "priceType": { - "type": "string", - "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth" - }, - "recurringChargePeriod": { - "type": "string", - "description": "Could be month, week..." - }, - "unitOfMeasure": { - "type": "string", - "description": "Could be minutes, GB..." - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef" - }, - "price": { - "$ref": "Price.schema.json#Price" - }, - "priceAlteration": { - "type": "array", - "items": { - "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderItemPrice.schema.json", + "title": "OrderItemPrice", + "definitions": { + "OrderItemPrice": { + "$id": "#OrderItemPrice", + "description": "An amount, usually of money, that represents the actual price paid by the Customer for this item or this order", + "type": "object", + "required": [ + "priceType", + "price" + ], + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail the semantics of this order item price." + }, + "name": { + "type": "string", + "description": "Name of the order item price" + }, + "productOfferingPrice": { + "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" + }, + "priceType": { + "type": "string", + "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth" + }, + "recurringChargePeriod": { + "type": "string", + "description": "Could be month, week..." + }, + "unitOfMeasure": { + "type": "string", + "description": "Could be minutes, GB..." + }, + "billingAccount": { + "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" + }, + "price": { + "$ref": "../Customer/Price.schema.json#Price" + }, + "priceAlteration": { + "type": "array", + "items": { + "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/OrderItemRelationship.schema.json b/Customer/OrderItemRelationship.schema.json index b9fcd508..d3cf5c51 100644 --- a/Customer/OrderItemRelationship.schema.json +++ b/Customer/OrderItemRelationship.schema.json @@ -1,25 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderItemRelationship.schema.json", - "title": "OrderItemRelationship", - "definitions": { - "OrderItemRelationship": { - "$id": "#OrderItemRelationship", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "relationshipType": { - "type": "string", - "description": "The type of order item relationship" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderItemRelationship.schema.json", + "title": "OrderItemRelationship", + "definitions": { + "OrderItemRelationship": { + "$id": "#OrderItemRelationship", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "relationshipType": { + "type": "string", + "description": "The type of order item relationship" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/OrderPrice.schema.json b/Customer/OrderPrice.schema.json index e93b6b53..ae181d3d 100644 --- a/Customer/OrderPrice.schema.json +++ b/Customer/OrderPrice.schema.json @@ -1,58 +1,58 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderPrice.schema.json", - "title": "OrderPrice", - "definitions": { - "OrderPrice": { - "$id": "#OrderPrice", - "description": "An amount, usually of money, that represents the actual price paid by the Customer for this item or this order", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail the semantics of this order item price." - }, - "name": { - "type": "string", - "description": "A short descriptive name such as \"Subscription price\"." - }, - "productOfferingPrice": { - "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef", - "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time." - }, - "priceType": { - "type": "string", - "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth" - }, - "recurringChargePeriod": { - "type": "string", - "description": "Could be month, week..." - }, - "unitOfMeasure": { - "type": "string", - "description": "Could be minutes, GB..." - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef", - "description": "A reference to a billing account used for paid the order price charge" - }, - "price": { - "$ref": "Price.schema.json#Price", - "description": "a structure used to define price amount" - }, - "priceAlteration": { - "type": "array", - "description": "a strucuture used to describe a price alteration", - "items": { - "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderPrice.schema.json", + "title": "OrderPrice", + "definitions": { + "OrderPrice": { + "$id": "#OrderPrice", + "description": "An amount, usually of money, that represents the actual price paid by the Customer for this item or this order", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail the semantics of this order item price." + }, + "name": { + "type": "string", + "description": "A short descriptive name such as \"Subscription price\"." + }, + "productOfferingPrice": { + "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef", + "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time." + }, + "priceType": { + "type": "string", + "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth" + }, + "recurringChargePeriod": { + "type": "string", + "description": "Could be month, week..." + }, + "unitOfMeasure": { + "type": "string", + "description": "Could be minutes, GB..." + }, + "billingAccount": { + "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef", + "description": "A reference to a billing account used for paid the order price charge" + }, + "price": { + "$ref": "../Customer/Price.schema.json#Price", + "description": "a structure used to define price amount" + }, + "priceAlteration": { + "type": "array", + "description": "a strucuture used to describe a price alteration", + "items": { + "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/OrderRelationship.schema.json b/Customer/OrderRelationship.schema.json index a192c04d..c948f77e 100644 --- a/Customer/OrderRelationship.schema.json +++ b/Customer/OrderRelationship.schema.json @@ -1,28 +1,28 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderRelationship.schema.json", - "title": "OrderRelationship", - "definitions": { - "OrderRelationship": { - "$id": "#OrderRelationship", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "id": { - "type": "string" - }, - "relationshipType": { - "type": "string", - "description": "The type of order relationship" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderRelationship.schema.json", + "title": "OrderRelationship", + "definitions": { + "OrderRelationship": { + "$id": "#OrderRelationship", + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "id": { + "type": "string" + }, + "relationshipType": { + "type": "string", + "description": "The type of order relationship" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/OrderTerm.schema.json b/Customer/OrderTerm.schema.json index d4a69ec9..c6c15d30 100644 --- a/Customer/OrderTerm.schema.json +++ b/Customer/OrderTerm.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderTerm.schema.json", - "title": "OrderTerm", - "definitions": { - "OrderTerm": { - "$id": "#OrderTerm", - "description": "Description of a productTerm linked to this orderItem. This represent a commitment with a duration", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the productOrderTerm" - }, - "duration": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "Duration of the productOrderTerm" - }, - "name": { - "type": "string", - "description": "Name of the productOrderTerm" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderTerm.schema.json", + "title": "OrderTerm", + "definitions": { + "OrderTerm": { + "$id": "#OrderTerm", + "description": "Description of a productTerm linked to this orderItem. This represent a commitment with a duration", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the productOrderTerm" + }, + "duration": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "Duration of the productOrderTerm" + }, + "name": { + "type": "string", + "description": "Name of the productOrderTerm" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/PaymentItem.schema.json b/Customer/PaymentItem.schema.json index b124d15c..5d06e610 100644 --- a/Customer/PaymentItem.schema.json +++ b/Customer/PaymentItem.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PaymentItem.schema.json", - "title": "PaymentItem", - "definitions": { - "PaymentItem": { - "$id": "#PaymentItem", - "description": "The paymentItem is the result of lettering process. It enables to assign automatically or manually part of incoming payment amount to a bill", - "type": "object", - "properties": { - "appliedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Part of a payment amount lettered to the customer bill" - }, - "payment": { - "$ref": "PaymentRef.schema.json#PaymentRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PaymentItem.schema.json", + "title": "PaymentItem", + "definitions": { + "PaymentItem": { + "$id": "#PaymentItem", + "description": "The paymentItem is the result of lettering process. It enables to assign automatically or manually part of incoming payment amount to a bill", + "type": "object", + "properties": { + "appliedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Part of a payment amount lettered to the customer bill" + }, + "payment": { + "$ref": "../Customer/PaymentRef.schema.json#PaymentRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/PaymentMethod.schema.json b/Customer/PaymentMethod.schema.json index 389cda97..7b37c2ba 100644 --- a/Customer/PaymentMethod.schema.json +++ b/Customer/PaymentMethod.schema.json @@ -1,59 +1,59 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PaymentMethod.schema.json", - "title": "PaymentMethod", - "definitions": { - "PaymentMethod": { - "$id": "#PaymentMethod", - "description": "Defines a specific method of payment (e.g. direct debit with all details associated)", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PaymentMethod.schema.json", + "title": "PaymentMethod", + "definitions": { + "PaymentMethod": { + "$id": "#PaymentMethod", + "description": "Defines a specific method of payment (e.g. direct debit with all details associated)", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/PaymentMethodRef.schema.json b/Customer/PaymentMethodRef.schema.json index 25ce15bd..e11b9b6c 100644 --- a/Customer/PaymentMethodRef.schema.json +++ b/Customer/PaymentMethodRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PaymentMethodRef.schema.json", - "title": "PaymentMethodRef", - "definitions": { - "PaymentMethodRef": { - "$id": "#PaymentMethodRef", - "description": "PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the payment mean" - }, - "id": { - "type": "string", - "description": "Unique identifier of the payment mean" - }, - "name": { - "type": "string", - "description": "Name of the payment mean" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PaymentMethodRef.schema.json", + "title": "PaymentMethodRef", + "definitions": { + "PaymentMethodRef": { + "$id": "#PaymentMethodRef", + "description": "PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the payment mean" + }, + "id": { + "type": "string", + "description": "Unique identifier of the payment mean" + }, + "name": { + "type": "string", + "description": "Name of the payment mean" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/PaymentMethodRefOrValue.schema.json b/Customer/PaymentMethodRefOrValue.schema.json index 6d208a70..3f4b6747 100644 --- a/Customer/PaymentMethodRefOrValue.schema.json +++ b/Customer/PaymentMethodRefOrValue.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PaymentMethodRefOrValue.schema.json", - "title": "PaymentMethodRefOrValue", - "definitions": { - "PaymentMethodRefOrValue": { - "$id": "#PaymentMethodRefOrValue", - "description": "link to the resource that holds information about the payment mean used to complete the operation", - "properties": { - "details": { - "description": "The list of parameters depends on the type of payment method", - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the OB that stores the channel information" - }, - "id": { - "type": "string", - "description": "Unique identifier for the channel entity" - }, - "name": { - "type": "string", - "description": "Name of the channel" - }, - "type": { - "type": "string", - "description": "Type of payment method (bankcard, voucher, �)" - } - }, - "required": [ - "id", - "href" - ], - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PaymentMethodRefOrValue.schema.json", + "title": "PaymentMethodRefOrValue", + "definitions": { + "PaymentMethodRefOrValue": { + "$id": "#PaymentMethodRefOrValue", + "description": "link to the resource that holds information about the payment mean used to complete the operation", + "properties": { + "details": { + "description": "The list of parameters depends on the type of payment method", + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the OB that stores the channel information" + }, + "id": { + "type": "string", + "description": "Unique identifier for the channel entity" + }, + "name": { + "type": "string", + "description": "Name of the channel" + }, + "type": { + "type": "string", + "description": "Type of payment method (bankcard, voucher, �)" } + }, + "required": [ + "id", + "href" + ], + "type": "object" } -} \ No newline at end of file + } +} diff --git a/Customer/PaymentPlan.schema.json b/Customer/PaymentPlan.schema.json index afb8bff0..d0326040 100644 --- a/Customer/PaymentPlan.schema.json +++ b/Customer/PaymentPlan.schema.json @@ -1,50 +1,50 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PaymentPlan.schema.json", - "title": "PaymentPlan", - "definitions": { - "PaymentPlan": { - "$id": "#PaymentPlan", - "description": "Defines a plan for payment (when a party wants to spread his payments)", - "type": "object", - "properties": { - "numberOfPayments": { - "type": "integer", - "description": "Number of payments used to spread the global payment" - }, - "paymentFrequency": { - "type": "string", - "description": "Frequency of the payments, such as monthly and bimonthly" - }, - "priority": { - "type": "integer", - "description": "Priority of the payment plan" - }, - "status": { - "type": "string", - "description": "Status of the payment plan (effective, ineffective)" - }, - "totalAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Amount paid" - }, - "planType": { - "type": "string", - "description": "Type of payment plan" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Validity period of the payment plan" - }, - "paymentMethod": { - "$ref": "PaymentMethodRef.schema.json#PaymentMethodRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PaymentPlan.schema.json", + "title": "PaymentPlan", + "definitions": { + "PaymentPlan": { + "$id": "#PaymentPlan", + "description": "Defines a plan for payment (when a party wants to spread his payments)", + "type": "object", + "properties": { + "numberOfPayments": { + "type": "integer", + "description": "Number of payments used to spread the global payment" + }, + "paymentFrequency": { + "type": "string", + "description": "Frequency of the payments, such as monthly and bimonthly" + }, + "priority": { + "type": "integer", + "description": "Priority of the payment plan" + }, + "status": { + "type": "string", + "description": "Status of the payment plan (effective, ineffective)" + }, + "totalAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Amount paid" + }, + "planType": { + "type": "string", + "description": "Type of payment plan" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Validity period of the payment plan" + }, + "paymentMethod": { + "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/PaymentRef.schema.json b/Customer/PaymentRef.schema.json index fadbd825..a25f432c 100644 --- a/Customer/PaymentRef.schema.json +++ b/Customer/PaymentRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PaymentRef.schema.json", - "title": "PaymentRef", - "definitions": { - "PaymentRef": { - "$id": "#PaymentRef", - "type": "object", - "description": "If an immediate payment has been done at the product order submission, the payment information are captured and stored (as a reference) in the order.", - "properties": { - "name": { - "type": "string", - "description": "A name for the payment" - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PaymentRef.schema.json", + "title": "PaymentRef", + "definitions": { + "PaymentRef": { + "$id": "#PaymentRef", + "type": "object", + "description": "If an immediate payment has been done at the product order submission, the payment information are captured and stored (as a reference) in the order.", + "properties": { + "name": { + "type": "string", + "description": "A name for the payment" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/Price.schema.json b/Customer/Price.schema.json index bc7a301c..da1210d6 100644 --- a/Customer/Price.schema.json +++ b/Customer/Price.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Price.schema.json", - "title": "Price", - "definitions": { - "Price": { - "$id": "#Price", - "description": "Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.", - "type": "object", - "properties": { - "dutyFreeAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "All taxes excluded amount (expressed in the given currency)" - }, - "percentage": { - "type": "number", - "format": "float", - "description": "Percentage to apply for ProdOfferPriceAlteration" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "All taxes included amount (expressed in the given currency)" - }, - "taxRate": { - "type": "number", - "format": "float", - "description": "Tax rate" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Price.schema.json", + "title": "Price", + "definitions": { + "Price": { + "$id": "#Price", + "description": "Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.", + "type": "object", + "properties": { + "dutyFreeAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "All taxes excluded amount (expressed in the given currency)" + }, + "percentage": { + "type": "number", + "format": "float", + "description": "Percentage to apply for ProdOfferPriceAlteration" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "All taxes included amount (expressed in the given currency)" + }, + "taxRate": { + "type": "number", + "format": "float", + "description": "Tax rate" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/ProductOrder.schema.json b/Customer/ProductOrder.schema.json index 5b4e6031..84aa35fd 100644 --- a/Customer/ProductOrder.schema.json +++ b/Customer/ProductOrder.schema.json @@ -1,147 +1,147 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOrder.schema.json", - "title": "ProductOrder", - "definitions": { - "ProductOrder": { - "$id": "#ProductOrder", - "type": "object", - "required": [ - "productOrderItem" - ], - "description": "A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa,", - "properties": { - "agreement": { - "type": "array", - "description": "A reference to an agreement defined in the context of the product order", - "items": { - "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" - } - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef" - }, - "cancellationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order is cancelled. This is used when order is cancelled. " - }, - "cancellationReason": { - "type": "string", - "description": "Reason why the order is cancelled. This is used when order is cancelled. " - }, - "category": { - "type": "string", - "description": "Used to categorize the order from a business perspective that can be useful for the OM system (e.g. \"enterprise\", \"residential\", ...)" - }, - "channel": { - "type": "array", - "items": { - "$ref": "../Common/RelatedChannel.schema.json#RelatedChannel" - } - }, - "completionDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order was completed" - }, - "description": { - "type": "string", - "description": "Description of the product order" - }, - "expectedCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Expected delivery date amended by the provider" - }, - "externalId": { - "type": "string", - "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the order" - }, - "id": { - "type": "string", - "description": "ID created on repository side (OM system)" - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "notificationContact": { - "type": "string", - "description": "Contact attached to the order to send back information regarding this order" - }, - "orderDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order was created" - }, - "orderTotalPrice": { - "type": "array", - "items": { - "$ref": "OrderPrice.schema.json#OrderPrice" - } - }, - "payment": { - "type": "array", - "items": { - "$ref": "PaymentRef.schema.json#PaymentRef" - } - }, - "priority": { - "type": "string", - "description": "A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)" - }, - "productOfferingQualification": { - "type": "array", - "items": { - "$ref": "../Product/ProductOfferingQualificationRef.schema.json#ProductOfferingQualificationRef" - } - }, - "quote": { - "type": "array", - "items": { - "$ref": "QuoteRef.schema.json#QuoteRef" - } - }, - "productOrderItem": { - "type": "array", - "items": { - "$ref": "ProductOrderItem.schema.json#ProductOrderItem" - }, - "minItems": 1 - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "requestedCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Requested delivery date from the requestor perspective" - }, - "requestedStartDate": { - "type": "string", - "format": "date-time", - "description": "Order fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow seller to begin to operationally begin the fulfillment before a date. " - }, - "state": { - "$ref": "ProductOrderStateType.schema.json#ProductOrderStateType", - "description": "Tracks the lifecycle status of the product order, such as Acknowledged, Rejected, InProgress, Pending and so on." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOrder.schema.json", + "title": "ProductOrder", + "definitions": { + "ProductOrder": { + "type": "object", + "$id": "#ProductOrder", + "required": [ + "productOrderItem" + ], + "description": "A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa,", + "properties": { + "agreement": { + "type": "array", + "description": "A reference to an agreement defined in the context of the product order", + "items": { + "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" + } + }, + "billingAccount": { + "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" + }, + "cancellationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order is cancelled. This is used when order is cancelled. " + }, + "cancellationReason": { + "type": "string", + "description": "Reason why the order is cancelled. This is used when order is cancelled. " + }, + "category": { + "type": "string", + "description": "Used to categorize the order from a business perspective that can be useful for the OM system (e.g. \"enterprise\", \"residential\", ...)" + }, + "channel": { + "type": "array", + "items": { + "$ref": "../Common/RelatedChannel.schema.json#RelatedChannel" + } + }, + "completionDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order was completed" + }, + "description": { + "type": "string", + "description": "Description of the product order" + }, + "expectedCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Expected delivery date amended by the provider" + }, + "externalId": { + "type": "string", + "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the order" + }, + "id": { + "type": "string", + "description": "ID created on repository side (OM system)" + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "notificationContact": { + "type": "string", + "description": "Contact attached to the order to send back information regarding this order" + }, + "orderDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order was created" + }, + "orderTotalPrice": { + "type": "array", + "items": { + "$ref": "../Customer/OrderPrice.schema.json#OrderPrice" + } + }, + "payment": { + "type": "array", + "items": { + "$ref": "../Customer/PaymentRef.schema.json#PaymentRef" + } + }, + "priority": { + "type": "string", + "description": "A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)" + }, + "productOfferingQualification": { + "type": "array", + "items": { + "$ref": "../Product/ProductOfferingQualificationRef.schema.json#ProductOfferingQualificationRef" + } + }, + "quote": { + "type": "array", + "items": { + "$ref": "../Customer/QuoteRef.schema.json#QuoteRef" + } + }, + "productOrderItem": { + "type": "array", + "items": { + "$ref": "../Customer/ProductOrderItem.schema.json#ProductOrderItem" + }, + "minItems": 1 + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "requestedCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Requested delivery date from the requestor perspective" + }, + "requestedStartDate": { + "type": "string", + "format": "date-time", + "description": "Order fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow seller to begin to operationally begin the fulfillment before a date. " + }, + "state": { + "$ref": "../Customer/ProductOrderStateType.schema.json#ProductOrderStateType", + "description": "Tracks the lifecycle status of the product order, such as Acknowledged, Rejected, InProgress, Pending and so on." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/ProductOrderItem.schema.json b/Customer/ProductOrderItem.schema.json index fd89697a..3f996289 100644 --- a/Customer/ProductOrderItem.schema.json +++ b/Customer/ProductOrderItem.schema.json @@ -1,95 +1,95 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOrderItem.schema.json", - "title": "ProductOrderItem", - "definitions": { - "ProductOrderItem": { - "$id": "#ProductOrderItem", - "type": "object", - "description": "An identified part of the order. A product order is decomposed into one or more order items.", - "properties": { - "id": { - "type": "string", - "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" - }, - "quantity": { - "type": "integer", - "description": "Quantity ordered" - }, - "action": { - "$ref": "OrderItemActionType.schema.json#OrderItemActionType", - "description": "The action to be carried out on the Product. Can be: add, modify, delete, noChange" - }, - "appointment": { - "$ref": "AppointmentRef.schema.json#AppointmentRef" - }, - "billingAccount": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef" - }, - "itemPrice": { - "type": "array", - "items": { - "$ref": "OrderPrice.schema.json#OrderPrice" - } - }, - "itemTerm": { - "type": "array", - "items": { - "$ref": "OrderTerm.schema.json#OrderTerm" - } - }, - "itemTotalPrice": { - "type": "array", - "items": { - "$ref": "OrderPrice.schema.json#OrderPrice" - } - }, - "payment": { - "type": "array", - "items": { - "$ref": "PaymentRef.schema.json#PaymentRef" - } - }, - "product": { - "$ref": "../Product/ProductRefOrValue.schema.json#ProductRefOrValue" - }, - "productOffering": { - "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "productOfferingQualificationItem": { - "$ref": "../Product/ProductOfferingQualificationItemRef.schema.json#ProductOfferingQualificationItemRef" - }, - "quoteItem": { - "$ref": "QuoteItemRef.schema.json#QuoteItemRef" - }, - "productOrderItem": { - "type": "array", - "items": { - "$ref": "ProductOrderItem.schema.json#ProductOrderItem" - } - }, - "productOrderItemRelationship": { - "type": "array", - "items": { - "$ref": "OrderItemRelationship.schema.json#OrderItemRelationship" - } - }, - "qualification": { - "type": "array", - "items": { - "$ref": "../Product/ProductOfferingQualificationRef.schema.json#ProductOfferingQualificationRef" - } - }, - "state": { - "$ref": "ProductOrderItemStateType.schema.json#ProductOrderItemStateType", - "description": "State of the order item : described in the state machine diagram" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOrderItem.schema.json", + "title": "ProductOrderItem", + "definitions": { + "ProductOrderItem": { + "$id": "#ProductOrderItem", + "type": "object", + "description": "An identified part of the order. A product order is decomposed into one or more order items.", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" + }, + "quantity": { + "type": "integer", + "description": "Quantity ordered" + }, + "action": { + "$ref": "../Customer/OrderItemActionType.schema.json#OrderItemActionType", + "description": "The action to be carried out on the Product. Can be: add, modify, delete, noChange" + }, + "appointment": { + "$ref": "../Customer/AppointmentRef.schema.json#AppointmentRef" + }, + "billingAccount": { + "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" + }, + "itemPrice": { + "type": "array", + "items": { + "$ref": "../Customer/OrderPrice.schema.json#OrderPrice" + } + }, + "itemTerm": { + "type": "array", + "items": { + "$ref": "../Customer/OrderTerm.schema.json#OrderTerm" + } + }, + "itemTotalPrice": { + "type": "array", + "items": { + "$ref": "../Customer/OrderPrice.schema.json#OrderPrice" + } + }, + "payment": { + "type": "array", + "items": { + "$ref": "../Customer/PaymentRef.schema.json#PaymentRef" + } + }, + "product": { + "$ref": "../Product/ProductRefOrValue.schema.json#ProductRefOrValue" + }, + "productOffering": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "productOfferingQualificationItem": { + "$ref": "../Product/ProductOfferingQualificationItemRef.schema.json#ProductOfferingQualificationItemRef" + }, + "quoteItem": { + "$ref": "../Customer/QuoteItemRef.schema.json#QuoteItemRef" + }, + "productOrderItem": { + "type": "array", + "items": { + "$ref": "../Customer/ProductOrderItem.schema.json#ProductOrderItem" + } + }, + "productOrderItemRelationship": { + "type": "array", + "items": { + "$ref": "../Customer/OrderItemRelationship.schema.json#OrderItemRelationship" + } + }, + "qualification": { + "type": "array", + "items": { + "$ref": "../Product/ProductOfferingQualificationRef.schema.json#ProductOfferingQualificationRef" + } + }, + "state": { + "$ref": "../Customer/ProductOrderItemStateType.schema.json#ProductOrderItemStateType", + "description": "State of the order item : described in the state machine diagram" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/ProductOrderItemStateType.schema.json b/Customer/ProductOrderItemStateType.schema.json index e8c07a40..fb0a12fc 100644 --- a/Customer/ProductOrderItemStateType.schema.json +++ b/Customer/ProductOrderItemStateType.schema.json @@ -1,24 +1,24 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOrderItemStateType.schema.json", - "title": "ProductOrderItemStateType", - "definitions": { - "ProductOrderItemStateType": { - "$id": "#ProductOrderItemStateType", - "type": "string", - "description": "Possible values for the state of the product order item", - "enum": [ - "acknowledged", - "rejected", - "pending", - "held", - "inProgress", - "cancelled", - "completed", - "failed", - "assessingCancellation", - "pendingCancellation" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOrderItemStateType.schema.json", + "title": "ProductOrderItemStateType", + "definitions": { + "ProductOrderItemStateType": { + "$id": "#ProductOrderItemStateType", + "type": "string", + "description": "Possible values for the state of the product order item", + "enum": [ + "acknowledged", + "rejected", + "pending", + "held", + "inProgress", + "cancelled", + "completed", + "failed", + "assessingCancellation", + "pendingCancellation" + ] } -} \ No newline at end of file + } +} diff --git a/Customer/ProductOrderRef.schema.json b/Customer/ProductOrderRef.schema.json index b88c3ae7..80751143 100644 --- a/Customer/ProductOrderRef.schema.json +++ b/Customer/ProductOrderRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOrderRef.schema.json", - "title": "ProductOrderRef", - "definitions": { - "ProductOrderRef": { - "$id": "#ProductOrderRef", - "description": "ProductOrder (ProductOrder) .The product order which the recommendation is related with.", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOrderRef.schema.json", + "title": "ProductOrderRef", + "definitions": { + "ProductOrderRef": { + "$id": "#ProductOrderRef", + "description": "ProductOrder (ProductOrder) .The product order which the recommendation is related with.", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/ProductOrderStateType.schema.json b/Customer/ProductOrderStateType.schema.json index 4a5dd9cd..3929c5dc 100644 --- a/Customer/ProductOrderStateType.schema.json +++ b/Customer/ProductOrderStateType.schema.json @@ -1,25 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOrderStateType.schema.json", - "title": "ProductOrderStateType", - "definitions": { - "ProductOrderStateType": { - "$id": "#ProductOrderStateType", - "type": "string", - "description": "Possible values for the state of the order", - "enum": [ - "acknowledged", - "rejected", - "pending", - "held", - "inProgress", - "cancelled", - "completed", - "failed", - "partial", - "assessingCancellation", - "pendingCancellation" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOrderStateType.schema.json", + "title": "ProductOrderStateType", + "definitions": { + "ProductOrderStateType": { + "$id": "#ProductOrderStateType", + "type": "string", + "description": "Possible values for the state of the order", + "enum": [ + "acknowledged", + "rejected", + "pending", + "held", + "inProgress", + "cancelled", + "completed", + "failed", + "partial", + "assessingCancellation", + "pendingCancellation" + ] } -} \ No newline at end of file + } +} diff --git a/Customer/QueryProductRecommendation.schema.json b/Customer/QueryProductRecommendation.schema.json new file mode 100644 index 00000000..7fbf9487 --- /dev/null +++ b/Customer/QueryProductRecommendation.schema.json @@ -0,0 +1,77 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QueryProductRecommendation.schema.json", + "title": "QueryProductRecommendation", + "definitions": { + "QueryProductRecommendation": { + "$id": "#QueryProductRecommendation", + "description": "Recommendation API is used to recommend offering quickly based on the history and real-time context of customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omni-channel.", + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "id": { + "type": "string", + "description": "Unique identifier of recommendation" + }, + "instantSyncRecommendation": { + "type": "boolean", + "description": "An indicator which when the value is \"true\" means that requester expects to get recommendation result in the response" + }, + "href": { + "type": "string", + "description": "Hypertext Reference of the recommendation" + }, + "name": { + "type": "string", + "description": "Name of recommendation" + }, + "recommendationType": { + "type": "string", + "description": "The type of recommendation" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period in which the recommendation is valid" + }, + "order": { + "$ref": "../Customer/ProductOrderRef.schema.json#ProductOrderRef" + }, + "place": { + "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue", + "description": "The place which the recommendation is related to" + }, + "channel": { + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "category": { + "$ref": "../Product/CategoryRef.schema.json#CategoryRef", + "description": "The category for grouping recommendations" + }, + "shoppingCart": { + "$ref": "../Customer/ShoppingCartRef.schema.json#ShoppingCartRef", + "description": "The shopping cart which the recommendation is related to" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + }, + "item": { + "type": "array", + "items": { + "$ref": "../Product/RecommendationItem.schema.json#RecommendationItem" + } + }, + "state": { + "$ref": "../Common/TaskStateType.schema.json#TaskStateType", + "description": "State of the Recommendation defined in the state engine" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] + } + } +} diff --git a/Customer/Quote.schema.json b/Customer/Quote.schema.json index 96c130f6..141b58e7 100644 --- a/Customer/Quote.schema.json +++ b/Customer/Quote.schema.json @@ -1,147 +1,147 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Quote.schema.json", - "title": "Quote", - "definitions": { - "Quote": { - "$id": "#Quote", - "type": "object", - "required": [ - "quoteItem" - ], - "description": "Quote can be used to negotiate service and product acquisition or modification between a customer and a service provider. Quote contain list of quote items, a reference to customer (partyRole), a list of productOffering and attached prices and conditions.", - "properties": { - "agreement": { - "type": "array", - "description": "A reference to an agreement defining the context of the quote", - "items": { - "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" - } - }, - "billingAccount": { - "type": "array", - "description": "A reference to a billing account to provide quote context information ", - "items": { - "$ref": "BillingAccountRef.schema.json#BillingAccountRef" - } - }, - "category": { - "type": "string", - "description": "Used to categorize the quote from a business perspective that can be useful for the CRM system (e.g. \"enterprise\", \"residential\", ...)" - }, - "contactMedium": { - "type": "array", - "description": "Information contact related to the quote requester", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - }, - "description": { - "type": "string", - "description": "Description of the quote" - }, - "effectiveQuoteCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Date when the quote has been completed" - }, - "expectedFulfillmentStartDate": { - "type": "string", - "format": "date-time", - "description": "this is the date wished by the requester to have the requested quote item delivered" - }, - "expectedQuoteCompletionDate": { - "type": "string", - "format": "date-time", - "description": "This is expected date - from quote supplier - to be able to send back a response for this quote" - }, - "externalId": { - "type": "string", - "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the quote" - }, - "id": { - "type": "string", - "description": "Unique identifier - attributed by quoting system" - }, - "instantSyncQuote": { - "type": "boolean", - "description": "An indicator which when the value is \"true\" means that requester expects to get quoting result immediately in the response. If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201. " - }, - "note": { - "type": "array", - "description": "Free form text associated with the quote", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "authorization": { - "type": "array", - "description": "An authorization provided for the quote", - "items": { - "$ref": "Authorization.schema.json#Authorization" - } - }, - "quoteDate": { - "type": "string", - "format": "date-time", - "description": "Date and time when the quote was created" - }, - "quoteItem": { - "type": "array", - "description": "An item of the quote - it is used to descirbe an operation on a product to be quoted", - "items": { - "$ref": "QuoteItem.schema.json#QuoteItem" - }, - "minItems": 1 - }, - "quoteTotalPrice": { - "type": "array", - "description": "Quote total price", - "items": { - "$ref": "QuotePrice.schema.json#QuotePrice" - } - }, - "relatedParty": { - "type": "array", - "description": "A reference to a party playing a role in this quote (customer, seller, requester, etc.)", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "productOfferingQualification": { - "type": "array", - "description": "A reference to a previously done product offering qualification", - "items": { - "$ref": "../Product/ProductOfferingQualificationRef.schema.json#ProductOfferingQualificationRef" - } - }, - "requestedQuoteCompletionDate": { - "type": "string", - "format": "date-time", - "description": "This is requested date - from quote requester - to get a complete response for this quote" - }, - "state": { - "$ref": "../Product/QuoteStateType.schema.json#QuoteStateType", - "description": "State of the quote : described in the state-machine diagram" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Quote validity period" - }, - "version": { - "type": "string", - "description": "Quote version - if the customer rejected the quote but negotiations still open a new version of the quote is managed" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Quote.schema.json", + "title": "Quote", + "definitions": { + "Quote": { + "$id": "#Quote", + "type": "object", + "required": [ + "quoteItem" + ], + "description": "Quote can be used to negotiate service and product acquisition or modification between a customer and a service provider. Quote contain list of quote items, a reference to customer (partyRole), a list of productOffering and attached prices and conditions.", + "properties": { + "agreement": { + "type": "array", + "description": "A reference to an agreement defining the context of the quote", + "items": { + "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" + } + }, + "billingAccount": { + "type": "array", + "description": "A reference to a billing account to provide quote context information ", + "items": { + "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" + } + }, + "category": { + "type": "string", + "description": "Used to categorize the quote from a business perspective that can be useful for the CRM system (e.g. \"enterprise\", \"residential\", ...)" + }, + "contactMedium": { + "type": "array", + "description": "Information contact related to the quote requester", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "description": { + "type": "string", + "description": "Description of the quote" + }, + "effectiveQuoteCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Date when the quote has been completed" + }, + "expectedFulfillmentStartDate": { + "type": "string", + "format": "date-time", + "description": "this is the date wished by the requester to have the requested quote item delivered" + }, + "expectedQuoteCompletionDate": { + "type": "string", + "format": "date-time", + "description": "This is expected date - from quote supplier - to be able to send back a response for this quote" + }, + "externalId": { + "type": "string", + "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the quote" + }, + "id": { + "type": "string", + "description": "Unique identifier - attributed by quoting system" + }, + "instantSyncQuote": { + "type": "boolean", + "description": "An indicator which when the value is \"true\" means that requester expects to get quoting result immediately in the response. If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201. " + }, + "note": { + "type": "array", + "description": "Free form text associated with the quote", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "authorization": { + "type": "array", + "description": "An authorization provided for the quote", + "items": { + "$ref": "../Customer/Authorization.schema.json#Authorization" + } + }, + "quoteDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the quote was created" + }, + "quoteItem": { + "type": "array", + "description": "An item of the quote - it is used to descirbe an operation on a product to be quoted", + "items": { + "$ref": "../Customer/QuoteItem.schema.json#QuoteItem" + }, + "minItems": 1 + }, + "quoteTotalPrice": { + "type": "array", + "description": "Quote total price", + "items": { + "$ref": "../Customer/QuotePrice.schema.json#QuotePrice" + } + }, + "relatedParty": { + "type": "array", + "description": "A reference to a party playing a role in this quote (customer, seller, requester, etc.)", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "productOfferingQualification": { + "type": "array", + "description": "A reference to a previously done product offering qualification", + "items": { + "$ref": "../Product/ProductOfferingQualificationRef.schema.json#ProductOfferingQualificationRef" + } + }, + "requestedQuoteCompletionDate": { + "type": "string", + "format": "date-time", + "description": "This is requested date - from quote requester - to get a complete response for this quote" + }, + "state": { + "$ref": "../Product/QuoteStateType.schema.json#QuoteStateType", + "description": "State of the quote : described in the state-machine diagram" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Quote validity period" + }, + "version": { + "type": "string", + "description": "Quote version - if the customer rejected the quote but negotiations still open a new version of the quote is managed" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/QuoteItem.schema.json b/Customer/QuoteItem.schema.json index 404cd736..2736c8ec 100644 --- a/Customer/QuoteItem.schema.json +++ b/Customer/QuoteItem.schema.json @@ -1,101 +1,101 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteItem.schema.json", - "title": "QuoteItem", - "definitions": { - "QuoteItem": { - "$id": "#QuoteItem", - "type": "object", - "description": "A quote items describe an action to be performed on a productOffering or a product in order to get pricing elements and condition.", - "properties": { - "action": { - "type": "string", - "description": "Action to be performed on this quote item (add, modify, remove, etc.)" - }, - "appointment": { - "type": "array", - "description": "A reference to appointment(s) associated with this quote item", - "items": { - "$ref": "AppointmentRef.schema.json#AppointmentRef" - } - }, - "attachment": { - "type": "array", - "description": "A reference to attachment(s) associated with this quote item", - "items": { - "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" - } - }, - "id": { - "type": "string", - "description": "Identifier of the quote item (generally it is a sequence number 01, 02, 03, ...)" - }, - "note": { - "type": "array", - "description": "Free form text associated with the quote item", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "product": { - "$ref": "../Product/ProductRefOrValue.schema.json#ProductRefOrValue" - }, - "productOffering": { - "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "quantity": { - "type": "integer", - "description": "Quantity asked for this quote item" - }, - "quoteItem": { - "type": "array", - "description": "A structure to embedded quote item within quote item", - "items": { - "$ref": "QuoteItem.schema.json#QuoteItem" - } - }, - "quoteItemAuthorization": { - "type": "array", - "description": "Authorization related to this quote item", - "items": { - "$ref": "Authorization.schema.json#Authorization" - } - }, - "quoteItemPrice": { - "type": "array", - "description": "Price for this quote item", - "items": { - "$ref": "QuotePrice.schema.json#QuotePrice" - } - }, - "quoteItemRelationship": { - "type": "array", - "description": "A relationship from item within a quote", - "items": { - "$ref": "QuoteItemRelationship.schema.json#QuoteItemRelationship" - } - }, - "productOfferingQualificationItem": { - "description": "A reference to a previously done POQ with item specified", - "$ref": "../Product/ProductOfferingQualificationItemRef.schema.json#ProductOfferingQualificationItemRef" - }, - "relatedParty": { - "type": "array", - "description": "A reference to a party playing a role in this quote item", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "state": { - "type": "string", - "description": "State of the quote item : described in the state machine diagram" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteItem.schema.json", + "title": "QuoteItem", + "definitions": { + "QuoteItem": { + "$id": "#QuoteItem", + "type": "object", + "description": "A quote items describe an action to be performed on a productOffering or a product in order to get pricing elements and condition.", + "properties": { + "action": { + "type": "string", + "description": "Action to be performed on this quote item (add, modify, remove, etc.)" + }, + "appointment": { + "type": "array", + "description": "A reference to appointment(s) associated with this quote item", + "items": { + "$ref": "../Customer/AppointmentRef.schema.json#AppointmentRef" + } + }, + "attachment": { + "type": "array", + "description": "A reference to attachment(s) associated with this quote item", + "items": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + } + }, + "id": { + "type": "string", + "description": "Identifier of the quote item (generally it is a sequence number 01, 02, 03, ...)" + }, + "note": { + "type": "array", + "description": "Free form text associated with the quote item", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "product": { + "$ref": "../Product/ProductRefOrValue.schema.json#ProductRefOrValue" + }, + "productOffering": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "quantity": { + "type": "integer", + "description": "Quantity asked for this quote item" + }, + "quoteItem": { + "type": "array", + "description": "A structure to embedded quote item within quote item", + "items": { + "$ref": "../Customer/QuoteItem.schema.json#QuoteItem" + } + }, + "quoteItemAuthorization": { + "type": "array", + "description": "Authorization related to this quote item", + "items": { + "$ref": "../Customer/Authorization.schema.json#Authorization" + } + }, + "quoteItemPrice": { + "type": "array", + "description": "Price for this quote item", + "items": { + "$ref": "../Customer/QuotePrice.schema.json#QuotePrice" + } + }, + "quoteItemRelationship": { + "type": "array", + "description": "A relationship from item within a quote", + "items": { + "$ref": "../Customer/QuoteItemRelationship.schema.json#QuoteItemRelationship" + } + }, + "productOfferingQualificationItem": { + "description": "A reference to a previously done POQ with item specified", + "$ref": "../Product/ProductOfferingQualificationItemRef.schema.json#ProductOfferingQualificationItemRef" + }, + "relatedParty": { + "type": "array", + "description": "A reference to a party playing a role in this quote item", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "state": { + "type": "string", + "description": "State of the quote item : described in the state machine diagram" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/QuoteItemRef.schema.json b/Customer/QuoteItemRef.schema.json index 3b8208e5..8b453111 100644 --- a/Customer/QuoteItemRef.schema.json +++ b/Customer/QuoteItemRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteItemRef.schema.json", - "title": "QuoteItemRef", - "definitions": { - "QuoteItemRef": { - "$id": "#QuoteItemRef", - "type": "object", - "description": "It's a Quote item that has been executed previously.", - "required": [ - "id", - "quoteId" - ], - "properties": { - "quoteHref": { - "type": "string", - "description": "Reference of the related entity." - }, - "quoteId": { - "type": "string", - "description": "Unique identifier of a related entity." - }, - "quoteName": { - "type": "string", - "description": "Name of the related entity." - }, - "id": { - "type": "string", - "description": "Id of an item of a quote" - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteItemRef.schema.json", + "title": "QuoteItemRef", + "definitions": { + "QuoteItemRef": { + "$id": "#QuoteItemRef", + "type": "object", + "description": "It's a Quote item that has been executed previously.", + "required": [ + "id", + "quoteId" + ], + "properties": { + "quoteHref": { + "type": "string", + "description": "Reference of the related entity." + }, + "quoteId": { + "type": "string", + "description": "Unique identifier of a related entity." + }, + "quoteName": { + "type": "string", + "description": "Name of the related entity." + }, + "id": { + "type": "string", + "description": "Id of an item of a quote" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/QuoteItemRelationship.schema.json b/Customer/QuoteItemRelationship.schema.json index 66ef513e..d7a5f6c3 100644 --- a/Customer/QuoteItemRelationship.schema.json +++ b/Customer/QuoteItemRelationship.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteItemRelationship.schema.json", - "title": "QuoteItemRelationship", - "definitions": { - "QuoteItemRelationship": { - "$id": "#QuoteItemRelationship", - "description": "Used to describe relationship between quote item. These relationship could have an impact on pricing and conditions", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "ID of the related order item (must be in the same quote)" - }, - "relationshipType": { - "type": "string", - "description": "Relationship type as relies on, bundles, etc..." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteItemRelationship.schema.json", + "title": "QuoteItemRelationship", + "definitions": { + "QuoteItemRelationship": { + "$id": "#QuoteItemRelationship", + "description": "Used to describe relationship between quote item. These relationship could have an impact on pricing and conditions", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the related order item (must be in the same quote)" + }, + "relationshipType": { + "type": "string", + "description": "Relationship type as relies on, bundles, etc..." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/QuotePrice.schema.json b/Customer/QuotePrice.schema.json index beb9d8ec..b0d720b0 100644 --- a/Customer/QuotePrice.schema.json +++ b/Customer/QuotePrice.schema.json @@ -1,52 +1,52 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuotePrice.schema.json", - "title": "QuotePrice", - "definitions": { - "QuotePrice": { - "$id": "#QuotePrice", - "description": "Description of price and discount awarded", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the quote/quote item price" - }, - "name": { - "type": "string", - "description": "Name of the quote /quote item price" - }, - "productOfferingPrice": { - "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef", - "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time." - }, - "priceType": { - "type": "string", - "description": "indicate if the price is for recurrent or no-recurrent charge" - }, - "recurringChargePeriod": { - "type": "string", - "description": "Used for recurring charge to indicate period (month, week, etc..)" - }, - "unitOfMeasure": { - "type": "string", - "description": "Unit of Measure if price depending on it (Gb, SMS volume, etc..)" - }, - "priceAlteration": { - "type": "array", - "items": { - "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" - } - }, - "price": { - "$ref": "Price.schema.json#Price" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuotePrice.schema.json", + "title": "QuotePrice", + "definitions": { + "QuotePrice": { + "$id": "#QuotePrice", + "description": "Description of price and discount awarded", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the quote/quote item price" + }, + "name": { + "type": "string", + "description": "Name of the quote /quote item price" + }, + "productOfferingPrice": { + "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef", + "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time." + }, + "priceType": { + "type": "string", + "description": "indicate if the price is for recurrent or no-recurrent charge" + }, + "recurringChargePeriod": { + "type": "string", + "description": "Used for recurring charge to indicate period (month, week, etc..)" + }, + "unitOfMeasure": { + "type": "string", + "description": "Unit of Measure if price depending on it (Gb, SMS volume, etc..)" + }, + "priceAlteration": { + "type": "array", + "items": { + "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" + } + }, + "price": { + "$ref": "../Customer/Price.schema.json#Price" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/QuoteRef.schema.json b/Customer/QuoteRef.schema.json index 6237cc66..d1a06b67 100644 --- a/Customer/QuoteRef.schema.json +++ b/Customer/QuoteRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteRef.schema.json", - "title": "QuoteRef", - "definitions": { - "QuoteRef": { - "$id": "#QuoteRef", - "type": "object", - "description": "It's a Quote that has been executed previously", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteRef.schema.json", + "title": "QuoteRef", + "definitions": { + "QuoteRef": { + "$id": "#QuoteRef", + "type": "object", + "description": "It's a Quote that has been executed previously", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/SearchTimeSlot.schema.json b/Customer/SearchTimeSlot.schema.json index 14e50c23..c0d2df32 100644 --- a/Customer/SearchTimeSlot.schema.json +++ b/Customer/SearchTimeSlot.schema.json @@ -1,66 +1,66 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SearchTimeSlot.schema.json", - "title": "SearchTimeSlot", - "definitions": { - "SearchTimeSlot": { - "$id": "#SearchTimeSlot", - "type": "object", - "description": "This task resource is used to retrieve available time slots. One of this available time slot is after used to create or reschedule an appointment", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the search time slot request" - }, - "href": { - "type": "string", - "description": "Reference to access the search time slot resource" - }, - "status": { - "type": "string", - "description": "Status of the search time slot (rejected, inProgress, done or terminatedWithError)" - }, - "searchDate": { - "type": "string", - "format": "date-time", - "description": "Date when the search time slot is performed" - }, - "searchResult": { - "type": "string", - "description": "Result of the search time slot (success or fail for example)" - }, - "requestedTimeSlot": { - "type": "array", - "items": { - "$ref": "TimeSlot.schema.json#TimeSlot" - } - }, - "availableTimeSlot": { - "type": "array", - "items": { - "$ref": "TimeSlot.schema.json#TimeSlot" - } - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty", - "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity." - }, - "relatedEntity": { - "type": "array", - "items": { - "$ref": "../Common/RelatedEntity.schema.json#RelatedEntity" - } - }, - "relatedPlace": { - "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue", - "description": "Related place defines (by reference or value) the place where the appointment will take place." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SearchTimeSlot.schema.json", + "title": "SearchTimeSlot", + "definitions": { + "SearchTimeSlot": { + "$id": "#SearchTimeSlot", + "type": "object", + "description": "This task resource is used to retrieve available time slots. One of this available time slot is after used to create or reschedule an appointment", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the search time slot request" + }, + "href": { + "type": "string", + "description": "Reference to access the search time slot resource" + }, + "status": { + "type": "string", + "$ref": "../Customer/SearchTimeSlotStateType.schema.json#SearchTimeSlotStateType" + }, + "searchDate": { + "type": "string", + "format": "date-time", + "description": "Date when the search time slot is performed" + }, + "searchResult": { + "type": "string", + "description": "Result of the search time slot (success or fail for example)" + }, + "requestedTimeSlot": { + "type": "array", + "items": { + "$ref": "../Customer/TimeSlot.schema.json#TimeSlot" + } + }, + "availableTimeSlot": { + "type": "array", + "items": { + "$ref": "../Customer/TimeSlot.schema.json#TimeSlot" + } + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty", + "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity." + }, + "relatedEntity": { + "type": "array", + "items": { + "$ref": "../Common/RelatedEntity.schema.json#RelatedEntity" + } + }, + "relatedPlace": { + "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue", + "description": "Related place defines (by reference or value) the place where the appointment will take place." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/SearchTimeSlotStateType.schema.json b/Customer/SearchTimeSlotStateType.schema.json new file mode 100644 index 00000000..763a2120 --- /dev/null +++ b/Customer/SearchTimeSlotStateType.schema.json @@ -0,0 +1,18 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SearchTimeSlotStateType.schema.json", + "title": "SearchTimeSlotStateType", + "definitions": { + "SearchTimeSlotStateType": { + "$id": "#SearchTimeSlotStateType", + "type": "string", + "description": "Valid values for the lifecycle state of the searchTimeSlot", + "enum": [ + "inProgress", + "done", + "rejected", + "terminatedWithError" + ] + } + } +} diff --git a/Customer/SettlementMethod.schema.json b/Customer/SettlementMethod.schema.json index 787fdc75..326227a3 100644 --- a/Customer/SettlementMethod.schema.json +++ b/Customer/SettlementMethod.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SettlementMethod.schema.json", - "title": "SettlementMethod", - "definitions": { - "SettlementMethod": { - "$id": "#SettlementMethod", - "description": "Is the way in which the CSP provides the payment", - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Code of the settlement method" - }, - "label": { - "type": "string", - "description": "A word, term or phrase by which a settlement method is known and distinguished from other settlement method" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SettlementMethod.schema.json", + "title": "SettlementMethod", + "definitions": { + "SettlementMethod": { + "$id": "#SettlementMethod", + "description": "Is the way in which the CSP provides the payment", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Code of the settlement method" + }, + "label": { + "type": "string", + "description": "A word, term or phrase by which a settlement method is known and distinguished from other settlement method" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/SettlementNoteAdvice.schema.json b/Customer/SettlementNoteAdvice.schema.json index 11538ede..d99010bf 100644 --- a/Customer/SettlementNoteAdvice.schema.json +++ b/Customer/SettlementNoteAdvice.schema.json @@ -1,92 +1,92 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SettlementNoteAdvice.schema.json", - "title": "SettlementNoteAdvice", - "definitions": { - "SettlementNoteAdvice": { - "$id": "#SettlementNoteAdvice", - "description": "The settlement is about transferring money receiving by a CSP to a partner. The settlement is notified to the partner with a settlement note advice containing details in settlement lines.", - "type": "object", - "properties": { - "currencyCode": { - "type": "string", - "description": "A string used as a code for specifying the currency associated to the given amounts. The ISO4217 norm uses 3 letters to define the currency (for example USD for US dollar or EUR for Euro)." - }, - "date": { - "type": "string", - "format": "date-time", - "description": "Creation date of the settlement note advice" - }, - "description": { - "type": "string", - "description": "A free description text" - }, - "href": { - "type": "string", - "description": "Reference of the settlement note advice" - }, - "id": { - "type": "string", - "description": "A unique identifier for the settlement note advice" - }, - "issuerTaxRegistration": { - "type": "string", - "description": "Tax registration number of the issuer" - }, - "paymentDueDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the due amount should have been paid to the partner" - }, - "receiverTaxRegistration": { - "type": "string", - "description": "Tax registration number of the receiver" - }, - "taxDate": { - "type": "string", - "format": "date-time", - "description": "Date of the tax" - }, - "taxExcludedAmount": { - "type": "number", - "format": "float", - "description": "All taxes excluded amount (expressed in the given currency)" - }, - "taxIncludedAmount": { - "type": "number", - "format": "float", - "description": "All taxes included amount (expressed in the given currency)" - }, - "settlementMethod": { - "$ref": "SettlementMethod.schema.json#SettlementMethod" - }, - "settlementNoteImage": { - "$ref": "SettlementNoteImage.schema.json#SettlementNoteImage" - }, - "receiver": { - "$ref": "../EngagedParty/PartyRef.schema.json#PartyRef" - }, - "taxItem": { - "type": "array", - "items": { - "$ref": "TaxItem.schema.json#TaxItem" - } - }, - "issuer": { - "$ref": "../EngagedParty/PartyRef.schema.json#PartyRef" - }, - "settlementNoteItem": { - "type": "array", - "items": { - "$ref": "SettlementNoteItem.schema.json#SettlementNoteItem" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SettlementNoteAdvice.schema.json", + "title": "SettlementNoteAdvice", + "definitions": { + "SettlementNoteAdvice": { + "$id": "#SettlementNoteAdvice", + "description": "The settlement is about transferring money receiving by a CSP to a partner. The settlement is notified to the partner with a settlement note advice containing details in settlement lines.", + "type": "object", + "properties": { + "currencyCode": { + "type": "string", + "description": "A string used as a code for specifying the currency associated to the given amounts. The ISO4217 norm uses 3 letters to define the currency (for example USD for US dollar or EUR for Euro)." + }, + "date": { + "type": "string", + "format": "date-time", + "description": "Creation date of the settlement note advice" + }, + "description": { + "type": "string", + "description": "A free description text" + }, + "href": { + "type": "string", + "description": "Reference of the settlement note advice" + }, + "id": { + "type": "string", + "description": "A unique identifier for the settlement note advice" + }, + "issuerTaxRegistration": { + "type": "string", + "description": "Tax registration number of the issuer" + }, + "paymentDueDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the due amount should have been paid to the partner" + }, + "receiverTaxRegistration": { + "type": "string", + "description": "Tax registration number of the receiver" + }, + "taxDate": { + "type": "string", + "format": "date-time", + "description": "Date of the tax" + }, + "taxExcludedAmount": { + "type": "number", + "format": "float", + "description": "All taxes excluded amount (expressed in the given currency)" + }, + "taxIncludedAmount": { + "type": "number", + "format": "float", + "description": "All taxes included amount (expressed in the given currency)" + }, + "settlementMethod": { + "$ref": "../Customer/SettlementMethod.schema.json#SettlementMethod" + }, + "settlementNoteImage": { + "$ref": "../Customer/SettlementNoteImage.schema.json#SettlementNoteImage" + }, + "receiver": { + "$ref": "../EngagedParty/PartyRef.schema.json#PartyRef" + }, + "taxItem": { + "type": "array", + "items": { + "$ref": "../Customer/TaxItem.schema.json#TaxItem" + } + }, + "issuer": { + "$ref": "../EngagedParty/PartyRef.schema.json#PartyRef" + }, + "settlementNoteItem": { + "type": "array", + "items": { + "$ref": "../Customer/SettlementNoteItem.schema.json#SettlementNoteItem" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/SettlementNoteImage.schema.json b/Customer/SettlementNoteImage.schema.json index 5eb0481d..df987fe0 100644 --- a/Customer/SettlementNoteImage.schema.json +++ b/Customer/SettlementNoteImage.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SettlementNoteImage.schema.json", - "title": "SettlementNoteImage", - "definitions": { - "SettlementNoteImage": { - "$id": "#SettlementNoteImage", - "description": "Is the image of the settlement note", - "type": "object", - "properties": { - "imageFileName": { - "type": "string", - "description": "The name of the file in which the settlement note image is saved." - }, - "imageFileURL": { - "type": "string", - "description": "The URL of the settlement note image" - }, - "imageFormat": { - "type": "string", - "description": "The format of the settlement note image (csv, pdf, xls, txt...)" - }, - "imageSize": { - "type": "integer", - "description": "The size of the settlement note image (in bytes)" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SettlementNoteImage.schema.json", + "title": "SettlementNoteImage", + "definitions": { + "SettlementNoteImage": { + "$id": "#SettlementNoteImage", + "description": "Is the image of the settlement note", + "type": "object", + "properties": { + "imageFileName": { + "type": "string", + "description": "The name of the file in which the settlement note image is saved." + }, + "imageFileURL": { + "type": "string", + "description": "The URL of the settlement note image" + }, + "imageFormat": { + "type": "string", + "description": "The format of the settlement note image (csv, pdf, xls, txt...)" + }, + "imageSize": { + "type": "integer", + "description": "The size of the settlement note image (in bytes)" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/SettlementNoteItem.schema.json b/Customer/SettlementNoteItem.schema.json index a186a1f9..c73765a6 100644 --- a/Customer/SettlementNoteItem.schema.json +++ b/Customer/SettlementNoteItem.schema.json @@ -1,59 +1,59 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SettlementNoteItem.schema.json", - "title": "SettlementNoteItem", - "definitions": { - "SettlementNoteItem": { - "$id": "#SettlementNoteItem", - "description": "Concerns a product identified by its catalogue reference. It could also follow a period delimited by a start and an end date.", - "type": "object", - "properties": { - "itemId": { - "type": "string", - "description": "Unique identifier of the settlement note item" - }, - "itemLabel": { - "type": "string", - "description": "A free description text for the settlement note item" - }, - "itemNumber": { - "type": "string", - "description": "Unique number assigned to the settlement note item" - }, - "period": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - }, - "quantity": { - "type": "integer", - "description": "Quantity" - }, - "taxExcludedAmount": { - "type": "number", - "format": "float", - "description": "Tax excluded amount equal to quantity * taxExcludedUnitPrice" - }, - "taxExcludedUnitPrice": { - "type": "number", - "format": "float", - "description": "Tax excluded unit price to be applied on the given quantity" - }, - "taxIncludedAmount": { - "type": "number", - "format": "float", - "description": "All taxes included amount equal to taxExcludedAmount + taxAmount" - }, - "taxItem": { - "type": "array", - "items": { - "$ref": "TaxItem.schema.json#TaxItem" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SettlementNoteItem.schema.json", + "title": "SettlementNoteItem", + "definitions": { + "SettlementNoteItem": { + "$id": "#SettlementNoteItem", + "description": "Concerns a product identified by its catalogue reference. It could also follow a period delimited by a start and an end date.", + "type": "object", + "properties": { + "itemId": { + "type": "string", + "description": "Unique identifier of the settlement note item" + }, + "itemLabel": { + "type": "string", + "description": "A free description text for the settlement note item" + }, + "itemNumber": { + "type": "string", + "description": "Unique number assigned to the settlement note item" + }, + "period": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + }, + "quantity": { + "type": "integer", + "description": "Quantity" + }, + "taxExcludedAmount": { + "type": "number", + "format": "float", + "description": "Tax excluded amount equal to quantity * taxExcludedUnitPrice" + }, + "taxExcludedUnitPrice": { + "type": "number", + "format": "float", + "description": "Tax excluded unit price to be applied on the given quantity" + }, + "taxIncludedAmount": { + "type": "number", + "format": "float", + "description": "All taxes included amount equal to taxExcludedAmount + taxAmount" + }, + "taxItem": { + "type": "array", + "items": { + "$ref": "../Customer/TaxItem.schema.json#TaxItem" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/ShoppingCart.schema.json b/Customer/ShoppingCart.schema.json index be4a61fe..0595efd4 100644 --- a/Customer/ShoppingCart.schema.json +++ b/Customer/ShoppingCart.schema.json @@ -1,56 +1,56 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ShoppingCart.schema.json", - "title": "ShoppingCart", - "definitions": { - "ShoppingCart": { - "$id": "#ShoppingCart", - "description": "Shopping Cart resource is used for the temporarily selection and reservation of product offerings in e-commerce, call center and retail purchase. Shopping cart supports purchase of both physical and digital goods and service (e.g. handset, telecom network service). Shopping Cart contain list of cart items, a reference to customer (partyRole) or contact medium in case customer not exist, and the total items price including promotions", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink to access the shopping cart" - }, - "id": { - "type": "string", - "description": "Unique identifier created on provider side (e.g. Order Capture system)" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the shopping cart is valid (e.g. 90 if no activity or 7 days if cart is empty)" - }, - "contactMedium": { - "type": "array", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - }, - "cartTotalPrice": { - "type": "array", - "items": { - "$ref": "CartPrice.schema.json#CartPrice" - }, - "description": "Total amount of the shopping cart, usually of money, that represents the actual price paid by the Customer for cart (considering only \"Active\" cart items)" - }, - "cartItem": { - "type": "array", - "items": { - "$ref": "CartItem.schema.json#CartItem" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ShoppingCart.schema.json", + "title": "ShoppingCart", + "definitions": { + "ShoppingCart": { + "$id": "#ShoppingCart", + "description": "Shopping Cart resource is used for the temporarily selection and reservation of product offerings in e-commerce, call center and retail purchase. Shopping cart supports purchase of both physical and digital goods and service (e.g. handset, telecom network service). Shopping Cart contain list of cart items, a reference to customer (partyRole) or contact medium in case customer not exist, and the total items price including promotions", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink to access the shopping cart" + }, + "id": { + "type": "string", + "description": "Unique identifier created on provider side (e.g. Order Capture system)" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the shopping cart is valid (e.g. 90 if no activity or 7 days if cart is empty)" + }, + "contactMedium": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "cartTotalPrice": { + "type": "array", + "items": { + "$ref": "../Customer/CartPrice.schema.json#CartPrice" + }, + "description": "Total amount of the shopping cart, usually of money, that represents the actual price paid by the Customer for cart (considering only \"Active\" cart items)" + }, + "cartItem": { + "type": "array", + "items": { + "$ref": "../Customer/CartItem.schema.json#CartItem" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/ShoppingCartRef.schema.json b/Customer/ShoppingCartRef.schema.json index ae0cb31c..ac14756d 100644 --- a/Customer/ShoppingCartRef.schema.json +++ b/Customer/ShoppingCartRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ShoppingCartRef.schema.json", - "title": "ShoppingCartRef", - "definitions": { - "ShoppingCartRef": { - "$id": "#ShoppingCartRef", - "description": "ShoppingCart (ShoppingCartRef) . The shopping cart which the recommendation is related with.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hypertext Reference of the shopping cart." - }, - "id": { - "type": "string", - "description": "Unique identifier of shopping cart" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ShoppingCartRef.schema.json", + "title": "ShoppingCartRef", + "definitions": { + "ShoppingCartRef": { + "$id": "#ShoppingCartRef", + "description": "ShoppingCart (ShoppingCartRef) . The shopping cart which the recommendation is related with.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hypertext Reference of the shopping cart." + }, + "id": { + "type": "string", + "description": "Unique identifier of shopping cart" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/TaxItem.schema.json b/Customer/TaxItem.schema.json index 9746c152..db5b10fc 100644 --- a/Customer/TaxItem.schema.json +++ b/Customer/TaxItem.schema.json @@ -1,32 +1,32 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaxItem.schema.json", - "title": "TaxItem", - "definitions": { - "TaxItem": { - "$id": "#TaxItem", - "description": "A tax item is created for each tax rate and tax type used in the bill.", - "type": "object", - "properties": { - "taxAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Amount of tax expressed in the given currency" - }, - "taxCategory": { - "type": "string", - "description": "Tax category" - }, - "taxRate": { - "type": "number", - "format": "float", - "description": "Applied rate of the tax" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaxItem.schema.json", + "title": "TaxItem", + "definitions": { + "TaxItem": { + "$id": "#TaxItem", + "description": "A tax item is created for each tax rate and tax type used in the bill.", + "type": "object", + "properties": { + "taxAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Amount of tax expressed in the given currency" + }, + "taxCategory": { + "type": "string", + "description": "Tax category" + }, + "taxRate": { + "type": "number", + "format": "float", + "description": "Applied rate of the tax" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/TimeSlot.schema.json b/Customer/TimeSlot.schema.json index 3f3882c9..9dbedbbb 100644 --- a/Customer/TimeSlot.schema.json +++ b/Customer/TimeSlot.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TimeSlot.schema.json", - "title": "TimeSlot", - "definitions": { - "TimeSlot": { - "$id": "#TimeSlot", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the TimeSlot" - }, - "id": { - "type": "string", - "description": "Unique identifier of the TimeSlot" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty", - "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Start date and end date of the timeSlot" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TimeSlot.schema.json", + "title": "TimeSlot", + "definitions": { + "TimeSlot": { + "$id": "#TimeSlot", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the TimeSlot" + }, + "id": { + "type": "string", + "description": "Unique identifier of the TimeSlot" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty", + "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Start date and end date of the timeSlot" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/TokenizedCardDetails.schema.json b/Customer/TokenizedCardDetails.schema.json index d0fd9176..8dc569c0 100644 --- a/Customer/TokenizedCardDetails.schema.json +++ b/Customer/TokenizedCardDetails.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TokenizedCardDetails.schema.json", - "title": "TokenizedCardDetails", - "definitions": { - "TokenizedCardDetails": { - "$id": "#TokenizedCardDetails", - "description": "Detailed information for a stored tokenized card", - "type": "object", - "properties": { - "brand": { - "type": "string", - "description": "Card brand. Might be used for display purposes" - }, - "issuer": { - "type": "string", - "description": "Whoever issued the token" - }, - "lastFourDigits": { - "type": "string", - "description": "Last four digits of the credit card. Might be used for display purposes" - }, - "token": { - "type": "string", - "description": "The token itself" - }, - "tokenType": { - "type": "string", - "description": "Token type (e.g.: emv)" - }, - "cardType": { - "type": "string", - "description": "Card type. Might be used for display purposes" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TokenizedCardDetails.schema.json", + "title": "TokenizedCardDetails", + "definitions": { + "TokenizedCardDetails": { + "$id": "#TokenizedCardDetails", + "description": "Detailed information for a stored tokenized card", + "type": "object", + "properties": { + "brand": { + "type": "string", + "description": "Card brand. Might be used for display purposes" + }, + "issuer": { + "type": "string", + "description": "Whoever issued the token" + }, + "lastFourDigits": { + "type": "string", + "description": "Last four digits of the credit card. Might be used for display purposes" + }, + "token": { + "type": "string", + "description": "The token itself" + }, + "tokenType": { + "type": "string", + "description": "Token type (e.g.: emv)" + }, + "cardType": { + "type": "string", + "description": "Card type. Might be used for display purposes" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/TokenizedCardMethod.schema.json b/Customer/TokenizedCardMethod.schema.json index 44a99bbb..225a872b 100644 --- a/Customer/TokenizedCardMethod.schema.json +++ b/Customer/TokenizedCardMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TokenizedCardMethod.schema.json", - "title": "TokenizedCardMethod", - "definitions": { - "TokenizedCardMethod": { - "$id": "#TokenizedCardMethod", - "type": "object", - "properties": { - "details": { - "$ref": "TokenizedCardDetails.schema.json#TokenizedCardDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TokenizedCardMethod.schema.json", + "title": "TokenizedCardMethod", + "definitions": { + "TokenizedCardMethod": { + "$id": "#TokenizedCardMethod", + "type": "object", + "properties": { + "details": { + "$ref": "../Customer/TokenizedCardDetails.schema.json#TokenizedCardDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/VoucherDetails.schema.json b/Customer/VoucherDetails.schema.json index 35d239bd..f0e037d0 100644 --- a/Customer/VoucherDetails.schema.json +++ b/Customer/VoucherDetails.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "VoucherDetails.schema.json", - "title": "VoucherDetails", - "definitions": { - "VoucherDetails": { - "$id": "#VoucherDetails", - "description": "Detailed information of a voucher", - "type": "object", - "properties": { - "campaign": { - "type": "string", - "description": "Campaign this voucher belongs to" - }, - "code": { - "type": "string", - "description": "Code that identifies the voucher" - }, - "expirationDate": { - "type": "string", - "format": "date-time", - "description": "The vouchers expiration date" - }, - "value": { - "type": "number", - "format": "float", - "description": "Discount that the voucher applies when it is a discount" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "VoucherDetails.schema.json", + "title": "VoucherDetails", + "definitions": { + "VoucherDetails": { + "$id": "#VoucherDetails", + "description": "Detailed information of a voucher", + "type": "object", + "properties": { + "campaign": { + "type": "string", + "description": "Campaign this voucher belongs to" + }, + "code": { + "type": "string", + "description": "Code that identifies the voucher" + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "The vouchers expiration date" + }, + "value": { + "type": "number", + "format": "float", + "description": "Discount that the voucher applies when it is a discount" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Customer/VoucherMethod.schema.json b/Customer/VoucherMethod.schema.json index 8ca3fce0..0851b939 100644 --- a/Customer/VoucherMethod.schema.json +++ b/Customer/VoucherMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "VoucherMethod.schema.json", - "title": "VoucherMethod", - "definitions": { - "VoucherMethod": { - "$id": "#VoucherMethod", - "type": "object", - "properties": { - "details": { - "$ref": "VoucherDetails.schema.json#VoucherDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "VoucherMethod.schema.json", + "title": "VoucherMethod", + "definitions": { + "VoucherMethod": { + "$id": "#VoucherMethod", + "type": "object", + "properties": { + "details": { + "$ref": "../Customer/VoucherDetails.schema.json#VoucherDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/Account.schema.json b/EngagedParty/Account.schema.json index 76024c2e..11565ef2 100644 --- a/EngagedParty/Account.schema.json +++ b/EngagedParty/Account.schema.json @@ -1,85 +1,85 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Account.schema.json", - "title": "Account", - "definitions": { - "Account": { - "$id": "#Account", - "description": "Generic Account structure used to define commonalities between sub concepts of PartyAccount and Financial Account.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "creditLimit": { - "$ref": "../Common/Money.schema.json#Money", - "description": "The maximum amount of money that may be charged on an account" - }, - "description": { - "type": "string", - "description": "Detailed description of the party account" - }, - "href": { - "type": "string", - "description": "Unique reference of the account" - }, - "id": { - "type": "string", - "description": "Unique identifier of the account" - }, - "lastModified": { - "type": "string", - "format": "date-time", - "description": "Date of last modification of the account" - }, - "name": { - "type": "string", - "description": "Name of the account" - }, - "state": { - "type": "string", - "description": "Contains the lifecycle state such as: Active, Closed, Suspended and so on." - }, - "accountType": { - "type": "string", - "description": "A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values." - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "taxExemption": { - "type": "array", - "items": { - "$ref": "AccountTaxExemption.schema.json#AccountTaxExemption" - } - }, - "contact": { - "type": "array", - "items": { - "$ref": "Contact.schema.json#Contact" - } - }, - "accountBalance": { - "type": "array", - "items": { - "$ref": "AccountBalance.schema.json#AccountBalance" - } - }, - "accountRelationship": { - "type": "array", - "items": { - "$ref": "AccountRelationship.schema.json#AccountRelationship" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Account.schema.json", + "title": "Account", + "definitions": { + "Account": { + "$id": "#Account", + "description": "Generic Account structure used to define commonalities between sub concepts of PartyAccount and Financial Account.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "creditLimit": { + "$ref": "../Common/Money.schema.json#Money", + "description": "The maximum amount of money that may be charged on an account" + }, + "description": { + "type": "string", + "description": "Detailed description of the party account" + }, + "href": { + "type": "string", + "description": "Unique reference of the account" + }, + "id": { + "type": "string", + "description": "Unique identifier of the account" + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "Date of last modification of the account" + }, + "name": { + "type": "string", + "description": "Name of the account" + }, + "state": { + "type": "string", + "description": "Contains the lifecycle state such as: Active, Closed, Suspended and so on." + }, + "accountType": { + "type": "string", + "description": "A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values." + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "taxExemption": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountTaxExemption.schema.json#AccountTaxExemption" + } + }, + "contact": { + "type": "array", + "items": { + "$ref": "../EngagedParty/Contact.schema.json#Contact" + } + }, + "accountBalance": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountBalance.schema.json#AccountBalance" + } + }, + "accountRelationship": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRelationship.schema.json#AccountRelationship" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/AccountBalance.schema.json b/EngagedParty/AccountBalance.schema.json index 44e9e2ff..b952bce8 100644 --- a/EngagedParty/AccountBalance.schema.json +++ b/EngagedParty/AccountBalance.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountBalance.schema.json", - "title": "AccountBalance", - "definitions": { - "AccountBalance": { - "$id": "#AccountBalance", - "description": "Balances linked to the account", - "type": "object", - "required": [ - "amount", - "balanceType", - "validFor" - ], - "properties": { - "amount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Balance amount" - }, - "balanceType": { - "type": "string", - "description": "Type of the balance : deposit balance, disputed balance, loyalty balance, receivable balance..." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Balance validity period" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountBalance.schema.json", + "title": "AccountBalance", + "definitions": { + "AccountBalance": { + "$id": "#AccountBalance", + "description": "Balances linked to the account", + "type": "object", + "required": [ + "amount", + "balanceType", + "validFor" + ], + "properties": { + "amount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Balance amount" + }, + "balanceType": { + "type": "string", + "description": "Type of the balance : deposit balance, disputed balance, loyalty balance, receivable balance..." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Balance validity period" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/AccountBalanceRef.schema.json b/EngagedParty/AccountBalanceRef.schema.json index 0cb4bab3..b3a37e6b 100644 --- a/EngagedParty/AccountBalanceRef.schema.json +++ b/EngagedParty/AccountBalanceRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountBalanceRef.schema.json", - "title": "AccountBalanceRef", - "definitions": { - "AccountBalanceRef": { - "$id": "#AccountBalanceRef", - "description": "Balances linked to the account", - "type": "object", - "properties": { - "amount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Balance amount" - }, - "status": { - "type": "string", - "description": "The condition of the account balance, such as due, paid, in arrears." - }, - "balanceType": { - "type": "string", - "description": "Type of the balance : deposit balance, disputed balance, loyalty balance, receivable balance..." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountBalanceRef.schema.json", + "title": "AccountBalanceRef", + "definitions": { + "AccountBalanceRef": { + "$id": "#AccountBalanceRef", + "description": "Balances linked to the account", + "type": "object", + "properties": { + "amount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Balance amount" + }, + "status": { + "type": "string", + "description": "The condition of the account balance, such as due, paid, in arrears." + }, + "balanceType": { + "type": "string", + "description": "Type of the balance : deposit balance, disputed balance, loyalty balance, receivable balance..." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/AccountDirectDetails.schema.json b/EngagedParty/AccountDirectDetails.schema.json index 084a6152..5e64c062 100644 --- a/EngagedParty/AccountDirectDetails.schema.json +++ b/EngagedParty/AccountDirectDetails.schema.json @@ -1,21 +1,21 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountDirectDetails.schema.json", - "title": "AccountDirectDetails", - "definitions": { - "AccountDirectDetails": { - "$id": "#AccountDirectDetails", - "type": "object", - "properties": { - "account": { - "$ref": "AccountRef.schema.json#AccountRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountDirectDetails.schema.json", + "title": "AccountDirectDetails", + "definitions": { + "AccountDirectDetails": { + "$id": "#AccountDirectDetails", + "type": "object", + "properties": { + "account": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/AccountDirectMethod.schema.json b/EngagedParty/AccountDirectMethod.schema.json index 95760bb8..fdbad68f 100644 --- a/EngagedParty/AccountDirectMethod.schema.json +++ b/EngagedParty/AccountDirectMethod.schema.json @@ -1,62 +1,62 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountDirectMethod.schema.json", - "title": "AccountDirectMethod", - "definitions": { - "AccountDirectMethod": { - "$id": "#AccountDirectMethod", - "description": "A payment method using an internal account that could be billed directly to perform the payment", - "type": "object", - "properties": { - "details": { - "$ref": "AccountRef.schema.json#AccountRef" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "AccountRef.schema.json#AccountRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountDirectMethod.schema.json", + "title": "AccountDirectMethod", + "definitions": { + "AccountDirectMethod": { + "$id": "#AccountDirectMethod", + "description": "A payment method using an internal account that could be billed directly to perform the payment", + "type": "object", + "properties": { + "details": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/AccountRef.schema.json b/EngagedParty/AccountRef.schema.json index 43a5255f..c58e902a 100644 --- a/EngagedParty/AccountRef.schema.json +++ b/EngagedParty/AccountRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountRef.schema.json", - "title": "AccountRef", - "definitions": { - "AccountRef": { - "$id": "#AccountRef", - "description": "Account reference. A account may be a party account or a financial account.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Detailed description of the account" - }, - "href": { - "type": "string", - "description": "Reference of the account" - }, - "id": { - "type": "string", - "description": "Unique identifier of the account" - }, - "name": { - "type": "string", - "description": "Name of the account" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountRef.schema.json", + "title": "AccountRef", + "definitions": { + "AccountRef": { + "$id": "#AccountRef", + "description": "Account reference. A account may be a party account or a financial account.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Detailed description of the account" + }, + "href": { + "type": "string", + "description": "Reference of the account" + }, + "id": { + "type": "string", + "description": "Unique identifier of the account" + }, + "name": { + "type": "string", + "description": "Name of the account" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/AccountRelationship.schema.json b/EngagedParty/AccountRelationship.schema.json index ce677a9d..40a030b6 100644 --- a/EngagedParty/AccountRelationship.schema.json +++ b/EngagedParty/AccountRelationship.schema.json @@ -1,33 +1,33 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountRelationship.schema.json", - "title": "AccountRelationship", - "definitions": { - "AccountRelationship": { - "$id": "#AccountRelationship", - "description": "Significant connection between accounts. For instance an aggregating account for a list of shop branches each having its own billing account.", - "type": "object", - "required": [ - "relationshipType" - ], - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of relationship" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Validity period of that relationship" - }, - "account": { - "$ref": "AccountRef.schema.json#AccountRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountRelationship.schema.json", + "title": "AccountRelationship", + "definitions": { + "AccountRelationship": { + "$id": "#AccountRelationship", + "description": "Significant connection between accounts. For instance an aggregating account for a list of shop branches each having its own billing account.", + "type": "object", + "required": [ + "relationshipType" + ], + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of relationship" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Validity period of that relationship" + }, + "account": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/AccountTaxExemption.schema.json b/EngagedParty/AccountTaxExemption.schema.json index 0fff03bb..86344563 100644 --- a/EngagedParty/AccountTaxExemption.schema.json +++ b/EngagedParty/AccountTaxExemption.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AccountTaxExemption.schema.json", - "title": "AccountTaxExemption", - "definitions": { - "AccountTaxExemption": { - "$id": "#AccountTaxExemption", - "description": "Proof of freedom from taxes imposed by a taxing jurisdiction", - "type": "object", - "required": [ - "issuingJurisdiction", - "validFor" - ], - "properties": { - "certificateNumber": { - "type": "string", - "description": "Identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction" - }, - "issuingJurisdiction": { - "type": "string", - "description": "Name of the taxing jurisdiction for which taxes are exempt" - }, - "reason": { - "type": "string", - "description": "Reason of the tax exemption" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Period for which the exemption is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AccountTaxExemption.schema.json", + "title": "AccountTaxExemption", + "definitions": { + "AccountTaxExemption": { + "$id": "#AccountTaxExemption", + "description": "Proof of freedom from taxes imposed by a taxing jurisdiction", + "type": "object", + "required": [ + "issuingJurisdiction", + "validFor" + ], + "properties": { + "certificateNumber": { + "type": "string", + "description": "Identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction" + }, + "issuingJurisdiction": { + "type": "string", + "description": "Name of the taxing jurisdiction for which taxes are exempt" + }, + "reason": { + "type": "string", + "description": "Reason of the tax exemption" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Period for which the exemption is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/Agreement.schema.json b/EngagedParty/Agreement.schema.json index f5562f6e..d2f5e828 100644 --- a/EngagedParty/Agreement.schema.json +++ b/EngagedParty/Agreement.schema.json @@ -1,108 +1,108 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Agreement.schema.json", - "title": "Agreement", - "definitions": { - "Agreement": { - "$id": "#Agreement", - "description": "An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", - "type": "object", - "required": [ - "name", - "agreementType", - "engagedPartyRole", - "agreementItem" - ], - "properties": { - "agreementPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The time period during which the Agreement is in effect." - }, - "completionDate": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date at which the agreement is completed" - }, - "description": { - "type": "string", - "description": "Narrative that explains the agreement and details about the it , such as why the agreement is taking place." - }, - "documentNumber": { - "type": "integer", - "description": "A reference number assigned to an Agreement that follows a prescribed numbering system." - }, - "href": { - "type": "string", - "description": "Unique url identifying the agreement as a resource" - }, - "id": { - "type": "string", - "description": "Unique identifier for the agreement" - }, - "initialDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the agreement was initialized" - }, - "name": { - "type": "string", - "description": "A human-readable name for the agreement" - }, - "statementOfIntent": { - "type": "string", - "description": "An overview and goals of the Agreement" - }, - "status": { - "type": "string", - "description": "The current status of the agreement. Typical values are: in process, approved and rejected" - }, - "agreementType": { - "type": "string", - "description": "The type of the agreement. For example commercial" - }, - "version": { - "type": "string", - "description": "A string identifying the version of the agreement" - }, - "agreementSpecification": { - "$ref": "AgreementSpecificationRef.schema.json#AgreementSpecificationRef" - }, - "agreementItem": { - "type": "array", - "items": { - "$ref": "AgreementItem.schema.json#AgreementItem" - }, - "minItems": 1 - }, - "engagedPartyRole": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "agreementAuthorization": { - "type": "array", - "items": { - "$ref": "AgreementAuthorization.schema.json#AgreementAuthorization" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - } - }, - "associatedAgreement": { - "type": "array", - "items": { - "$ref": "AgreementRef.schema.json#AgreementRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Agreement.schema.json", + "title": "Agreement", + "definitions": { + "Agreement": { + "$id": "#Agreement", + "description": "An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", + "type": "object", + "required": [ + "name", + "agreementType", + "engagedPartyRole", + "agreementItem" + ], + "properties": { + "agreementPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The time period during which the Agreement is in effect." + }, + "completionDate": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date at which the agreement is completed" + }, + "description": { + "type": "string", + "description": "Narrative that explains the agreement and details about the it , such as why the agreement is taking place." + }, + "documentNumber": { + "type": "integer", + "description": "A reference number assigned to an Agreement that follows a prescribed numbering system." + }, + "href": { + "type": "string", + "description": "Unique url identifying the agreement as a resource" + }, + "id": { + "type": "string", + "description": "Unique identifier for the agreement" + }, + "initialDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the agreement was initialized" + }, + "name": { + "type": "string", + "description": "A human-readable name for the agreement" + }, + "statementOfIntent": { + "type": "string", + "description": "An overview and goals of the Agreement" + }, + "status": { + "type": "string", + "description": "The current status of the agreement. Typical values are: in process, approved and rejected" + }, + "agreementType": { + "type": "string", + "description": "The type of the agreement. For example commercial" + }, + "version": { + "type": "string", + "description": "A string identifying the version of the agreement" + }, + "agreementSpecification": { + "$ref": "../EngagedParty/AgreementSpecificationRef.schema.json#AgreementSpecificationRef" + }, + "agreementItem": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementItem.schema.json#AgreementItem" + }, + "minItems": 1 + }, + "engagedPartyRole": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "agreementAuthorization": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementAuthorization.schema.json#AgreementAuthorization" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "associatedAgreement": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/AgreementAttachment.schema.json b/EngagedParty/AgreementAttachment.schema.json index 5de6ee64..afd3660e 100644 --- a/EngagedParty/AgreementAttachment.schema.json +++ b/EngagedParty/AgreementAttachment.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementAttachment.schema.json", - "title": "AgreementAttachment", - "definitions": { - "AgreementAttachment": { - "$id": "#AgreementAttachment", - "description": "Represents a complementary piece of information to describe the agreement. Could be a document, picture, a video or any kind of multimedia content.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the attachment" - }, - "id": { - "type": "string", - "description": "Unique identifier of the attachment" - }, - "attachmentType": { - "type": "string", - "description": "The type of attachment, such as video, picture" - }, - "url": { - "type": "string", - "format": "uri", - "description": "Uniform Resource Locator, is a web page address (a subset of URI)" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementAttachment.schema.json", + "title": "AgreementAttachment", + "definitions": { + "AgreementAttachment": { + "$id": "#AgreementAttachment", + "description": "Represents a complementary piece of information to describe the agreement. Could be a document, picture, a video or any kind of multimedia content.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the attachment" + }, + "id": { + "type": "string", + "description": "Unique identifier of the attachment" + }, + "attachmentType": { + "type": "string", + "description": "The type of attachment, such as video, picture" + }, + "url": { + "type": "string", + "format": "uri", + "description": "Uniform Resource Locator, is a web page address (a subset of URI)" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/AgreementAuthorization.schema.json b/EngagedParty/AgreementAuthorization.schema.json index 4e54b742..6dd07f7e 100644 --- a/EngagedParty/AgreementAuthorization.schema.json +++ b/EngagedParty/AgreementAuthorization.schema.json @@ -1,32 +1,32 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementAuthorization.schema.json", - "title": "AgreementAuthorization", - "definitions": { - "AgreementAuthorization": { - "$id": "#AgreementAuthorization", - "description": "A business participant that is responsible for approving the agreement.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time", - "description": "The date associated with the authorization state." - }, - "signatureRepresentation": { - "type": "string", - "description": "Indication that represents whether the signature is a physical paper signature or a digital signature." - }, - "state": { - "type": "string", - "description": "Current status of the authorization, for example in process, approved, rejected." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementAuthorization.schema.json", + "title": "AgreementAuthorization", + "definitions": { + "AgreementAuthorization": { + "$id": "#AgreementAuthorization", + "description": "A business participant that is responsible for approving the agreement.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "The date associated with the authorization state." + }, + "signatureRepresentation": { + "type": "string", + "description": "Indication that represents whether the signature is a physical paper signature or a digital signature." + }, + "state": { + "type": "string", + "description": "Current status of the authorization, for example in process, approved, rejected." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/AgreementItem.schema.json b/EngagedParty/AgreementItem.schema.json index 510ac476..d73143e9 100644 --- a/EngagedParty/AgreementItem.schema.json +++ b/EngagedParty/AgreementItem.schema.json @@ -1,31 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementItem.schema.json", - "title": "AgreementItem", - "definitions": { - "AgreementItem": { - "$id": "#AgreementItem", - "description": "A part of the agreement expressed in terms of a product offering and possibly including specific terms and conditions.", - "type": "object", - "properties": { - "productOffering": { - "type": "array", - "items": { - "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" - } - }, - "termOrCondition": { - "type": "array", - "items": { - "$ref": "AgreementTermOrCondition.schema.json#AgreementTermOrCondition" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementItem.schema.json", + "title": "AgreementItem", + "definitions": { + "AgreementItem": { + "$id": "#AgreementItem", + "description": "A part of the agreement expressed in terms of a product offering and possibly including specific terms and conditions.", + "type": "object", + "properties": { + "productOffering": { + "description": "The list of product offerings referred by this agreement item", + "type": "array", + "items": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + } + }, + "termOrCondition": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementTermOrCondition.schema.json#AgreementTermOrCondition" + } + }, + "product": { + "description": "The list of products indirectly referred by this agreement item (since an agreement item refers primarily to product offerings)", + "type": "array", + "items": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/AgreementItemRef.schema.json b/EngagedParty/AgreementItemRef.schema.json index c9c378fd..3adfcb8c 100644 --- a/EngagedParty/AgreementItemRef.schema.json +++ b/EngagedParty/AgreementItemRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementItemRef.schema.json", - "title": "AgreementItemRef", - "definitions": { - "AgreementItemRef": { - "$id": "#AgreementItemRef", - "description": "Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", - "type": "object", - "properties": { - "agreementItemId": { - "type": "string", - "description": "Identifier of the agreement" - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementItemRef.schema.json", + "title": "AgreementItemRef", + "definitions": { + "AgreementItemRef": { + "$id": "#AgreementItemRef", + "description": "Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", + "type": "object", + "properties": { + "agreementItemId": { + "type": "string", + "description": "Identifier of the agreement" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/AgreementRef.schema.json b/EngagedParty/AgreementRef.schema.json index b819cd45..aa385b79 100644 --- a/EngagedParty/AgreementRef.schema.json +++ b/EngagedParty/AgreementRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementRef.schema.json", - "title": "AgreementRef", - "definitions": { - "AgreementRef": { - "$id": "#AgreementRef", - "description": "Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the agreement" - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementRef.schema.json", + "title": "AgreementRef", + "definitions": { + "AgreementRef": { + "$id": "#AgreementRef", + "description": "Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the agreement" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/AgreementSpecCharacteristic.schema.json b/EngagedParty/AgreementSpecCharacteristic.schema.json index 2c3a664c..c3b20f71 100644 --- a/EngagedParty/AgreementSpecCharacteristic.schema.json +++ b/EngagedParty/AgreementSpecCharacteristic.schema.json @@ -1,45 +1,45 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementSpecCharacteristic.schema.json", - "title": "AgreementSpecCharacteristic", - "definitions": { - "AgreementSpecCharacteristic": { - "$id": "#AgreementSpecCharacteristic", - "description": "A characteristic quality or distinctive feature of an agreement.", - "type": "object", - "properties": { - "configurable": { - "type": "boolean", - "description": "If true, the Boolean indicates that the characteristic is configurable" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the characteristic is" - }, - "name": { - "type": "string", - "description": "Name of the characteristic being specified." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the specification characteristic is valid" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" - }, - "specCharacteristicValue": { - "type": "array", - "items": { - "$ref": "AgreementSpecCharacteristicValue.schema.json#AgreementSpecCharacteristicValue" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementSpecCharacteristic.schema.json", + "title": "AgreementSpecCharacteristic", + "definitions": { + "AgreementSpecCharacteristic": { + "$id": "#AgreementSpecCharacteristic", + "description": "A characteristic quality or distinctive feature of an agreement.", + "type": "object", + "properties": { + "configurable": { + "type": "boolean", + "description": "If true, the Boolean indicates that the characteristic is configurable" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the characteristic is" + }, + "name": { + "type": "string", + "description": "Name of the characteristic being specified." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the specification characteristic is valid" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" + }, + "specCharacteristicValue": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementSpecCharacteristicValue.schema.json#AgreementSpecCharacteristicValue" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/AgreementSpecCharacteristicValue.schema.json b/EngagedParty/AgreementSpecCharacteristicValue.schema.json index 79d48cb5..e5b31c5a 100644 --- a/EngagedParty/AgreementSpecCharacteristicValue.schema.json +++ b/EngagedParty/AgreementSpecCharacteristicValue.schema.json @@ -1,47 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementSpecCharacteristicValue.schema.json", - "title": "AgreementSpecCharacteristicValue", - "definitions": { - "AgreementSpecCharacteristicValue": { - "$id": "#AgreementSpecCharacteristicValue", - "description": "A number or text that can be assigned to an agreement specification characteristic.", - "type": "object", - "properties": { - "default": { - "type": "boolean", - "description": "Indicates if the value is the default value for a characteristic" - }, - "unitOfMeasure": { - "type": "string", - "description": "Unit of measure for the characteristic, such as minutes, gigabytes (GB) and so on." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period of time for which a value is applicable" - }, - "value": { - "$ref": "../Common/Any.schema.json#Any", - "description": "A discrete value that the characteristic can take on" - }, - "valueFrom": { - "type": "string", - "description": "The low range value that a characteristic can take on" - }, - "valueTo": { - "type": "string", - "description": "The upper range value that a characteristic can take on" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementSpecCharacteristicValue.schema.json", + "title": "AgreementSpecCharacteristicValue", + "definitions": { + "AgreementSpecCharacteristicValue": { + "$id": "#AgreementSpecCharacteristicValue", + "description": "A number or text that can be assigned to an agreement specification characteristic.", + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Indicates if the value is the default value for a characteristic" + }, + "unitOfMeasure": { + "type": "string", + "description": "Unit of measure for the characteristic, such as minutes, gigabytes (GB) and so on." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period of time for which a value is applicable" + }, + "value": { + "$ref": "../Common/Any.schema.json#Any", + "description": "A discrete value that the characteristic can take on" + }, + "valueFrom": { + "type": "string", + "description": "The low range value that a characteristic can take on" + }, + "valueTo": { + "type": "string", + "description": "The upper range value that a characteristic can take on" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/AgreementSpecification.schema.json b/EngagedParty/AgreementSpecification.schema.json index e3115422..e0dbf6b7 100644 --- a/EngagedParty/AgreementSpecification.schema.json +++ b/EngagedParty/AgreementSpecification.schema.json @@ -1,87 +1,87 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementSpecification.schema.json", - "title": "AgreementSpecification", - "definitions": { - "AgreementSpecification": { - "$id": "#AgreementSpecification", - "description": "A template of an agreement that can be used when establishing partnerships", - "type": "object", - "required": [ - "name", - "attachment" - ], - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail what the agreement specification is about" - }, - "href": { - "type": "string", - "description": "Reference of the agreement specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the agreement specification" - }, - "isBundle": { - "type": "boolean", - "description": "If true, this agreement specification is a grouping of other agreement specifications. The list of bundled agreement specifications is provided by the specificationRelationship property" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Indicates the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the agreement specification" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the agreement specification is valid" - }, - "version": { - "type": "string", - "description": "Agreement specification version" - }, - "serviceCategory": { - "$ref": "../Product/CategoryRef.schema.json#CategoryRef" - }, - "specificationCharacteristic": { - "type": "array", - "items": { - "$ref": "AgreementSpecCharacteristic.schema.json#AgreementSpecCharacteristic" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "attachment": { - "type": "array", - "items": { - "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" - } - }, - "specificationRelationship": { - "type": "array", - "items": { - "$ref": "AgreementSpecificationRelationship.schema.json#AgreementSpecificationRelationship" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementSpecification.schema.json", + "title": "AgreementSpecification", + "definitions": { + "AgreementSpecification": { + "$id": "#AgreementSpecification", + "description": "A template of an agreement that can be used when establishing partnerships", + "type": "object", + "required": [ + "name", + "attachment" + ], + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail what the agreement specification is about" + }, + "href": { + "type": "string", + "description": "Reference of the agreement specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the agreement specification" + }, + "isBundle": { + "type": "boolean", + "description": "If true, this agreement specification is a grouping of other agreement specifications. The list of bundled agreement specifications is provided by the specificationRelationship property" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Indicates the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the agreement specification" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the agreement specification is valid" + }, + "version": { + "type": "string", + "description": "Agreement specification version" + }, + "serviceCategory": { + "$ref": "../Product/CategoryRef.schema.json#CategoryRef" + }, + "specificationCharacteristic": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementSpecCharacteristic.schema.json#AgreementSpecCharacteristic" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "attachment": { + "type": "array", + "items": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + } + }, + "specificationRelationship": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementSpecificationRelationship.schema.json#AgreementSpecificationRelationship" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/AgreementSpecificationRef.schema.json b/EngagedParty/AgreementSpecificationRef.schema.json index 7f329440..273b8418 100644 --- a/EngagedParty/AgreementSpecificationRef.schema.json +++ b/EngagedParty/AgreementSpecificationRef.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementSpecificationRef.schema.json", - "title": "AgreementSpecificationRef", - "definitions": { - "AgreementSpecificationRef": { - "$id": "#AgreementSpecificationRef", - "description": "AgreementSpecification reference. An AgreementSpecification represents a template of an agreement that can be used when establishing partnerships.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail what the agreement specification is about." - }, - "name": { - "type": "string", - "description": "Name of the agreement specification" - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementSpecificationRef.schema.json", + "title": "AgreementSpecificationRef", + "definitions": { + "AgreementSpecificationRef": { + "$id": "#AgreementSpecificationRef", + "description": "AgreementSpecification reference. An AgreementSpecification represents a template of an agreement that can be used when establishing partnerships.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail what the agreement specification is about." + }, + "name": { + "type": "string", + "description": "Name of the agreement specification" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/AgreementSpecificationRelationship.schema.json b/EngagedParty/AgreementSpecificationRelationship.schema.json index 0b286ef5..2b53daa1 100644 --- a/EngagedParty/AgreementSpecificationRelationship.schema.json +++ b/EngagedParty/AgreementSpecificationRelationship.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementSpecificationRelationship.schema.json", - "title": "AgreementSpecificationRelationship", - "definitions": { - "AgreementSpecificationRelationship": { - "$id": "#AgreementSpecificationRelationship", - "description": "A relationship between agreement specifications. Typical relationships are substitution and dependency.", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of relationship such as, substitution or dependency." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the relationship is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementSpecificationRelationship.schema.json", + "title": "AgreementSpecificationRelationship", + "definitions": { + "AgreementSpecificationRelationship": { + "$id": "#AgreementSpecificationRelationship", + "description": "A relationship between agreement specifications. Typical relationships are substitution and dependency.", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of relationship such as, substitution or dependency." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the relationship is valid" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/AgreementTermOrCondition.schema.json b/EngagedParty/AgreementTermOrCondition.schema.json index 827763b9..54602f41 100644 --- a/EngagedParty/AgreementTermOrCondition.schema.json +++ b/EngagedParty/AgreementTermOrCondition.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AgreementTermOrCondition.schema.json", - "title": "AgreementTermOrCondition", - "definitions": { - "AgreementTermOrCondition": { - "$id": "#AgreementTermOrCondition", - "description": "Aspects of the agreement not formally specified elsewhere in the agreement and that cannot be captured elsewhere in a formal notation, or automatically monitored and require a more human level of management.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Text that explains the term or condition of the agreement." - }, - "id": { - "type": "string", - "description": "Unique number assigned for reference." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period of time during which the term or condition of the agreement applies." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AgreementTermOrCondition.schema.json", + "title": "AgreementTermOrCondition", + "definitions": { + "AgreementTermOrCondition": { + "$id": "#AgreementTermOrCondition", + "description": "Aspects of the agreement not formally specified elsewhere in the agreement and that cannot be captured elsewhere in a formal notation, or automatically monitored and require a more human level of management.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Text that explains the term or condition of the agreement." + }, + "id": { + "type": "string", + "description": "Unique number assigned for reference." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period of time during which the term or condition of the agreement applies." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/BankAccount.schema.json b/EngagedParty/BankAccount.schema.json index 7cde1683..145baede 100644 --- a/EngagedParty/BankAccount.schema.json +++ b/EngagedParty/BankAccount.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankAccount.schema.json", - "title": "BankAccount", - "definitions": { - "BankAccount": { - "$id": "#BankAccount", - "description": "Describes the information of a bank account", - "type": "object", - "properties": { - "accountHolder": { - "type": "string", - "description": "Name of the holder of the bank account" - }, - "BIC": { - "type": "string", - "description": "Identifier of the bank according to its international code" - }, - "domiciliation": { - "type": "string", - "description": "Address of the bank agency which manages the bank account" - }, - "IBAN": { - "type": "string", - "description": "International Bank Account Number" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankAccount.schema.json", + "title": "BankAccount", + "definitions": { + "BankAccount": { + "$id": "#BankAccount", + "description": "Describes the information of a bank account", + "type": "object", + "properties": { + "accountHolder": { + "type": "string", + "description": "Name of the holder of the bank account" + }, + "BIC": { + "type": "string", + "description": "Identifier of the bank according to its international code" + }, + "domiciliation": { + "type": "string", + "description": "Address of the bank agency which manages the bank account" + }, + "IBAN": { + "type": "string", + "description": "International Bank Account Number" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/BankAccountDebitDetails.schema.json b/EngagedParty/BankAccountDebitDetails.schema.json index ec7a991f..e3016f40 100644 --- a/EngagedParty/BankAccountDebitDetails.schema.json +++ b/EngagedParty/BankAccountDebitDetails.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankAccountDebitDetails.schema.json", - "title": "BankAccountDebitDetails", - "definitions": { - "BankAccountDebitDetails": { - "$id": "#BankAccountDebitDetails", - "description": "Detailed information for a bank account debit. Bear in mind that this could be extended to add any required authorization fields to allow recurring payments", - "type": "object", - "properties": { - "accountNumber": { - "type": "integer", - "description": "Bank Account Number (this could refer to the IBAN or SWIFT number)" - }, - "accountNumberType": { - "type": "string", - "description": "Type of account number (e.g.: IBAN, SWIFT, ...)" - }, - "BIC": { - "type": "string", - "description": "Business Identifier Code/Swift code of the financial institution where the account is located" - }, - "blank": { - "type": "string", - "description": "Display name of the bank" - }, - "owner": { - "type": "string", - "description": "Owner of the bank account" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankAccountDebitDetails.schema.json", + "title": "BankAccountDebitDetails", + "definitions": { + "BankAccountDebitDetails": { + "$id": "#BankAccountDebitDetails", + "description": "Detailed information for a bank account debit. Bear in mind that this could be extended to add any required authorization fields to allow recurring payments", + "type": "object", + "properties": { + "accountNumber": { + "type": "integer", + "description": "Bank Account Number (this could refer to the IBAN or SWIFT number)" + }, + "accountNumberType": { + "type": "string", + "description": "Type of account number (e.g.: IBAN, SWIFT, ...)" + }, + "BIC": { + "type": "string", + "description": "Business Identifier Code/Swift code of the financial institution where the account is located" + }, + "blank": { + "type": "string", + "description": "Display name of the bank" + }, + "owner": { + "type": "string", + "description": "Owner of the bank account" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/BankAccountDebitMethod.schema.json b/EngagedParty/BankAccountDebitMethod.schema.json index eae7632b..98d8bd5d 100644 --- a/EngagedParty/BankAccountDebitMethod.schema.json +++ b/EngagedParty/BankAccountDebitMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankAccountDebitMethod.schema.json", - "title": "BankAccountDebitMethod", - "definitions": { - "BankAccountDebitMethod": { - "$id": "#BankAccountDebitMethod", - "type": "object", - "properties": { - "details": { - "$ref": "BankAccountDebitDetails.schema.json#BankAccountDebitDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "AccountRef.schema.json#AccountRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankAccountDebitMethod.schema.json", + "title": "BankAccountDebitMethod", + "definitions": { + "BankAccountDebitMethod": { + "$id": "#BankAccountDebitMethod", + "type": "object", + "properties": { + "details": { + "$ref": "../EngagedParty/BankAccountDebitDetails.schema.json#BankAccountDebitDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/BankAccountTransferDetails.schema.json b/EngagedParty/BankAccountTransferDetails.schema.json index 6e46e0f9..5c3e7940 100644 --- a/EngagedParty/BankAccountTransferDetails.schema.json +++ b/EngagedParty/BankAccountTransferDetails.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankAccountTransferDetails.schema.json", - "title": "BankAccountTransferDetails", - "definitions": { - "BankAccountTransferDetails": { - "$id": "#BankAccountTransferDetails", - "description": "Detailed information for a bank account debit. Bear in mind that this could be extended to add any required authorization fields to allow recurring payments", - "type": "object", - "properties": { - "accountNumber": { - "type": "integer", - "description": "Bank Account Number (this could refer to the IBAN or SWIFT number)" - }, - "accountNumberType": { - "type": "string", - "description": "Type of account number (e.g.: IBAN, SWIFT, ...)" - }, - "BIC": { - "type": "string", - "description": "Business Identifier Code/Swift code of the financial institution where the account is located" - }, - "blank": { - "type": "string", - "description": "Display name of the bank" - }, - "owner": { - "type": "string", - "description": "Owner of the bank account" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankAccountTransferDetails.schema.json", + "title": "BankAccountTransferDetails", + "definitions": { + "BankAccountTransferDetails": { + "$id": "#BankAccountTransferDetails", + "description": "Detailed information for a bank account debit. Bear in mind that this could be extended to add any required authorization fields to allow recurring payments", + "type": "object", + "properties": { + "accountNumber": { + "type": "integer", + "description": "Bank Account Number (this could refer to the IBAN or SWIFT number)" + }, + "accountNumberType": { + "type": "string", + "description": "Type of account number (e.g.: IBAN, SWIFT, ...)" + }, + "BIC": { + "type": "string", + "description": "Business Identifier Code/Swift code of the financial institution where the account is located" + }, + "blank": { + "type": "string", + "description": "Display name of the bank" + }, + "owner": { + "type": "string", + "description": "Owner of the bank account" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/BankAccountTransferMethod.schema.json b/EngagedParty/BankAccountTransferMethod.schema.json index 4f68f549..83bf0912 100644 --- a/EngagedParty/BankAccountTransferMethod.schema.json +++ b/EngagedParty/BankAccountTransferMethod.schema.json @@ -1,61 +1,61 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BankAccountTransferMethod.schema.json", - "title": "BankAccountTransferMethod", - "definitions": { - "BankAccountTransferMethod": { - "$id": "#BankAccountTransferMethod", - "type": "object", - "properties": { - "details": { - "$ref": "BankAccountTransferDetails.schema.json#BankAccountTransferDetails" - }, - "description": { - "type": "string", - "description": "Text describing the contents of the payment method" - }, - "href": { - "type": "string", - "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" - }, - "id": { - "type": "string", - "description": "Unique Identifier within the server for the payment method." - }, - "name": { - "type": "string", - "description": "Friendly name assigned to the payment method" - }, - "preferred": { - "type": "boolean", - "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" - }, - "status": { - "type": "string" - }, - "statusDate": { - "type": "string", - "format": "date-time" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Date interval in which the payment method is valid" - }, - "relatedParty": { - "$ref": "RelatedParty.schema.json#RelatedParty" - }, - "account": { - "type": "array", - "items": { - "$ref": "AccountRef.schema.json#AccountRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BankAccountTransferMethod.schema.json", + "title": "BankAccountTransferMethod", + "definitions": { + "BankAccountTransferMethod": { + "$id": "#BankAccountTransferMethod", + "type": "object", + "properties": { + "details": { + "$ref": "../EngagedParty/BankAccountTransferDetails.schema.json#BankAccountTransferDetails" + }, + "description": { + "type": "string", + "description": "Text describing the contents of the payment method" + }, + "href": { + "type": "string", + "description": "A resource URI pointing to the resource in the server that stores the detailed information. This is typically the resource url to retrieve individual details for the specific payment method" + }, + "id": { + "type": "string", + "description": "Unique Identifier within the server for the payment method." + }, + "name": { + "type": "string", + "description": "Friendly name assigned to the payment method" + }, + "preferred": { + "type": "boolean", + "description": "If the method is the preferred one by the owner. Typically used when querying for the payment methods of a specific customer or account" + }, + "status": { + "type": "string" + }, + "statusDate": { + "type": "string", + "format": "date-time" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Date interval in which the payment method is valid" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/Contact.schema.json b/EngagedParty/Contact.schema.json index 783ee2d0..1a50af8d 100644 --- a/EngagedParty/Contact.schema.json +++ b/EngagedParty/Contact.schema.json @@ -1,47 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Contact.schema.json", - "title": "Contact", - "definitions": { - "Contact": { - "$id": "#Contact", - "description": "An individual or an organization used as a contact point for a given account and accessed via some contact medium.", - "type": "object", - "required": [ - "contactType" - ], - "properties": { - "contactName": { - "type": "string", - "description": "A displayable name for that contact" - }, - "contactType": { - "type": "string", - "description": "Type of contact (primary, secondary...)" - }, - "partyRoleType": { - "type": "string", - "description": "Identifies what kind of party role type is linked to the contact (a account manager...)" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Validity period of that contact" - }, - "contactMedium": { - "type": "array", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - }, - "relatedParty": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Contact.schema.json", + "title": "Contact", + "definitions": { + "Contact": { + "$id": "#Contact", + "description": "An individual or an organization used as a contact point for a given account and accessed via some contact medium.", + "type": "object", + "required": [ + "contactType" + ], + "properties": { + "contactName": { + "type": "string", + "description": "A displayable name for that contact" + }, + "contactType": { + "type": "string", + "description": "Type of contact (primary, secondary...)" + }, + "partyRoleType": { + "type": "string", + "description": "Identifies what kind of party role type is linked to the contact (a account manager...)" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Validity period of that contact" + }, + "contactMedium": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/FinancialAccount.schema.json b/EngagedParty/FinancialAccount.schema.json index 93079d26..c149e534 100644 --- a/EngagedParty/FinancialAccount.schema.json +++ b/EngagedParty/FinancialAccount.schema.json @@ -1,21 +1,21 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "FinancialAccount.schema.json", - "title": "FinancialAccount", - "definitions": { - "FinancialAccount": { - "$id": "#FinancialAccount", - "description": "An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. A financial (account receivable account/account payable) aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party. It is a specialization of entity Account.", - "type": "object", - "required": [ - "name" - ], - "properties": {}, - "allOf": [ - { - "$ref": "Account.schema.json#Account" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "FinancialAccount.schema.json", + "title": "FinancialAccount", + "definitions": { + "FinancialAccount": { + "$id": "#FinancialAccount", + "description": "An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. A financial (account receivable account/account payable) aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party. It is a specialization of entity Account.", + "type": "object", + "required": [ + "name" + ], + "properties": {}, + "allOf": [ + { + "$ref": "../EngagedParty/Account.schema.json#Account" } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/FinancialAccountRef.schema.json b/EngagedParty/FinancialAccountRef.schema.json index 6fc41c90..34e4fd81 100644 --- a/EngagedParty/FinancialAccountRef.schema.json +++ b/EngagedParty/FinancialAccountRef.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "FinancialAccountRef.schema.json", - "title": "FinancialAccountRef", - "definitions": { - "FinancialAccountRef": { - "$id": "#FinancialAccountRef", - "description": "AccountReceivable reference. An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. An account receivable aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Unique reference of the account" - }, - "id": { - "type": "string", - "description": "Unique identifier of the account" - }, - "name": { - "type": "string", - "description": "Name of the account" - }, - "accountBalance": { - "$ref": "AccountBalance.schema.json#AccountBalance" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "FinancialAccountRef.schema.json", + "title": "FinancialAccountRef", + "definitions": { + "FinancialAccountRef": { + "$id": "#FinancialAccountRef", + "description": "AccountReceivable reference. An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. An account receivable aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Unique reference of the account" + }, + "id": { + "type": "string", + "description": "Unique identifier of the account" + }, + "name": { + "type": "string", + "description": "Name of the account" + }, + "accountBalance": { + "$ref": "../EngagedParty/AccountBalance.schema.json#AccountBalance" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/Individual.schema.json b/EngagedParty/Individual.schema.json index 85fd324b..e3836625 100644 --- a/EngagedParty/Individual.schema.json +++ b/EngagedParty/Individual.schema.json @@ -1,137 +1,137 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Individual.schema.json", - "title": "Individual", - "definitions": { - "Individual": { - "$id": "#Individual", - "type": "object", - "description": "Individual represents a single human being (a man, woman or child). The individual can be a customer, an employee or any other person that the organization needs to store information about.", - "properties": { - "gender": { - "type": "string", - "description": "Gender" - }, - "placeOfBirth": { - "type": "string", - "description": "Reference to the place where the individual was born" - }, - "countryOfBirth": { - "type": "string", - "description": "Country where the individual was born" - }, - "nationality": { - "type": "string", - "description": "Nationality" - }, - "maritalStatus": { - "type": "string", - "description": "Marital status (married, divorced, widow ...)" - }, - "birthDate": { - "type": "string", - "format": "date-time", - "description": "Birth date" - }, - "deathDate": { - "type": "string", - "format": "date-time", - "description": "Date of death" - }, - "title": { - "type": "string", - "description": "Useful for titles (aristocratic, social,...) Pr, Dr, Sir, ..." - }, - "aristocraticTitle": { - "type": "string", - "description": "e.g. Baron, Graf, Earl,…" - }, - "generation": { - "type": "string", - "description": "e.g.. Sr, Jr, III (the third),…" - }, - "givenName": { - "type": "string", - "description": "First name of the individual" - }, - "preferredGivenName": { - "type": "string", - "description": "Contains the chosen name by which the individual prefers to be addressed. Note: This name may be a name other than a given name, such as a nickname" - }, - "familyNamePrefix": { - "type": "string", - "description": "Family name prefix" - }, - "familyName": { - "type": "string", - "description": "Contains the non-chosen or inherited name. Also known as last name in the Western context" - }, - "legalName": { - "type": "string", - "description": "Legal name or birth name (name one has for official purposes)" - }, - "middleName": { - "type": "string", - "description": "Middles name or initial" - }, - "fullName": { - "type": "string", - "description": "Full name flatten (first, middle, and last names)" - }, - "formattedName": { - "type": "string", - "description": "A fully formatted name in one string with all of its pieces in their proper place and all of the necessary punctuation. Useful for specific contexts (Chinese, Japanese, Korean,…)" - }, - "location": { - "type": "string", - "description": "Temporary current location od the individual (may be used if the individual has approved its sharing)" - }, - "status": { - "description": "Status of the individual", - "$ref": "IndividualStateType.schema.json#IndividualStateType" - }, - "otherName": { - "type": "array", - "items": { - "$ref": "OtherNameIndividual.schema.json#OtherNameIndividual" - } - }, - "individualIdentification": { - "type": "array", - "items": { - "$ref": "IndividualIdentification.schema.json#IndividualIdentification" - } - }, - "disability": { - "type": "array", - "items": { - "$ref": "../Customer/Disability.schema.json#Disability" - } - }, - "languageAbility": { - "type": "array", - "items": { - "$ref": "LanguageAbility.schema.json#LanguageAbility" - } - }, - "skill": { - "type": "array", - "items": { - "$ref": "Skill.schema.json#Skill" - } - } - }, - "required": [ - "id" - ], - "allOf": [ - { - "$ref": "Party.schema.json#Party" - }, - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Individual.schema.json", + "title": "Individual", + "definitions": { + "Individual": { + "$id": "#Individual", + "type": "object", + "description": "Individual represents a single human being (a man, woman or child). The individual can be a customer, an employee or any other person that the organization needs to store information about.", + "properties": { + "gender": { + "type": "string", + "description": "Gender" + }, + "placeOfBirth": { + "type": "string", + "description": "Reference to the place where the individual was born" + }, + "countryOfBirth": { + "type": "string", + "description": "Country where the individual was born" + }, + "nationality": { + "type": "string", + "description": "Nationality" + }, + "maritalStatus": { + "type": "string", + "description": "Marital status (married, divorced, widow ...)" + }, + "birthDate": { + "type": "string", + "format": "date-time", + "description": "Birth date" + }, + "deathDate": { + "type": "string", + "format": "date-time", + "description": "Date of death" + }, + "title": { + "type": "string", + "description": "Useful for titles (aristocratic, social,...) Pr, Dr, Sir, ..." + }, + "aristocraticTitle": { + "type": "string", + "description": "e.g. Baron, Graf, Earl,…" + }, + "generation": { + "type": "string", + "description": "e.g.. Sr, Jr, III (the third),…" + }, + "givenName": { + "type": "string", + "description": "First name of the individual" + }, + "preferredGivenName": { + "type": "string", + "description": "Contains the chosen name by which the individual prefers to be addressed. Note: This name may be a name other than a given name, such as a nickname" + }, + "familyNamePrefix": { + "type": "string", + "description": "Family name prefix" + }, + "familyName": { + "type": "string", + "description": "Contains the non-chosen or inherited name. Also known as last name in the Western context" + }, + "legalName": { + "type": "string", + "description": "Legal name or birth name (name one has for official purposes)" + }, + "middleName": { + "type": "string", + "description": "Middles name or initial" + }, + "fullName": { + "type": "string", + "description": "Full name flatten (first, middle, and last names)" + }, + "formattedName": { + "type": "string", + "description": "A fully formatted name in one string with all of its pieces in their proper place and all of the necessary punctuation. Useful for specific contexts (Chinese, Japanese, Korean,…)" + }, + "location": { + "type": "string", + "description": "Temporary current location od the individual (may be used if the individual has approved its sharing)" + }, + "status": { + "description": "Status of the individual", + "$ref": "../EngagedParty/IndividualStateType.schema.json#IndividualStateType" + }, + "otherName": { + "type": "array", + "items": { + "$ref": "../EngagedParty/OtherNameIndividual.schema.json#OtherNameIndividual" + } + }, + "individualIdentification": { + "type": "array", + "items": { + "$ref": "../EngagedParty/IndividualIdentification.schema.json#IndividualIdentification" + } + }, + "disability": { + "type": "array", + "items": { + "$ref": "../Customer/Disability.schema.json#Disability" + } + }, + "languageAbility": { + "type": "array", + "items": { + "$ref": "../EngagedParty/LanguageAbility.schema.json#LanguageAbility" + } + }, + "skill": { + "type": "array", + "items": { + "$ref": "../EngagedParty/Skill.schema.json#Skill" + } } + }, + "required": [ + "id" + ], + "allOf": [ + { + "$ref": "../EngagedParty/Party.schema.json#Party" + }, + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/IndividualIdentification.schema.json b/EngagedParty/IndividualIdentification.schema.json index 19a61ca3..187bcd5c 100644 --- a/EngagedParty/IndividualIdentification.schema.json +++ b/EngagedParty/IndividualIdentification.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "IndividualIdentification.schema.json", - "title": "IndividualIdentification", - "definitions": { - "IndividualIdentification": { - "$id": "#IndividualIdentification", - "description": "Represents our registration of information used as proof of identity by an individual (passport, national identity card, drivers license, social security number, birth certificate)", - "type": "object", - "properties": { - "identificationId": { - "type": "string", - "description": "Identifier" - }, - "issuingAuthority": { - "type": "string", - "description": "Authority which has issued the identifier, such as: social security, town hall" - }, - "issuingDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the identifier was issued" - }, - "identificationType": { - "type": "string", - "description": "Identification type (passport, national identity card, drivers license, social security number, birth certificate)" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the identification information is valid." - }, - "attachment": { - "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "IndividualIdentification.schema.json", + "title": "IndividualIdentification", + "definitions": { + "IndividualIdentification": { + "$id": "#IndividualIdentification", + "description": "Represents our registration of information used as proof of identity by an individual (passport, national identity card, drivers license, social security number, birth certificate)", + "type": "object", + "properties": { + "identificationId": { + "type": "string", + "description": "Identifier" + }, + "issuingAuthority": { + "type": "string", + "description": "Authority which has issued the identifier, such as: social security, town hall" + }, + "issuingDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the identifier was issued" + }, + "identificationType": { + "type": "string", + "description": "Identification type (passport, national identity card, drivers license, social security number, birth certificate)" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the identification information is valid." + }, + "attachment": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/IndividualStateType.schema.json b/EngagedParty/IndividualStateType.schema.json index 159e98c8..a31c385e 100644 --- a/EngagedParty/IndividualStateType.schema.json +++ b/EngagedParty/IndividualStateType.schema.json @@ -1,17 +1,17 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "IndividualStateType.schema.json", - "title": "IndividualStateType", - "definitions": { - "IndividualStateType": { - "$id": "#IndividualStateType", - "type": "string", - "description": "Valid values for the lifecycle state of the individual", - "enum": [ - "initialized", - "validated", - "deceaded" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "IndividualStateType.schema.json", + "title": "IndividualStateType", + "definitions": { + "IndividualStateType": { + "$id": "#IndividualStateType", + "type": "string", + "description": "Valid values for the lifecycle state of the individual", + "enum": [ + "initialized", + "validated", + "deceaded" + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/IssuerRef.schema.json b/EngagedParty/IssuerRef.schema.json index afde1be9..afc616ba 100644 --- a/EngagedParty/IssuerRef.schema.json +++ b/EngagedParty/IssuerRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "IssuerRef.schema.json", - "title": "IssuerRef", - "definitions": { - "IssuerRef": { - "$id": "#IssuerRef", - "description": "Issuer reference. The issuer is the party role who will issue the settlement note.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the issuer" - }, - "id": { - "type": "string", - "description": "Identifier of the issuer" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "IssuerRef.schema.json", + "title": "IssuerRef", + "definitions": { + "IssuerRef": { + "$id": "#IssuerRef", + "description": "Issuer reference. The issuer is the party role who will issue the settlement note.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the issuer" + }, + "id": { + "type": "string", + "description": "Identifier of the issuer" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/LanguageAbility.schema.json b/EngagedParty/LanguageAbility.schema.json index 430c7aee..e25357b3 100644 --- a/EngagedParty/LanguageAbility.schema.json +++ b/EngagedParty/LanguageAbility.schema.json @@ -1,50 +1,50 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LanguageAbility.schema.json", - "title": "LanguageAbility", - "definitions": { - "LanguageAbility": { - "$id": "#LanguageAbility", - "type": "object", - "description": "Ability of an individual to understand or converse in a language.", - "properties": { - "languageCode": { - "type": "string", - "description": "Language code (RFC 5646)" - }, - "languageName": { - "type": "string", - "description": "Language name" - }, - "isFavouriteLanguage": { - "type": "boolean", - "description": "A “true” value specifies whether the language is considered by the individual as his favourite one" - }, - "writingProficiency": { - "type": "string", - "description": "Writing proficiency evaluated for this language" - }, - "readingProficiency": { - "type": "string", - "description": "Reading proficiency evaluated for this language" - }, - "speakingProficiency": { - "type": "string", - "description": "Speaking proficiency evaluated for this language" - }, - "listeningProficiency": { - "type": "string", - "description": "Listening proficiency evaluated for this language" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LanguageAbility.schema.json", + "title": "LanguageAbility", + "definitions": { + "LanguageAbility": { + "$id": "#LanguageAbility", + "type": "object", + "description": "Ability of an individual to understand or converse in a language.", + "properties": { + "languageCode": { + "type": "string", + "description": "Language code (RFC 5646)" + }, + "languageName": { + "type": "string", + "description": "Language name" + }, + "isFavouriteLanguage": { + "type": "boolean", + "description": "A “true” value specifies whether the language is considered by the individual as his favourite one" + }, + "writingProficiency": { + "type": "string", + "description": "Writing proficiency evaluated for this language" + }, + "readingProficiency": { + "type": "string", + "description": "Reading proficiency evaluated for this language" + }, + "speakingProficiency": { + "type": "string", + "description": "Speaking proficiency evaluated for this language" + }, + "listeningProficiency": { + "type": "string", + "description": "Listening proficiency evaluated for this language" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/Organization.schema.json b/EngagedParty/Organization.schema.json index 14c6776d..220b6ed9 100644 --- a/EngagedParty/Organization.schema.json +++ b/EngagedParty/Organization.schema.json @@ -1,77 +1,77 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Organization.schema.json", - "title": "Organization", - "definitions": { - "Organization": { - "$id": "#Organization", - "type": "object", - "description": "Organization represents a group of people identified by shared interests or purpose. Examples include business, department and enterprise. Because of the complex nature of many businesses, both organizations and organization units are represented by the same data.", - "properties": { - "isLegalEntity": { - "type": "boolean", - "description": "If value is true, the organization is a legal entity known by a national referential." - }, - "isHeadOffice": { - "type": "boolean", - "description": "If value is true, the organization is the head office" - }, - "organizationType": { - "type": "string", - "description": "Type of Organization (company, department...)" - }, - "tradingName": { - "type": "string", - "description": "Name that the organization (unit) trades under" - }, - "existsDuring": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - }, - "name": { - "type": "string", - "description": "Organization name (department name for example)" - }, - "nameType": { - "type": "string", - "description": "Type of the name : Co, Inc, Ltd,…" - }, - "status": { - "description": "Status of the organization", - "$ref": "OrganizationStateType.schema.json#OrganizationStateType" - }, - "otherName": { - "type": "array", - "items": { - "$ref": "OtherNameOrganization.schema.json#OtherNameOrganization" - } - }, - "organizationIdentification": { - "type": "array", - "items": { - "$ref": "OrganizationIdentification.schema.json#OrganizationIdentification" - } - }, - "organizationChildRelationship": { - "type": "array", - "items": { - "$ref": "OrganizationChildRelationship.schema.json#OrganizationChildRelationship" - } - }, - "organizationParentRelationship": { - "$ref": "OrganizationParentRelationship.schema.json#OrganizationParentRelationship" - } - }, - "allOf": [ - { - "$ref": "Party.schema.json#Party" - }, - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ], - "required": [ - "id" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Organization.schema.json", + "title": "Organization", + "definitions": { + "Organization": { + "$id": "#Organization", + "type": "object", + "description": "Organization represents a group of people identified by shared interests or purpose. Examples include business, department and enterprise. Because of the complex nature of many businesses, both organizations and organization units are represented by the same data.", + "properties": { + "isLegalEntity": { + "type": "boolean", + "description": "If value is true, the organization is a legal entity known by a national referential." + }, + "isHeadOffice": { + "type": "boolean", + "description": "If value is true, the organization is the head office" + }, + "organizationType": { + "type": "string", + "description": "Type of Organization (company, department...)" + }, + "tradingName": { + "type": "string", + "description": "Name that the organization (unit) trades under" + }, + "existsDuring": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + }, + "name": { + "type": "string", + "description": "Organization name (department name for example)" + }, + "nameType": { + "type": "string", + "description": "Type of the name : Co, Inc, Ltd,…" + }, + "status": { + "description": "Status of the organization", + "$ref": "../EngagedParty/OrganizationStateType.schema.json#OrganizationStateType" + }, + "otherName": { + "type": "array", + "items": { + "$ref": "../EngagedParty/OtherNameOrganization.schema.json#OtherNameOrganization" + } + }, + "organizationIdentification": { + "type": "array", + "items": { + "$ref": "../EngagedParty/OrganizationIdentification.schema.json#OrganizationIdentification" + } + }, + "organizationChildRelationship": { + "type": "array", + "items": { + "$ref": "../EngagedParty/OrganizationChildRelationship.schema.json#OrganizationChildRelationship" + } + }, + "organizationParentRelationship": { + "$ref": "../EngagedParty/OrganizationParentRelationship.schema.json#OrganizationParentRelationship" } + }, + "allOf": [ + { + "$ref": "../EngagedParty/Party.schema.json#Party" + }, + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ], + "required": [ + "id" + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/OrganizationChildRelationship.schema.json b/EngagedParty/OrganizationChildRelationship.schema.json index 6f8da17a..5cba301a 100644 --- a/EngagedParty/OrganizationChildRelationship.schema.json +++ b/EngagedParty/OrganizationChildRelationship.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrganizationChildRelationship.schema.json", - "title": "OrganizationChildRelationship", - "definitions": { - "OrganizationChildRelationship": { - "$id": "#OrganizationChildRelationship", - "type": "object", - "description": "Child references of an organization in a structure of organizations.", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of the relationship. Could be juridical, hierarchical, geographical, functional for example." - }, - "organization": { - "$ref": "OrganizationRef.schema.json#OrganizationRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrganizationChildRelationship.schema.json", + "title": "OrganizationChildRelationship", + "definitions": { + "OrganizationChildRelationship": { + "$id": "#OrganizationChildRelationship", + "type": "object", + "description": "Child references of an organization in a structure of organizations.", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of the relationship. Could be juridical, hierarchical, geographical, functional for example." + }, + "organization": { + "$ref": "../EngagedParty/OrganizationRef.schema.json#OrganizationRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/OrganizationIdentification.schema.json b/EngagedParty/OrganizationIdentification.schema.json index f363456c..41fa164b 100644 --- a/EngagedParty/OrganizationIdentification.schema.json +++ b/EngagedParty/OrganizationIdentification.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrganizationIdentification.schema.json", - "title": "OrganizationIdentification", - "definitions": { - "OrganizationIdentification": { - "$id": "#OrganizationIdentification", - "description": "Represents our registration of information used as proof of identity by an organization", - "type": "object", - "properties": { - "identificationId": { - "type": "string", - "description": "Identifier" - }, - "issuingAuthority": { - "type": "string", - "description": "Authority which has issued the identifier (chamber of commerce...)" - }, - "issuingDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the identifier was issued" - }, - "identificationType": { - "type": "string", - "description": "Type of identification information used to identify the company in a country or internationally" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the identification information is valid." - }, - "attachment": { - "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrganizationIdentification.schema.json", + "title": "OrganizationIdentification", + "definitions": { + "OrganizationIdentification": { + "$id": "#OrganizationIdentification", + "description": "Represents our registration of information used as proof of identity by an organization", + "type": "object", + "properties": { + "identificationId": { + "type": "string", + "description": "Identifier" + }, + "issuingAuthority": { + "type": "string", + "description": "Authority which has issued the identifier (chamber of commerce...)" + }, + "issuingDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the identifier was issued" + }, + "identificationType": { + "type": "string", + "description": "Type of identification information used to identify the company in a country or internationally" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the identification information is valid." + }, + "attachment": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/OrganizationParentRelationship.schema.json b/EngagedParty/OrganizationParentRelationship.schema.json index 540c0ee7..a9b8a481 100644 --- a/EngagedParty/OrganizationParentRelationship.schema.json +++ b/EngagedParty/OrganizationParentRelationship.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrganizationParentRelationship.schema.json", - "title": "OrganizationParentRelationship", - "definitions": { - "OrganizationParentRelationship": { - "$id": "#OrganizationParentRelationship", - "type": "object", - "description": "Parent references of an organization in a structure of organizations.", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of the relationship. Could be juridical, hierarchical, geographical, functional for example." - }, - "organization": { - "$ref": "OrganizationRef.schema.json#OrganizationRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrganizationParentRelationship.schema.json", + "title": "OrganizationParentRelationship", + "definitions": { + "OrganizationParentRelationship": { + "$id": "#OrganizationParentRelationship", + "type": "object", + "description": "Parent references of an organization in a structure of organizations.", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of the relationship. Could be juridical, hierarchical, geographical, functional for example." + }, + "organization": { + "$ref": "../EngagedParty/OrganizationRef.schema.json#OrganizationRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/OrganizationRef.schema.json b/EngagedParty/OrganizationRef.schema.json index 55288cc3..9d7591a8 100644 --- a/EngagedParty/OrganizationRef.schema.json +++ b/EngagedParty/OrganizationRef.schema.json @@ -1,17 +1,17 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrganizationRef.schema.json", - "title": "OrganizationRef", - "definitions": { - "OrganizationRef": { - "$id": "#OrganizationRef", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrganizationRef.schema.json", + "title": "OrganizationRef", + "definitions": { + "OrganizationRef": { + "$id": "#OrganizationRef", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/OrganizationStateType.schema.json b/EngagedParty/OrganizationStateType.schema.json index 45c46147..4967e256 100644 --- a/EngagedParty/OrganizationStateType.schema.json +++ b/EngagedParty/OrganizationStateType.schema.json @@ -1,17 +1,17 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrganizationStateType.schema.json", - "title": "OrganizationStateType", - "definitions": { - "OrganizationStateType": { - "$id": "#OrganizationStateType", - "type": "string", - "description": "Valid values for the lifecycle state of the organization", - "enum": [ - "initialized", - "validated", - "closed" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrganizationStateType.schema.json", + "title": "OrganizationStateType", + "definitions": { + "OrganizationStateType": { + "$id": "#OrganizationStateType", + "type": "string", + "description": "Valid values for the lifecycle state of the organization", + "enum": [ + "initialized", + "validated", + "closed" + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/OtherName.schema.json b/EngagedParty/OtherName.schema.json index ad3d632b..661edd61 100644 --- a/EngagedParty/OtherName.schema.json +++ b/EngagedParty/OtherName.schema.json @@ -1,55 +1,55 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OtherName.schema.json", - "title": "OtherName", - "definitions": { - "OtherName": { - "$id": "#OtherName", - "description": "To keep track of other names (for example the old name of a woman before marriage or an artist name)", - "type": "object", - "properties": { - "familyName": { - "type": "string", - "description": "Last name" - }, - "formattedName": { - "type": "string", - "description": "A formatted name useful for specific contexts (chinese, japanese, korean...)" - }, - "fullName": { - "type": "string", - "description": "Full name flatten (first, middle, and last name)" - }, - "givenName": { - "type": "string", - "description": "First name" - }, - "middleName": { - "type": "string", - "description": "Middle name" - }, - "nameType": { - "type": "string", - "description": "Co., Inc., Ltd., Plc., Gmbh." - }, - "title": { - "type": "string", - "description": "useful for titles (aristocratic, social...) Dr, Pr, Sir..." - }, - "tradingName": { - "type": "string", - "description": "The name that the organization trades under" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the other name is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OtherName.schema.json", + "title": "OtherName", + "definitions": { + "OtherName": { + "$id": "#OtherName", + "description": "To keep track of other names (for example the old name of a woman before marriage or an artist name)", + "type": "object", + "properties": { + "familyName": { + "type": "string", + "description": "Last name" + }, + "formattedName": { + "type": "string", + "description": "A formatted name useful for specific contexts (chinese, japanese, korean...)" + }, + "fullName": { + "type": "string", + "description": "Full name flatten (first, middle, and last name)" + }, + "givenName": { + "type": "string", + "description": "First name" + }, + "middleName": { + "type": "string", + "description": "Middle name" + }, + "nameType": { + "type": "string", + "description": "Co., Inc., Ltd., Plc., Gmbh." + }, + "title": { + "type": "string", + "description": "useful for titles (aristocratic, social...) Dr, Pr, Sir..." + }, + "tradingName": { + "type": "string", + "description": "The name that the organization trades under" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the other name is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/OtherNameIndividual.schema.json b/EngagedParty/OtherNameIndividual.schema.json index 84d2e806..43f572b5 100644 --- a/EngagedParty/OtherNameIndividual.schema.json +++ b/EngagedParty/OtherNameIndividual.schema.json @@ -1,66 +1,66 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OtherNameIndividual.schema.json", - "title": "OtherNameIndividual", - "definitions": { - "OtherNameIndividual": { - "$id": "#OtherNameIndividual", - "type": "object", - "description": "Keeps track of other names, for example the old name of a woman before marriage or an artist name.", - "properties": { - "title": { - "type": "string", - "description": "Use for titles (aristrocatic, social, ...): Pr, Dr, Sir,...." - }, - "aristocraticTitle": { - "type": "string", - "description": "e.g. Baron, Graf, Earl,…" - }, - "generation": { - "type": "string", - "description": "e.g. Sr, Jr…" - }, - "givenName": { - "type": "string", - "description": "First name" - }, - "preferredGivenName": { - "type": "string", - "description": "Contains the chosen name by which the person prefers to be addressed. Note: This name may be a name other than a given name, such as a nickname" - }, - "familyNamePrefix": { - "type": "string", - "description": "Family name prefix" - }, - "familyName": { - "type": "string", - "description": "Contains the non-chosen or inherited name. Also known as last name in the Western context" - }, - "legalName": { - "type": "string", - "description": "Legal name or birth name (name one has for official purposes)" - }, - "middleName": { - "type": "string", - "description": "Middle name or initial" - }, - "fullName": { - "type": "string", - "description": "Full name flatten (first, middle, and last names)" - }, - "formattedName": { - "type": "string", - "description": ". A fully formatted name in one string with all of its pieces in their proper place and all of the necessary punctuation. Useful for specific contexts (Chinese, Japanese, Korean,…)" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OtherNameIndividual.schema.json", + "title": "OtherNameIndividual", + "definitions": { + "OtherNameIndividual": { + "$id": "#OtherNameIndividual", + "type": "object", + "description": "Keeps track of other names, for example the old name of a woman before marriage or an artist name.", + "properties": { + "title": { + "type": "string", + "description": "Use for titles (aristrocatic, social, ...): Pr, Dr, Sir,...." + }, + "aristocraticTitle": { + "type": "string", + "description": "e.g. Baron, Graf, Earl,…" + }, + "generation": { + "type": "string", + "description": "e.g. Sr, Jr…" + }, + "givenName": { + "type": "string", + "description": "First name" + }, + "preferredGivenName": { + "type": "string", + "description": "Contains the chosen name by which the person prefers to be addressed. Note: This name may be a name other than a given name, such as a nickname" + }, + "familyNamePrefix": { + "type": "string", + "description": "Family name prefix" + }, + "familyName": { + "type": "string", + "description": "Contains the non-chosen or inherited name. Also known as last name in the Western context" + }, + "legalName": { + "type": "string", + "description": "Legal name or birth name (name one has for official purposes)" + }, + "middleName": { + "type": "string", + "description": "Middle name or initial" + }, + "fullName": { + "type": "string", + "description": "Full name flatten (first, middle, and last names)" + }, + "formattedName": { + "type": "string", + "description": ". A fully formatted name in one string with all of its pieces in their proper place and all of the necessary punctuation. Useful for specific contexts (Chinese, Japanese, Korean,…)" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/OtherNameOrganization.schema.json b/EngagedParty/OtherNameOrganization.schema.json index ff5cc089..2ceaa630 100644 --- a/EngagedParty/OtherNameOrganization.schema.json +++ b/EngagedParty/OtherNameOrganization.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OtherNameOrganization.schema.json", - "title": "OtherNameOrganization", - "definitions": { - "OtherNameOrganization": { - "$id": "#OtherNameOrganization", - "type": "object", - "description": "Keeps track of other names, for example the old name of an organization.", - "properties": { - "tradingName": { - "type": "string", - "description": "The name that the organization trades under" - }, - "nameType": { - "type": "string", - "description": "Co. , Inc. , Ltd. , Pty Ltd. , Plc; , Gmbh" - }, - "name": { - "type": "string", - "description": "Organization name (department name for example)" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OtherNameOrganization.schema.json", + "title": "OtherNameOrganization", + "definitions": { + "OtherNameOrganization": { + "$id": "#OtherNameOrganization", + "type": "object", + "description": "Keeps track of other names, for example the old name of an organization.", + "properties": { + "tradingName": { + "type": "string", + "description": "The name that the organization trades under" + }, + "nameType": { + "type": "string", + "description": "Co. , Inc. , Ltd. , Pty Ltd. , Plc; , Gmbh" + }, + "name": { + "type": "string", + "description": "Organization name (department name for example)" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/Partner.schema.json b/EngagedParty/Partner.schema.json new file mode 100644 index 00000000..acdbc872 --- /dev/null +++ b/EngagedParty/Partner.schema.json @@ -0,0 +1,94 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Partner.schema.json", + "title": "Partner", + "definitions": { + "Partner": { + "$id": "#Partner", + "description": "The part played by a party in a given context.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Url used to reference the partner." + }, + "id": { + "type": "string", + "description": "Unique identifier for Partners" + }, + "name": { + "type": "string", + "description": "A word, term, or phrase by which the Partner is known and distinguished from other Partners." + }, + "status": { + "type": "string", + "description": "Used to track the lifecycle status of the partner." + }, + "statusReason": { + "type": "string", + "description": "A string providing an explanation on the value of the status lifecycle. For instance if the status is Rejected, statusReason will provide the reason for rejection." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The time period that the Partner is valid for." + }, + "engagedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty", + "description": "The reference to the party engaged in this partnership." + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } + }, + "paymentMethod": { + "type": "array", + "items": { + "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" + } + }, + "contactMedium": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + }, + "description": "Describes the characteristic of a partner." + }, + "creditProfile": { + "type": "array", + "items": { + "$ref": "../Customer/CreditProfile.schema.json#CreditProfile" + } + }, + "agreement": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ], + "required": [ + "name", + "engagedParty" + ] + } + } +} diff --git a/EngagedParty/Partnership.schema.json b/EngagedParty/Partnership.schema.json new file mode 100644 index 00000000..b1b3435d --- /dev/null +++ b/EngagedParty/Partnership.schema.json @@ -0,0 +1,50 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Partnership.schema.json", + "title": "Partnership", + "definitions": { + "Partnership": { + "$id": "#Partnership", + "description": "A partnership represents a formalized collaboration between various parties, each party playing a role in the partnership. The parties playing a role in the partnership represented by the Partner entity. The structure of a partnership is specified by a PartnershipSpecification which contain all the information for the setup of the partnership, including the list of identified roles and the agreement that should apply.", + "type": "object", + "required": [ + "name", + "specification" + ], + "properties": { + "description": { + "type": "string", + "description": "An explanatory text regarding this partnership" + }, + "href": { + "type": "string", + "description": "The reference url for this partnership" + }, + "id": { + "type": "string", + "description": "The identifier of the partnership" + }, + "name": { + "type": "string", + "description": "An identifying name for the partnership." + }, + "specification": { + "description": "The specification of this partnership.", + "$ref": "../EngagedParty/PartnershipSpecificationRef.schema.json#PartnershipSpecificationRef" + }, + "partner": { + "description": "The list of partners of the partnership, where a partner represents a party playing a given role. Hence a partner structure includes primarily a reference to the engaged party and a role name matching necessarily the name of one of the role specifications defined in the specification of the partnership.", + "type": "array", + "items": { + "$ref": "../EngagedParty/Partner.schema.json#Partner" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] + } + } +} diff --git a/EngagedParty/PartnershipRef.schema.json b/EngagedParty/PartnershipRef.schema.json new file mode 100644 index 00000000..ba9cb53f --- /dev/null +++ b/EngagedParty/PartnershipRef.schema.json @@ -0,0 +1,35 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartnershipRef.schema.json", + "title": "PartnershipRef", + "definitions": { + "PartnershipRef": { + "$id": "#PartnershipRef", + "description": "Partnership reference. A partnership contains all the information for the setup of a partnership of a given kind. This includes the list of identified role types for the partnership with the corresponding agreement specifications.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference url for the partnership" + }, + "id": { + "type": "string", + "description": "Identifier of the partnership" + }, + "name": { + "type": "string", + "description": "Name of the partnership" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] + } + } +} diff --git a/EngagedParty/PartnershipSpecification.schema.json b/EngagedParty/PartnershipSpecification.schema.json new file mode 100644 index 00000000..b17b05ff --- /dev/null +++ b/EngagedParty/PartnershipSpecification.schema.json @@ -0,0 +1,45 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartnershipSpecification.schema.json", + "title": "PartnershipSpecification", + "definitions": { + "PartnershipSpecification": { + "$id": "#PartnershipSpecification", + "description": "A partnership specification contains all the information for the setup of a partnership of a given kind. This includes the list of identified role types for the partnership with the corresponding agreement specifications.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "description": { + "type": "string", + "description": "An explanatory text regarding this partnership specification" + }, + "href": { + "type": "string", + "description": "The reference url for this partnership specification" + }, + "id": { + "type": "string", + "description": "The identifier of the partnership specification" + }, + "name": { + "type": "string", + "description": "An identifying name for the partnership specification." + }, + "roleSpecification": { + "description": "The list of roles specifications a engaged party will be able to play for this kind of partnership", + "type": "array", + "items": { + "$ref": "../EngagedParty/RoleSpecification.schema.json#RoleSpecification" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] + } + } +} diff --git a/EngagedParty/PartnershipSpecificationRef.schema.json b/EngagedParty/PartnershipSpecificationRef.schema.json new file mode 100644 index 00000000..83888c87 --- /dev/null +++ b/EngagedParty/PartnershipSpecificationRef.schema.json @@ -0,0 +1,35 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartnershipSpecificationRef.schema.json", + "title": "PartnershipSpecificationRef", + "definitions": { + "PartnershipSpecificationRef": { + "$id": "#PartnershipSpecificationRef", + "description": "PartnershipSpecification reference. A partnership specification contains all the information for the setup of a partnership of a given kind. This includes the list of identified role types for the partnership with the corresponding agreement specifications.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference url for the partnership specification" + }, + "id": { + "type": "string", + "description": "Identifier of the partnership specification" + }, + "name": { + "type": "string", + "description": "Name of the partnership specification" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] + } + } +} diff --git a/EngagedParty/PartnershipType.schema.json b/EngagedParty/PartnershipType.schema.json index 6af57030..fafc81e0 100644 --- a/EngagedParty/PartnershipType.schema.json +++ b/EngagedParty/PartnershipType.schema.json @@ -1,44 +1,44 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartnershipType.schema.json", - "title": "PartnershipType", - "definitions": { - "PartnershipType": { - "$id": "#PartnershipType", - "description": "A partnership type contains all the information for the setup of a partnership of a given kind. This includes the list of identified role types for the partnership with the corresponding agreement specifications.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "description": { - "type": "string", - "description": "An explanatory text regarding this partnership type" - }, - "href": { - "type": "string", - "description": "The reference url for this partnership type" - }, - "id": { - "type": "string", - "description": "The identifier of the partnership type" - }, - "name": { - "type": "string", - "description": "An identifying name for the partnership type." - }, - "roleType": { - "type": "array", - "items": { - "$ref": "RoleType.schema.json#RoleType" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartnershipType.schema.json", + "title": "PartnershipType", + "definitions": { + "PartnershipType": { + "$id": "#PartnershipType", + "description": "A partnership type contains all the information for the setup of a partnership of a given kind. This includes the list of identified role types for the partnership with the corresponding agreement specifications.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "description": { + "type": "string", + "description": "An explanatory text regarding this partnership type" + }, + "href": { + "type": "string", + "description": "The reference url for this partnership type" + }, + "id": { + "type": "string", + "description": "The identifier of the partnership type" + }, + "name": { + "type": "string", + "description": "An identifying name for the partnership type." + }, + "roleType": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RoleType.schema.json#RoleType" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/PartnershipTypeRef.schema.json b/EngagedParty/PartnershipTypeRef.schema.json index 47fbc746..7675756a 100644 --- a/EngagedParty/PartnershipTypeRef.schema.json +++ b/EngagedParty/PartnershipTypeRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartnershipTypeRef.schema.json", - "title": "PartnershipTypeRef", - "definitions": { - "PartnershipTypeRef": { - "$id": "#PartnershipTypeRef", - "description": "PartnershipType reference. A partnership type contains all the information for the setup of a partnership of a given kind. This includes the list of identified role types for the partnership with the corresponding agreement specifications.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference url for the partnership type" - }, - "id": { - "type": "string", - "description": "Identifier of the partnership" - }, - "name": { - "type": "string", - "description": "Name of the partnership type" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartnershipTypeRef.schema.json", + "title": "PartnershipTypeRef", + "definitions": { + "PartnershipTypeRef": { + "$id": "#PartnershipTypeRef", + "description": "PartnershipType reference. A partnership type contains all the information for the setup of a partnership of a given kind. This includes the list of identified role types for the partnership with the corresponding agreement specifications.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference url for the partnership type" + }, + "id": { + "type": "string", + "description": "Identifier of the partnership" + }, + "name": { + "type": "string", + "description": "Name of the partnership type" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/Party.schema.json b/EngagedParty/Party.schema.json index 8d6a3f45..798cd425 100644 --- a/EngagedParty/Party.schema.json +++ b/EngagedParty/Party.schema.json @@ -1,63 +1,63 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Party.schema.json", - "title": "Party", - "definitions": { - "Party": { - "$id": "#Party", - "type": "object", - "description": "Generic Party structure used to define commonalities between sub concepts of Individual and Organization.", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the organization" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the organization" - }, - "externalReference": { - "type": "array", - "items": { - "$ref": "../Common/ExternalReference.schema.json#ExternalReference" - } - }, - "partyCharacteristic": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - } - }, - "taxExemptionCertificate": { - "type": "array", - "items": { - "$ref": "TaxExemptionCertificate.schema.json#TaxExemptionCertificate" - } - }, - "creditRating": { - "type": "array", - "items": { - "$ref": "PartyCreditProfile.schema.json#PartyCreditProfile" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "contactMedium": { - "type": "array", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Party.schema.json", + "title": "Party", + "definitions": { + "Party": { + "$id": "#Party", + "type": "object", + "description": "Generic Party structure used to define commonalities between sub concepts of Individual and Organization.", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the organization" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the organization" + }, + "externalReference": { + "type": "array", + "items": { + "$ref": "../Common/ExternalReference.schema.json#ExternalReference" + } + }, + "partyCharacteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "taxExemptionCertificate": { + "type": "array", + "items": { + "$ref": "../EngagedParty/TaxExemptionCertificate.schema.json#TaxExemptionCertificate" + } + }, + "creditRating": { + "type": "array", + "items": { + "$ref": "../EngagedParty/PartyCreditProfile.schema.json#PartyCreditProfile" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "contactMedium": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/PartyAccount.schema.json b/EngagedParty/PartyAccount.schema.json index e38089ea..45e30748 100644 --- a/EngagedParty/PartyAccount.schema.json +++ b/EngagedParty/PartyAccount.schema.json @@ -1,42 +1,42 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyAccount.schema.json", - "title": "PartyAccount", - "definitions": { - "PartyAccount": { - "$id": "#PartyAccount", - "description": "Account used for billing or for settlement purposes concerning a given party (an organization or an individual). It is a specialization of entity Account.", - "type": "object", - "required": [ - "name", - "relatedParty" - ], - "properties": { - "paymentStatus": { - "type": "string", - "description": "The condition of the account, such as due, paid, in arrears." - }, - "billStructure": { - "$ref": "../Customer/BillStructure.schema.json#BillStructure" - }, - "paymentPlan": { - "type": "array", - "items": { - "$ref": "../Customer/PaymentPlan.schema.json#PaymentPlan" - } - }, - "financialAccount": { - "$ref": "FinancialAccountRef.schema.json#FinancialAccountRef" - }, - "defaultPaymentMethod": { - "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" - } - }, - "allOf": [ - { - "$ref": "Account.schema.json#Account" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyAccount.schema.json", + "title": "PartyAccount", + "definitions": { + "PartyAccount": { + "$id": "#PartyAccount", + "description": "Account used for billing or for settlement purposes concerning a given party (an organization or an individual). It is a specialization of entity Account.", + "type": "object", + "required": [ + "name", + "relatedParty" + ], + "properties": { + "paymentStatus": { + "type": "string", + "description": "The condition of the account, such as due, paid, in arrears." + }, + "billStructure": { + "$ref": "../Customer/BillStructure.schema.json#BillStructure" + }, + "paymentPlan": { + "type": "array", + "items": { + "$ref": "../Customer/PaymentPlan.schema.json#PaymentPlan" + } + }, + "financialAccount": { + "$ref": "../EngagedParty/FinancialAccountRef.schema.json#FinancialAccountRef" + }, + "defaultPaymentMethod": { + "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" } + }, + "allOf": [ + { + "$ref": "../EngagedParty/Account.schema.json#Account" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/PartyAccountRef.schema.json b/EngagedParty/PartyAccountRef.schema.json index b36791ff..d7d16bc6 100644 --- a/EngagedParty/PartyAccountRef.schema.json +++ b/EngagedParty/PartyAccountRef.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyAccountRef.schema.json", - "title": "PartyAccountRef", - "definitions": { - "PartyAccountRef": { - "$id": "#PartyAccountRef", - "description": "PartyAccount reference. A party account is an arrangement that a party has with an enterprise that provides products to the party.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Detailed description of the party account" - }, - "href": { - "type": "string", - "description": "Reference of the party account" - }, - "id": { - "type": "string", - "description": "Unique identifier of the party account" - }, - "name": { - "type": "string", - "description": "Name of the party account" - }, - "status": { - "type": "string", - "description": "The condition of the account, such as due, paid, in arrears." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyAccountRef.schema.json", + "title": "PartyAccountRef", + "definitions": { + "PartyAccountRef": { + "$id": "#PartyAccountRef", + "description": "PartyAccount reference. A party account is an arrangement that a party has with an enterprise that provides products to the party.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Detailed description of the party account" + }, + "href": { + "type": "string", + "description": "Reference of the party account" + }, + "id": { + "type": "string", + "description": "Unique identifier of the party account" + }, + "name": { + "type": "string", + "description": "Name of the party account" + }, + "status": { + "type": "string", + "description": "The condition of the account, such as due, paid, in arrears." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/PartyBill.schema.json b/EngagedParty/PartyBill.schema.json index bb952f68..f630090c 100644 --- a/EngagedParty/PartyBill.schema.json +++ b/EngagedParty/PartyBill.schema.json @@ -1,117 +1,117 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyBill.schema.json", - "title": "PartyBill", - "definitions": { - "PartyBill": { - "$id": "#PartyBill", - "type": "object", - "properties": { - "amountDue": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Amount due for this bill expressed in the given currency" - }, - "billDate": { - "type": "string", - "format": "date-time", - "description": "Bill date" - }, - "billingPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Billing period of the bill (used for onCycle bill only)" - }, - "billNo": { - "type": "string", - "description": "Bill reference known by the customer or the party and displayed on the bill. Could be different from the id." - }, - "category": { - "type": "string", - "description": "Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note" - }, - "href": { - "type": "string", - "description": "Bill unique reference" - }, - "id": { - "type": "string", - "description": "Bill unique identifier" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date of bill last update" - }, - "nextBillDate": { - "type": "string", - "format": "date-time", - "description": "Approximate date of the next bill production given for information (only used for onCycle bill)" - }, - "paymentDueDate": { - "type": "string", - "format": "date-time", - "description": "Date at which the amount due should have been paid" - }, - "remainingAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Remaining amount to be paid for this bill expressed in the given currency" - }, - "runType": { - "type": "string", - "description": "onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close)" - }, - "state": { - "type": "string", - "description": "State that a bill could take during its lifecycle : New, Validated, On Hold, Sent, Partially paid or Settled" - }, - "taxExcludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Total tax excluded amount expressed in the given currency" - }, - "taxIncludedAmount": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Total tax included amount expressed in the given" - }, - "billDocument": { - "type": "array", - "items": { - "$ref": "../Common/FileDocument.schema.json#FileDocument" - }, - "description": "Document(s) associated to the bill" - }, - "paymentItem": { - "type": "array", - "items": { - "$ref": "../Customer/PaymentItem.schema.json#PaymentItem" - }, - "description": "Payment items already lettered on this bill." - }, - "billingAccount": { - "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" - }, - "taxItem": { - "type": "array", - "items": { - "$ref": "../Customer/TaxItem.schema.json#TaxItem" - } - }, - "paymentMethod": { - "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "financialAccount": { - "$ref": "FinancialAccountRef.schema.json#FinancialAccountRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyBill.schema.json", + "title": "PartyBill", + "definitions": { + "PartyBill": { + "$id": "#PartyBill", + "type": "object", + "properties": { + "amountDue": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Amount due for this bill expressed in the given currency" + }, + "billDate": { + "type": "string", + "format": "date-time", + "description": "Bill date" + }, + "billingPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Billing period of the bill (used for onCycle bill only)" + }, + "billNo": { + "type": "string", + "description": "Bill reference known by the customer or the party and displayed on the bill. Could be different from the id." + }, + "category": { + "type": "string", + "description": "Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note" + }, + "href": { + "type": "string", + "description": "Bill unique reference" + }, + "id": { + "type": "string", + "description": "Bill unique identifier" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date of bill last update" + }, + "nextBillDate": { + "type": "string", + "format": "date-time", + "description": "Approximate date of the next bill production given for information (only used for onCycle bill)" + }, + "paymentDueDate": { + "type": "string", + "format": "date-time", + "description": "Date at which the amount due should have been paid" + }, + "remainingAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Remaining amount to be paid for this bill expressed in the given currency" + }, + "runType": { + "type": "string", + "description": "onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close)" + }, + "state": { + "type": "string", + "description": "State that a bill could take during its lifecycle : New, Validated, On Hold, Sent, Partially paid or Settled" + }, + "taxExcludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Total tax excluded amount expressed in the given currency" + }, + "taxIncludedAmount": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Total tax included amount expressed in the given" + }, + "billDocument": { + "type": "array", + "items": { + "$ref": "../Common/FileDocument.schema.json#FileDocument" + }, + "description": "Document(s) associated to the bill" + }, + "paymentItem": { + "type": "array", + "items": { + "$ref": "../Customer/PaymentItem.schema.json#PaymentItem" + }, + "description": "Payment items already lettered on this bill." + }, + "billingAccount": { + "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" + }, + "taxItem": { + "type": "array", + "items": { + "$ref": "../Customer/TaxItem.schema.json#TaxItem" + } + }, + "paymentMethod": { + "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "financialAccount": { + "$ref": "../EngagedParty/FinancialAccountRef.schema.json#FinancialAccountRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/PartyCreditProfile.schema.json b/EngagedParty/PartyCreditProfile.schema.json index 7cbdf54b..d593faa9 100644 --- a/EngagedParty/PartyCreditProfile.schema.json +++ b/EngagedParty/PartyCreditProfile.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyCreditProfile.schema.json", - "title": "PartyCreditProfile", - "definitions": { - "PartyCreditProfile": { - "$id": "#PartyCreditProfile", - "type": "object", - "description": "An individual might be evaluated for its worthiness and this evaluation might be based on a credit rating given by a credit agency.", - "properties": { - "creditAgencyName": { - "type": "string", - "description": "Name of the credit agency giving the score" - }, - "creditAgencyType": { - "type": "string", - "description": "Type of the credit agency giving the score" - }, - "ratingReference": { - "type": "string", - "description": "Reference corresponding to the credit rating" - }, - "ratingScore": { - "type": "integer", - "format": "int32", - "description": "A measure of a party’s creditworthiness calculated on the basis of a combination of factors such as their income and credit history" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyCreditProfile.schema.json", + "title": "PartyCreditProfile", + "definitions": { + "PartyCreditProfile": { + "$id": "#PartyCreditProfile", + "type": "object", + "description": "An individual might be evaluated for its worthiness and this evaluation might be based on a credit rating given by a credit agency.", + "properties": { + "creditAgencyName": { + "type": "string", + "description": "Name of the credit agency giving the score" + }, + "creditAgencyType": { + "type": "string", + "description": "Type of the credit agency giving the score" + }, + "ratingReference": { + "type": "string", + "description": "Reference corresponding to the credit rating" + }, + "ratingScore": { + "type": "integer", + "format": "int32", + "description": "A measure of a party’s creditworthiness calculated on the basis of a combination of factors such as their income and credit history" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/PartyOrPartyRoleRef.schema.json b/EngagedParty/PartyOrPartyRoleRef.schema.json index cbb1f557..df777a76 100644 --- a/EngagedParty/PartyOrPartyRoleRef.schema.json +++ b/EngagedParty/PartyOrPartyRoleRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyOrPartyRoleRef.schema.json", - "title": "PartyOrPartyRoleRef", - "definitions": { - "PartyOrPartyRoleRef": { - "$id": "#PartyOrPartyRoleRef", - "description": "Party reference. A party represents an organization or an individual.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Text describing the referred party" - }, - "href": { - "type": "string", - "description": "Reference of the referred party (such as a partner or any other party role)." - }, - "id": { - "type": "string", - "description": "Unique identifier of the referred party" - }, - "name": { - "type": "string", - "description": "Name of the referred party (such as a partner or any other party role)" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyOrPartyRoleRef.schema.json", + "title": "PartyOrPartyRoleRef", + "definitions": { + "PartyOrPartyRoleRef": { + "$id": "#PartyOrPartyRoleRef", + "description": "Party reference. A party represents an organization or an individual.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Text describing the referred party" + }, + "href": { + "type": "string", + "description": "Reference of the referred party (such as a partner or any other party role)." + }, + "id": { + "type": "string", + "description": "Unique identifier of the referred party" + }, + "name": { + "type": "string", + "description": "Name of the referred party (such as a partner or any other party role)" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/PartyRef.schema.json b/EngagedParty/PartyRef.schema.json index 048a8cab..c2b34f3d 100644 --- a/EngagedParty/PartyRef.schema.json +++ b/EngagedParty/PartyRef.schema.json @@ -1,20 +1,20 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyRef.schema.json", - "title": "PartyRef", - "definitions": { - "PartyRef": { - "$id": "#PartyRef", - "type": "object", - "required": [ - "@referredType" - ], - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyRef.schema.json", + "title": "PartyRef", + "definitions": { + "PartyRef": { + "$id": "#PartyRef", + "type": "object", + "required": [ + "@referredType" + ], + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/PartyRole.schema.json b/EngagedParty/PartyRole.schema.json index e667941d..b7a3cb91 100644 --- a/EngagedParty/PartyRole.schema.json +++ b/EngagedParty/PartyRole.schema.json @@ -1,98 +1,93 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyRole.schema.json", - "title": "PartyRole", - "definitions": { - "required": { - "0": "name", - "1": "roleType", - "$id": "#required", - "type": "object" + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyRole.schema.json", + "title": "PartyRole", + "definitions": { + "PartyRole": { + "$id": "#PartyRole", + "description": "The part played by a party in a given context.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Url used to reference the party role." }, - "PartyRole": { - "$id": "#PartyRole", - "description": "The part played by a party in a given context.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Url used to reference the party role." - }, - "id": { - "type": "string", - "description": "Unique identifier for PartyRoles" - }, - "name": { - "type": "string", - "description": "A word, term, or phrase by which the PartyRole is known and distinguished from other PartyRoles." - }, - "status": { - "type": "string", - "description": "Used to track the lifecycle status of the party role." - }, - "statusReason": { - "type": "string", - "description": "A string providing an explanation on the value of the status lifecycle. For instance if the status is Rejected, statusReason will provide the reason for rejection." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The time period that the PartyRole is valid for." - }, - "engagedParty": { - "$ref": "PartyRef.schema.json#PartyRef" - }, - "roleType": { - "$ref": "RoleTypeRef.schema.json#RoleTypeRef" - }, - "account": { - "type": "array", - "items": { - "$ref": "AccountRef.schema.json#AccountRef" - } - }, - "paymentMethod": { - "type": "array", - "items": { - "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" - } - }, - "contactMedium": { - "type": "array", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - }, - "description": "Describes the characteristic of a party role." - }, - "creditProfile": { - "type": "array", - "items": { - "$ref": "../Customer/CreditProfile.schema.json#CreditProfile" - } - }, - "agreement": { - "type": "array", - "items": { - "$ref": "AgreementRef.schema.json#AgreementRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "id": { + "type": "string", + "description": "Unique identifier for PartyRoles" + }, + "name": { + "type": "string", + "description": "A word, term, or phrase by which the PartyRole is known and distinguished from other PartyRoles." + }, + "status": { + "type": "string", + "description": "Used to track the lifecycle status of the party role." + }, + "statusReason": { + "type": "string", + "description": "A string providing an explanation on the value of the status lifecycle. For instance if the status is Rejected, statusReason will provide the reason for rejection." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The time period that the PartyRole is valid for." + }, + "engagedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "account": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AccountRef.schema.json#AccountRef" + } + }, + "paymentMethod": { + "type": "array", + "items": { + "$ref": "../Customer/PaymentMethodRef.schema.json#PaymentMethodRef" + } + }, + "contactMedium": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + }, + "description": "Describes the characteristic of a party role." + }, + "creditProfile": { + "type": "array", + "items": { + "$ref": "../Customer/CreditProfile.schema.json#CreditProfile" + } + }, + "agreement": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" } + ], + "required": [ + "name", + "roleType" + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/PartyRoleRef.schema.json b/EngagedParty/PartyRoleRef.schema.json index 02225e14..3c89fa7c 100644 --- a/EngagedParty/PartyRoleRef.schema.json +++ b/EngagedParty/PartyRoleRef.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PartyRoleRef.schema.json", - "title": "PartyRoleRef", - "definitions": { - "PartyRoleRef": { - "$id": "#PartyRoleRef", - "description": "Party role reference. A party role represents the part played by a party in a given context.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product" - }, - "name": { - "type": "string", - "description": "The name of the referred party role." - }, - "partyId": { - "type": "string", - "description": "The identifier of the engaged party that is linked to the PartyRole object." - }, - "partyName": { - "type": "string", - "description": "The name of the engaged party that is linked to the PartyRole object." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PartyRoleRef.schema.json", + "title": "PartyRoleRef", + "definitions": { + "PartyRoleRef": { + "$id": "#PartyRoleRef", + "description": "Party role reference. A party role represents the part played by a party in a given context.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product" + }, + "name": { + "type": "string", + "description": "The name of the referred party role." + }, + "partyId": { + "type": "string", + "description": "The identifier of the engaged party that is linked to the PartyRole object." + }, + "partyName": { + "type": "string", + "description": "The name of the engaged party that is linked to the PartyRole object." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/RelatedParty.schema.json b/EngagedParty/RelatedParty.schema.json index f9da6484..90788122 100644 --- a/EngagedParty/RelatedParty.schema.json +++ b/EngagedParty/RelatedParty.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedParty.schema.json", - "title": "RelatedParty", - "definitions": { - "RelatedParty": { - "$id": "#RelatedParty", - "description": "Related Entity reference. A related party defines party or party role linked to a specific entity.", - "type": "object", - "required": [ - "id", - "@referredType" - ], - "properties": { - "role": { - "type": "string", - "description": "Role played by the related party" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedParty.schema.json", + "title": "RelatedParty", + "definitions": { + "RelatedParty": { + "$id": "#RelatedParty", + "description": "Related Entity reference. A related party defines party or party role linked to a specific entity.", + "type": "object", + "required": [ + "id", + "@referredType" + ], + "properties": { + "role": { + "type": "string", + "description": "Role played by the related party" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/RelatedPartyRef.schema.json b/EngagedParty/RelatedPartyRef.schema.json index 0ac59384..c8b3b93b 100644 --- a/EngagedParty/RelatedPartyRef.schema.json +++ b/EngagedParty/RelatedPartyRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedPartyRef.schema.json", - "title": "RelatedPartyRef", - "definitions": { - "RelatedPartyRef": { - "$id": "#RelatedPartyRef", - "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of a related party" - }, - "href": { - "type": "string", - "description": "Reference of the related party, could be a party reference or a party role reference" - }, - "name": { - "type": "string", - "description": "Name of the related party" - }, - "role": { - "type": "string", - "description": "Role of the related party." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedPartyRef.schema.json", + "title": "RelatedPartyRef", + "definitions": { + "RelatedPartyRef": { + "$id": "#RelatedPartyRef", + "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of a related party" + }, + "href": { + "type": "string", + "description": "Reference of the related party, could be a party reference or a party role reference" + }, + "name": { + "type": "string", + "description": "Name of the related party" + }, + "role": { + "type": "string", + "description": "Role of the related party." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/RelatedPartyRefOrValue.schema.json b/EngagedParty/RelatedPartyRefOrValue.schema.json index 629376f1..479266fc 100644 --- a/EngagedParty/RelatedPartyRefOrValue.schema.json +++ b/EngagedParty/RelatedPartyRefOrValue.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedPartyRefOrValue.schema.json", - "title": "RelatedPartyRefOrValue", - "definitions": { - "RelatedPartyRefOrValue": { - "discriminator": "isRef", - "$id": "#RelatedPartyRefOrValue", - "description": "Entity reference. A related party defines party or party role linked to a specific entity.", - "type": "object", - "properties": { - "isRef": { - "type": "boolean", - "default": true - }, - "role": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "Party.schema.json#Party" - }, - { - "$ref": "PartyRef.schema.json#PartyRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedPartyRefOrValue.schema.json", + "title": "RelatedPartyRefOrValue", + "definitions": { + "RelatedPartyRefOrValue": { + "discriminator": "isRef", + "$id": "#RelatedPartyRefOrValue", + "description": "Entity reference. A related party defines party or party role linked to a specific entity.", + "type": "object", + "properties": { + "isRef": { + "type": "boolean", + "default": true + }, + "role": { + "type": "string" } + }, + "allOf": [ + { + "$ref": "../EngagedParty/Party.schema.json#Party" + }, + { + "$ref": "../EngagedParty/PartyRef.schema.json#PartyRef" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/RoleSpecification.schema.json b/EngagedParty/RoleSpecification.schema.json new file mode 100644 index 00000000..3e5d9c6b --- /dev/null +++ b/EngagedParty/RoleSpecification.schema.json @@ -0,0 +1,44 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RoleSpecification.schema.json", + "title": "RoleSpecification", + "definitions": { + "RoleSpecification": { + "$id": "#RoleSpecification", + "description": "A RoleSpecification represents a specification of a role, which may be defined in the context of a given type of partnership (PartnershipSpecification), such as Buyer, Seller.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "description": { + "type": "string", + "description": "An explanatory text documenting the role specification" + }, + "name": { + "type": "string", + "description": "The name of the role specification. This name uniquely identifies the role specification within the partnership" + }, + "requiresBilling": { + "type": "boolean", + "description": "Indicates whether billing operations will be associated to parties playing the role" + }, + "requiresSettlement": { + "type": "boolean", + "description": "Indicates whether settlement operations will be associated to parties playing the role" + }, + "agreementSpecification": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementSpecificationRef.schema.json#AgreementSpecificationRef" + } + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] + } + } +} diff --git a/EngagedParty/RoleType.schema.json b/EngagedParty/RoleType.schema.json index 50c0453f..6de1b566 100644 --- a/EngagedParty/RoleType.schema.json +++ b/EngagedParty/RoleType.schema.json @@ -1,44 +1,44 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RoleType.schema.json", - "title": "RoleType", - "definitions": { - "RoleType": { - "$id": "#RoleType", - "description": "A RoleType represents the type of a PartyRole, defined in the context of a given type of partnership, such as Buyer, Seller.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "description": { - "type": "string", - "description": "An explanatory text documenting the role type" - }, - "name": { - "type": "string", - "description": "The name of the role type." - }, - "requiresBilling": { - "type": "boolean", - "description": "Indicates whether billing operations will be associated to parties playing the role" - }, - "requiresSettlement": { - "type": "boolean", - "description": "Indicates whether settlement operations will be associated to parties playing the role" - }, - "agreementSpecification": { - "type": "array", - "items": { - "$ref": "AgreementSpecificationRef.schema.json#AgreementSpecificationRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RoleType.schema.json", + "title": "RoleType", + "definitions": { + "RoleType": { + "$id": "#RoleType", + "description": "A RoleType represents the type of a PartyRole, defined in the context of a given type of partnership, such as Buyer, Seller.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "description": { + "type": "string", + "description": "An explanatory text documenting the role type" + }, + "name": { + "type": "string", + "description": "The name of the role type." + }, + "requiresBilling": { + "type": "boolean", + "description": "Indicates whether billing operations will be associated to parties playing the role" + }, + "requiresSettlement": { + "type": "boolean", + "description": "Indicates whether settlement operations will be associated to parties playing the role" + }, + "agreementSpecification": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementSpecificationRef.schema.json#AgreementSpecificationRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/RoleTypeRef.schema.json b/EngagedParty/RoleTypeRef.schema.json index 2972330f..3e0a2966 100644 --- a/EngagedParty/RoleTypeRef.schema.json +++ b/EngagedParty/RoleTypeRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RoleTypeRef.schema.json", - "title": "RoleTypeRef", - "definitions": { - "RoleTypeRef": { - "$id": "#RoleTypeRef", - "description": "RoleType reference.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the role type. It uniquely identifies the role type within the partnership type." - }, - "partnershipHref": { - "type": "string", - "description": "Reference url of the partnership type containing the role type" - }, - "partnershipId": { - "type": "string", - "description": "The identifier of the partnership type containing the role type" - }, - "partnershipName": { - "type": "string", - "description": "The name of the partnership type defining this role type" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RoleTypeRef.schema.json", + "title": "RoleTypeRef", + "definitions": { + "RoleTypeRef": { + "$id": "#RoleTypeRef", + "description": "RoleType reference.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the role type. It uniquely identifies the role type within the partnership type." + }, + "partnershipHref": { + "type": "string", + "description": "Reference url of the partnership type containing the role type" + }, + "partnershipId": { + "type": "string", + "description": "The identifier of the partnership type containing the role type" + }, + "partnershipName": { + "type": "string", + "description": "The name of the partnership type defining this role type" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/Rule.schema.json b/EngagedParty/Rule.schema.json index 0fb3a4ca..c5830e88 100644 --- a/EngagedParty/Rule.schema.json +++ b/EngagedParty/Rule.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Rule.schema.json", - "title": "Rule", - "definitions": { - "Rule": { - "$id": "#Rule", - "type": "object", - "properties": { - "consequence": { - "type": "string" - }, - "id": { - "type": "string" - }, - "metric": { - "type": "string" - }, - "operator": { - "type": "string" - }, - "referenceValue": { - "type": "string" - }, - "tolerance": { - "type": "string" - }, - "unit": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Rule.schema.json", + "title": "Rule", + "definitions": { + "Rule": { + "$id": "#Rule", + "type": "object", + "properties": { + "consequence": { + "type": "string" + }, + "id": { + "type": "string" + }, + "metric": { + "type": "string" + }, + "operator": { + "type": "string" + }, + "referenceValue": { + "type": "string" + }, + "tolerance": { + "type": "string" + }, + "unit": { + "type": "string" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/RuleRef.schema.json b/EngagedParty/RuleRef.schema.json index 4335827f..6516c2f1 100644 --- a/EngagedParty/RuleRef.schema.json +++ b/EngagedParty/RuleRef.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RuleRef.schema.json", - "title": "RuleRef", - "definitions": { - "RuleRef": { - "$id": "#RuleRef", - "description": "Rule reference. Rule is a common pattern or Template for the SLA parameters, metrics, and thresholds", - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "href": { - "type": "string", - "description": "The reference of the rule" - }, - "id": { - "type": "string", - "description": "The identifier of the referred rule" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RuleRef.schema.json", + "title": "RuleRef", + "definitions": { + "RuleRef": { + "$id": "#RuleRef", + "description": "Rule reference. Rule is a common pattern or Template for the SLA parameters, metrics, and thresholds", + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "href": { + "type": "string", + "description": "The reference of the rule" + }, + "id": { + "type": "string", + "description": "The identifier of the referred rule" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/SLA.schema.json b/EngagedParty/SLA.schema.json index 9842555d..6ebb65e2 100644 --- a/EngagedParty/SLA.schema.json +++ b/EngagedParty/SLA.schema.json @@ -1,69 +1,69 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SLA.schema.json", - "title": "SLA", - "definitions": { - "SLA": { - "$id": "#SLA", - "description": "Part of a business agreement between a Service Provider and a Customer, quantitatively specifying the service performance level the Service Provider commits to deliver.", - "type": "object", - "properties": { - "approvalDate": { - "type": "string", - "format": "date-time" - }, - "approved": { - "type": "boolean" - }, - "description": { - "type": "string", - "description": "Description of the Service Level Agreement (SLA)" - }, - "href": { - "type": "string", - "description": "Reference of the Service Level Agreement (SLA)" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Service Level Agreement (SLA)" - }, - "name": { - "type": "string", - "description": "Name of the Service Level Agreement (SLA)" - }, - "state": { - "type": "string", - "description": "State of the Service Level Agreement (SLA)" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Period where the clauses of the SLA are applicable" - }, - "version": { - "type": "string", - "description": "Version of the Service Level Agreement (SLA)" - }, - "rule": { - "type": "array", - "items": { - "$ref": "Rule.schema.json#Rule" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "template": { - "$ref": "TemplateRef.schema.json#TemplateRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SLA.schema.json", + "title": "SLA", + "definitions": { + "SLA": { + "$id": "#SLA", + "description": "Part of a business agreement between a Service Provider and a Customer, quantitatively specifying the service performance level the Service Provider commits to deliver.", + "type": "object", + "properties": { + "approvalDate": { + "type": "string", + "format": "date-time" + }, + "approved": { + "type": "boolean" + }, + "description": { + "type": "string", + "description": "Description of the Service Level Agreement (SLA)" + }, + "href": { + "type": "string", + "description": "Reference of the Service Level Agreement (SLA)" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Service Level Agreement (SLA)" + }, + "name": { + "type": "string", + "description": "Name of the Service Level Agreement (SLA)" + }, + "state": { + "type": "string", + "description": "State of the Service Level Agreement (SLA)" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Period where the clauses of the SLA are applicable" + }, + "version": { + "type": "string", + "description": "Version of the Service Level Agreement (SLA)" + }, + "rule": { + "type": "array", + "items": { + "$ref": "../EngagedParty/Rule.schema.json#Rule" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "template": { + "$ref": "../EngagedParty/TemplateRef.schema.json#TemplateRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/SLARef.schema.json b/EngagedParty/SLARef.schema.json index fc2c78a1..2b1efddf 100644 --- a/EngagedParty/SLARef.schema.json +++ b/EngagedParty/SLARef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SLARef.schema.json", - "title": "SLARef", - "definitions": { - "SLARef": { - "$id": "#SLARef", - "description": "ServiceLevelAgreement reference: A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so forth. The SLA is a set of appropriate procedures and targets formally or informally agreed between parties in order to achieve and maintain specified Quality of Service.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the service level agreement" - }, - "id": { - "type": "string", - "description": "Unique identifier of service level agreement" - }, - "name": { - "type": "string", - "description": "Name of the service level agreement" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SLARef.schema.json", + "title": "SLARef", + "definitions": { + "SLARef": { + "$id": "#SLARef", + "description": "ServiceLevelAgreement reference: A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so forth. The SLA is a set of appropriate procedures and targets formally or informally agreed between parties in order to achieve and maintain specified Quality of Service.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the service level agreement" + }, + "id": { + "type": "string", + "description": "Unique identifier of service level agreement" + }, + "name": { + "type": "string", + "description": "Name of the service level agreement" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/SLAViolation.schema.json b/EngagedParty/SLAViolation.schema.json index 7e9a29ee..6538b987 100644 --- a/EngagedParty/SLAViolation.schema.json +++ b/EngagedParty/SLAViolation.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SLAViolation.schema.json", - "title": "SLAViolation", - "definitions": { - "SLAViolation": { - "$id": "#SLAViolation", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time" - }, - "href": { - "type": "string" - }, - "id": { - "type": "string" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "RelatedParty.schema.json#RelatedParty" - } - }, - "violation": { - "$ref": "Violation.schema.json#Violation" - }, - "sla": { - "$ref": "SLARef.schema.json#SLARef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SLAViolation.schema.json", + "title": "SLAViolation", + "definitions": { + "SLAViolation": { + "$id": "#SLAViolation", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "href": { + "type": "string" + }, + "id": { + "type": "string" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "violation": { + "$ref": "../EngagedParty/Violation.schema.json#Violation" + }, + "sla": { + "$ref": "../EngagedParty/SLARef.schema.json#SLARef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/SLAViolationRef.schema.json b/EngagedParty/SLAViolationRef.schema.json index 1a2b1592..a7cd42c3 100755 --- a/EngagedParty/SLAViolationRef.schema.json +++ b/EngagedParty/SLAViolationRef.schema.json @@ -1,28 +1,28 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SLAViolationRef.schema.json", - "title": "SLAViolationRef", - "definitions": { - "SLAViolationRef": { - "$id": "#SLAViolationRef", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "id": { - "type": "string" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SLAViolationRef.schema.json", + "title": "SLAViolationRef", + "definitions": { + "SLAViolationRef": { + "$id": "#SLAViolationRef", + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "id": { + "type": "string" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/SettlementAccount.schema.json b/EngagedParty/SettlementAccount.schema.json index d3a0e1f6..75ff5a50 100644 --- a/EngagedParty/SettlementAccount.schema.json +++ b/EngagedParty/SettlementAccount.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SettlementAccount.schema.json", - "title": "SettlementAccount", - "definitions": { - "SettlementAccount": { - "$id": "#SettlementAccount", - "description": "A party account used for settlement purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.", - "type": "object", - "required": [ - "name", - "relatedParty" - ], - "properties": {}, - "allOf": [ - { - "$ref": "PartyAccount.schema.json#PartyAccount" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SettlementAccount.schema.json", + "title": "SettlementAccount", + "definitions": { + "SettlementAccount": { + "$id": "#SettlementAccount", + "description": "A party account used for settlement purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.", + "type": "object", + "required": [ + "name", + "relatedParty" + ], + "properties": {}, + "allOf": [ + { + "$ref": "../EngagedParty/PartyAccount.schema.json#PartyAccount" } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/Skill.schema.json b/EngagedParty/Skill.schema.json index 6cef6d4c..9d5b7155 100644 --- a/EngagedParty/Skill.schema.json +++ b/EngagedParty/Skill.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Skill.schema.json", - "title": "Skill", - "definitions": { - "Skill": { - "$id": "#Skill", - "type": "object", - "description": "Skills evaluated for an individual with a level and possibly with a limited validity when an obsolescence is defined (Ex: the first-aid certificate first level is limited to one year and an update training is required each year to keep the level).", - "properties": { - "skillCode": { - "type": "string", - "description": "Code of the skill" - }, - "skillName": { - "type": "string", - "description": "Name of the skill such as Java language,…" - }, - "evaluatedLevel": { - "type": "string", - "description": "Level of expertise in a skill evaluated for an individual" - }, - "comment": { - "type": "string", - "description": "A free text comment linked to the evaluation done" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Skill.schema.json", + "title": "Skill", + "definitions": { + "Skill": { + "$id": "#Skill", + "type": "object", + "description": "Skills evaluated for an individual with a level and possibly with a limited validity when an obsolescence is defined (Ex: the first-aid certificate first level is limited to one year and an update training is required each year to keep the level).", + "properties": { + "skillCode": { + "type": "string", + "description": "Code of the skill" + }, + "skillName": { + "type": "string", + "description": "Name of the skill such as Java language,…" + }, + "evaluatedLevel": { + "type": "string", + "description": "Level of expertise in a skill evaluated for an individual" + }, + "comment": { + "type": "string", + "description": "A free text comment linked to the evaluation done" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/TaxExemptionCertificate.schema.json b/EngagedParty/TaxExemptionCertificate.schema.json index 8b5dfbf6..a02c7730 100644 --- a/EngagedParty/TaxExemptionCertificate.schema.json +++ b/EngagedParty/TaxExemptionCertificate.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TaxExemptionCertificate.schema.json", - "title": "TaxExemptionCertificate", - "definitions": { - "TaxExemptionCertificate": { - "$id": "#TaxExemptionCertificate", - "type": "object", - "description": "A tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the certificate of the tax exemption" - }, - "taxDefinition": { - "type": "array", - "items": { - "$ref": "../Common/TaxDefinition.schema.json#TaxDefinition" - } - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - }, - "attachment": { - "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TaxExemptionCertificate.schema.json", + "title": "TaxExemptionCertificate", + "definitions": { + "TaxExemptionCertificate": { + "$id": "#TaxExemptionCertificate", + "type": "object", + "description": "A tax exemption certificate represents a tax exemption granted to a party (individual or organization) by a tax jurisdiction which may be a city, state, country,... An exemption has a certificate identifier (received from the jurisdiction that levied the tax) and a validity period. An exemption is per tax types and determines for each type of tax what portion of the tax is exempted (partial by percentage or complete) via the tax definition.", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the certificate of the tax exemption" + }, + "taxDefinition": { + "type": "array", + "items": { + "$ref": "../Common/TaxDefinition.schema.json#TaxDefinition" + } + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + }, + "attachment": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/TemplateRef.schema.json b/EngagedParty/TemplateRef.schema.json index 4cd7f4d3..9a045c45 100644 --- a/EngagedParty/TemplateRef.schema.json +++ b/EngagedParty/TemplateRef.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TemplateRef.schema.json", - "title": "TemplateRef", - "definitions": { - "TemplateRef": { - "$id": "#TemplateRef", - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "href": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TemplateRef.schema.json", + "title": "TemplateRef", + "definitions": { + "TemplateRef": { + "$id": "#TemplateRef", + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "href": { + "type": "string" + }, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/EngagedParty/Violation.schema.json b/EngagedParty/Violation.schema.json index 2c3a4cf4..099b1e47 100644 --- a/EngagedParty/Violation.schema.json +++ b/EngagedParty/Violation.schema.json @@ -1,48 +1,48 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Violation.schema.json", - "title": "Violation", - "definitions": { - "Violation": { - "$id": "#Violation", - "type": "object", - "properties": { - "actualValue": { - "type": "string" - }, - "comment": { - "type": "string" - }, - "consequence": { - "type": "string" - }, - "operator": { - "type": "string" - }, - "referenceValue": { - "type": "string" - }, - "tolerance": { - "type": "string" - }, - "unit": { - "type": "string" - }, - "violationAverage": { - "type": "string" - }, - "attachment": { - "$ref": "../Common/AttachmentRef.schema.json#AttachmentRef" - }, - "rule": { - "$ref": "RuleRef.schema.json#RuleRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Violation.schema.json", + "title": "Violation", + "definitions": { + "Violation": { + "$id": "#Violation", + "type": "object", + "properties": { + "actualValue": { + "type": "string" + }, + "comment": { + "type": "string" + }, + "consequence": { + "type": "string" + }, + "operator": { + "type": "string" + }, + "referenceValue": { + "type": "string" + }, + "tolerance": { + "type": "string" + }, + "unit": { + "type": "string" + }, + "violationAverage": { + "type": "string" + }, + "attachment": { + "$ref": "../Common/AttachmentRef.schema.json#AttachmentRef" + }, + "rule": { + "$ref": "../EngagedParty/RuleRef.schema.json#RuleRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/MarketingSales/MarketSegmentRef.schema.json b/MarketingSales/MarketSegmentRef.schema.json index b16efcd9..3136e02b 100644 --- a/MarketingSales/MarketSegmentRef.schema.json +++ b/MarketingSales/MarketSegmentRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "MarketSegmentRef.schema.json", - "title": "MarketSegmentRef", - "definitions": { - "MarketSegmentRef": { - "$id": "#MarketSegmentRef", - "type": "object", - "description": "provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth.", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the market segment" - }, - "href": { - "type": "string", - "description": "Reference of the market segment" - }, - "name": { - "type": "string", - "description": "Name of the market segment" - }, - "@referredType": { - "type": "string", - "description": "(Class) type of the referred market segment" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "MarketSegmentRef.schema.json", + "title": "MarketSegmentRef", + "definitions": { + "MarketSegmentRef": { + "$id": "#MarketSegmentRef", + "type": "object", + "description": "provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth.", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the market segment" + }, + "href": { + "type": "string", + "description": "Reference of the market segment" + }, + "name": { + "type": "string", + "description": "Name of the market segment" + }, + "@referredType": { + "type": "string", + "description": "(Class) type of the referred market segment" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/MarketingSales/MarketingCampaignRef.schema.json b/MarketingSales/MarketingCampaignRef.schema.json index c6c77ea0..3fe69957 100644 --- a/MarketingSales/MarketingCampaignRef.schema.json +++ b/MarketingSales/MarketingCampaignRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "MarketingCampaignRef.schema.json", - "title": "MarketingCampaignRef", - "definitions": { - "MarketingCampaignRef": { - "$id": "#MarketingCampaignRef", - "description": "MarketingCampaign reference. Marketing campaign represents the carrier-initiated marketing activity which aims at the better recognition about its brand and offerings by the market", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "MarketingCampaignRef.schema.json", + "title": "MarketingCampaignRef", + "definitions": { + "MarketingCampaignRef": { + "$id": "#MarketingCampaignRef", + "description": "MarketingCampaign reference. Marketing campaign represents the carrier-initiated marketing activity which aims at the better recognition about its brand and offerings by the market", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} \ No newline at end of file + } +} diff --git a/MarketingSales/SalesLead.schema.json b/MarketingSales/SalesLead.schema.json index f4cfd7f6..6122a887 100644 --- a/MarketingSales/SalesLead.schema.json +++ b/MarketingSales/SalesLead.schema.json @@ -1,120 +1,120 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SalesLead.schema.json", - "title": "SalesLead", - "definitions": { - "SalesLead": { - "$id": "#SalesLead", - "description": "A Sales Lead is the identification of a person or organization that has an interest in the goods and/or services provided in the prospect of them becoming Customers with one or more Subscriptions.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the salesLead" - }, - "id": { - "type": "string", - "description": "Unique identifier of the salesLead" - }, - "name": { - "type": "string", - "description": "Name of the salesLead" - }, - "description": { - "type": "string", - "description": "Unique description of the salesLead" - }, - "status": { - "$ref": "SalesLeadStateType.schema.json#/definitions/SalesLeadStateType" - }, - "statusChangeDate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the salesLead creation" - }, - "referredDate": { - "type": "string", - "format": "date-time", - "description": "Date when the prospect information was received (for example, from a trade show)." - }, - "statusChangeReason": { - "type": "string", - "description": "Reason why the status has changed" - }, - "type": { - "type": "string", - "description": "Indicates the nature of the salesLead" - }, - "rating": { - "type": "string", - "description": "Identifies the potential of a salesLead for becoming a sale. Usual ratings for qualified leads are: hot, warm, cold." - }, - "priority": { - "$ref": "SalesLeadPriorityType.schema.json#/definitions/SalesLeadPriorityType" - }, - "estimatedRevenue": { - "$ref": "../Common/Money.schema.json#Money", - "description": "Estimation of the revenue if the salesLead turns into a sale." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the salesLead is valid" - }, - "marketingCampaign": { - "$ref": "MarketingCampaignRef.schema.json#MarketingCampaignRef", - "description": "Campaign represents the carrier-initiated marketing activity which aims at the better recognition about its brand and offerings by the market." - }, - "marketSegment": { - "$ref": "MarketSegmentRef.schema.json#MarketSegmentRef", - "description": "MarketSegment reference. A Market Segment is a grouping of Parties, GeographicAreas, SalesChannels, and so forth. MarketSegments are the target of MarketingCampaigns, ProductOfferings, ProductPromotions, ProductPlacements, and ProductPrograms from both internal and external (Competitors, and other Providers) perspective." - }, - "channel": { - "$ref": "../Common/ChannelRef.schema.json#ChannelRef" - }, - "productOffering": { - "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "prospectContact": { - "type": "array", - "items": { - "$ref": "../Common/ContactMedium.schema.json#ContactMedium" - } - }, - "productSpecification": { - "$ref": "../Product/ProductSpecificationRef.schema.json#ProductSpecificationRef" - }, - "category": { - "$ref": "../Product/CategoryRef.schema.json#CategoryRef" - }, - "salesOpportunity": { - "$ref": "SalesOpportunityRef.schema.json#SalesOpportunityRef" - }, - "product": { - "$ref": "../Product/ProductRef.schema.json#ProductRef" - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SalesLead.schema.json", + "title": "SalesLead", + "definitions": { + "SalesLead": { + "$id": "#SalesLead", + "description": "A Sales Lead is the identification of a person or organization that has an interest in the goods and/or services provided in the prospect of them becoming Customers with one or more Subscriptions.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the salesLead" + }, + "id": { + "type": "string", + "description": "Unique identifier of the salesLead" + }, + "name": { + "type": "string", + "description": "Name of the salesLead" + }, + "description": { + "type": "string", + "description": "Unique description of the salesLead" + }, + "status": { + "$ref": "../MarketingSales/SalesLeadStateType.schema.json#SalesLeadStateType" + }, + "statusChangeDate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the salesLead creation" + }, + "referredDate": { + "type": "string", + "format": "date-time", + "description": "Date when the prospect information was received (for example, from a trade show)." + }, + "statusChangeReason": { + "type": "string", + "description": "Reason why the status has changed" + }, + "type": { + "type": "string", + "description": "Indicates the nature of the salesLead" + }, + "rating": { + "type": "string", + "description": "Identifies the potential of a salesLead for becoming a sale. Usual ratings for qualified leads are: hot, warm, cold." + }, + "priority": { + "$ref": "../MarketingSales/SalesLeadPriorityType.schema.json#SalesLeadPriorityType" + }, + "estimatedRevenue": { + "$ref": "../Common/Money.schema.json#Money", + "description": "Estimation of the revenue if the salesLead turns into a sale." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the salesLead is valid" + }, + "marketingCampaign": { + "$ref": "../MarketingSales/MarketingCampaignRef.schema.json#MarketingCampaignRef", + "description": "Campaign represents the carrier-initiated marketing activity which aims at the better recognition about its brand and offerings by the market." + }, + "marketSegment": { + "$ref": "../MarketingSales/MarketSegmentRef.schema.json#MarketSegmentRef", + "description": "MarketSegment reference. A Market Segment is a grouping of Parties, GeographicAreas, SalesChannels, and so forth. MarketSegments are the target of MarketingCampaigns, ProductOfferings, ProductPromotions, ProductPlacements, and ProductPrograms from both internal and external (Competitors, and other Providers) perspective." + }, + "channel": { + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "productOffering": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "prospectContact": { + "type": "array", + "items": { + "$ref": "../Common/ContactMedium.schema.json#ContactMedium" + } + }, + "productSpecification": { + "$ref": "../Product/ProductSpecificationRef.schema.json#ProductSpecificationRef" + }, + "category": { + "$ref": "../Product/CategoryRef.schema.json#CategoryRef" + }, + "salesOpportunity": { + "$ref": "../MarketingSales/SalesOpportunityRef.schema.json#SalesOpportunityRef" + }, + "product": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/MarketingSales/SalesLeadPriorityType.schema.json b/MarketingSales/SalesLeadPriorityType.schema.json new file mode 100644 index 00000000..754889d9 --- /dev/null +++ b/MarketingSales/SalesLeadPriorityType.schema.json @@ -0,0 +1,17 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SalesLeadPriorityType.schema.json", + "title": "SalesLeadPriorityType", + "definitions": { + "SalesLeadPriorityType": { + "$id": "#SalesLeadPriorityType", + "type": "string", + "description": "Urgency of working this salesLead", + "enum": [ + "low", + "medium", + "high" + ] + } + } +} diff --git a/MarketingSales/SalesLeadStateType.schema.json b/MarketingSales/SalesLeadStateType.schema.json new file mode 100644 index 00000000..952cee59 --- /dev/null +++ b/MarketingSales/SalesLeadStateType.schema.json @@ -0,0 +1,20 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SalesLeadStateType.schema.json", + "title": "SalesLeadStateType", + "definitions": { + "SalesLeadStateType": { + "$id": "#SalesLeadStateType", + "type": "string", + "description": "Valid values for the lifecycle state of a salesLead resource", + "enum": [ + "accepted", + "acknowledged", + "cancelled", + "inProgress", + "pending", + "rejected" + ] + } + } +} diff --git a/MarketingSales/SalesOpportunityRef.schema.json b/MarketingSales/SalesOpportunityRef.schema.json index a4e225e3..872d2d31 100644 --- a/MarketingSales/SalesOpportunityRef.schema.json +++ b/MarketingSales/SalesOpportunityRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SalesOpportunityRef.schema.json", - "title": "SalesOpportunityRef", - "definitions": { - "SalesOpportunityRef": { - "$id": "#SalesOpportunityRef", - "description": "Sales Opportunity is an 'opportunity' to generate revenue from a Sales Account or Sales Lead. Opportunities are the pending deals that need to be tracked and on which Sales Team plans and executes Sales Activities (Events and Tasks). ", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SalesOpportunityRef.schema.json", + "title": "SalesOpportunityRef", + "definitions": { + "SalesOpportunityRef": { + "$id": "#SalesOpportunityRef", + "description": "Sales Opportunity is an 'opportunity' to generate revenue from a Sales Account or Sales Lead. Opportunities are the pending deals that need to be tracked and on which Sales Team plans and executes Sales Activities (Events and Tasks). ", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} \ No newline at end of file + } +} diff --git a/Product/AlternateProduct.schema.json b/Product/AlternateProduct.schema.json new file mode 100644 index 00000000..d8d1b39f --- /dev/null +++ b/Product/AlternateProduct.schema.json @@ -0,0 +1,51 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AlternateProduct.schema.json", + "title": "AlternateProduct", + "definitions": { + "AlternateProduct": { + "$id": "#AlternateProduct", + "description": "In the context of a product offering qualification, this data structure is useful to describe alternate product than can be proposed", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product" + }, + "isRef": { + "type": "boolean", + "default": true, + "description": "indicate if ref pattern is used" + }, + "name": { + "type": "string", + "description": "This is the name of the product." + }, + "productCharacteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "productRelationship": { + "type": "array", + "items": { + "$ref": "../Product/ProductRelationship.schema.json#ProductRelationship" + } + }, + "productSpecification": { + "$ref": "../Product/ProductSpecificationRef.schema.json#ProductSpecificationRef" + } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] + } + } +} diff --git a/Product/AlternateProductOfferingProposal.schema.json b/Product/AlternateProductOfferingProposal.schema.json index 3fecb617..1b4f5b40 100644 --- a/Product/AlternateProductOfferingProposal.schema.json +++ b/Product/AlternateProductOfferingProposal.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AlternateProductOfferingProposal.schema.json", - "title": "AlternateProductOfferingProposal", - "definitions": { - "AlternateProductOfferingProposal": { - "$id": "#AlternateProductOfferingProposal", - "description": "Alternate product Offering proposal is used when the requested product offering is not available with characteristic and date asked for. An alternate proposal could be a distinct product offering or product Spec close to requested one or same as requested but with a different activation date.", - "type": "object", - "properties": { - "alternateActivationDate": { - "type": "string", - "format": "date-time", - "description": "Alternate activation date in case seller is not able to meet requested expected activation date." - }, - "id": { - "type": "string", - "description": "Identifier of a alternate product offering proposal" - }, - "alternateProduct": { - "$ref": "ProductRefOrValue.schema.json#ProductRefOrValue", - "description": "Alternate product proposal" - }, - "alternateProductOffering": { - "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef", - "description": "Alternate product offering proposal" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AlternateProductOfferingProposal.schema.json", + "title": "AlternateProductOfferingProposal", + "definitions": { + "AlternateProductOfferingProposal": { + "$id": "#AlternateProductOfferingProposal", + "description": "Alternate product Offering proposal is used when the requested product offering is not available with characteristic and date asked for. An alternate proposal could be a distinct product offering or product Spec close to requested one or same as requested but with a different activation date.", + "type": "object", + "properties": { + "alternateActivationDate": { + "type": "string", + "format": "date-time", + "description": "Alternate activation date in case seller is not able to meet requested expected activation date." + }, + "id": { + "type": "string", + "description": "Identifier of a alternate product offering proposal" + }, + "alternateProduct": { + "$ref": "../Product/ProductRefOrValue.schema.json#ProductRefOrValue", + "description": "Alternate product proposal" + }, + "alternateProductOffering": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef", + "description": "Alternate product offering proposal" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/BaseProductRefOrValue.schema.json b/Product/BaseProductRefOrValue.schema.json index f59d9f01..762812c4 100644 --- a/Product/BaseProductRefOrValue.schema.json +++ b/Product/BaseProductRefOrValue.schema.json @@ -1,79 +1,79 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BaseProductRefOrValue.schema.json", - "title": "BaseProductRefOrValue", - "definitions": { - "BaseProductRefOrValue": { - "$id": "#BaseProductRefOrValue", - "description": "In the context of a product order or a product offering qualification, this data structure captures the product information useful to order or qualified an existing subscribed product or to a new one. This is a subset of relevant product attributes for ordering and qualification", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product" - }, - "isRef": { - "type": "boolean", - "default": true, - "description": "indicate if ref pattern is used" - }, - "name": { - "type": "string", - "description": "This is the name of the product." - }, - "productCharacteristic": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - } - }, - "realizingResource": { - "type": "array", - "items": { - "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" - } - }, - "realizingService": { - "type": "array", - "items": { - "$ref": "../Service/ServiceRef.schema.json#ServiceRef" - } - }, - "isBundle": { - "type": "boolean", - "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." - }, - "productRelationship": { - "type": "array", - "items": { - "$ref": "ProductRelationship.schema.json#ProductRelationship" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "productSpecification": { - "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef" - }, - "relatedPlace": { - "type": "array", - "items": { - "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BaseProductRefOrValue.schema.json", + "title": "BaseProductRefOrValue", + "definitions": { + "BaseProductRefOrValue": { + "$id": "#BaseProductRefOrValue", + "description": "In the context of a product order or a product offering qualification, this data structure captures the product information useful to order or qualified an existing subscribed product or to a new one. This is a subset of relevant product attributes for ordering and qualification", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product" + }, + "isRef": { + "type": "boolean", + "default": true, + "description": "indicate if ref pattern is used" + }, + "name": { + "type": "string", + "description": "This is the name of the product." + }, + "productCharacteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "realizingResource": { + "type": "array", + "items": { + "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" + } + }, + "realizingService": { + "type": "array", + "items": { + "$ref": "../Service/ServiceRef.schema.json#ServiceRef" + } + }, + "isBundle": { + "type": "boolean", + "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." + }, + "productRelationship": { + "type": "array", + "items": { + "$ref": "../Product/ProductRelationship.schema.json#ProductRelationship" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "productSpecification": { + "$ref": "../Product/ProductSpecificationRef.schema.json#ProductSpecificationRef" + }, + "relatedPlace": { + "type": "array", + "items": { + "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/BundledProductOffering.schema.json b/Product/BundledProductOffering.schema.json index eedbdaa6..487eed9f 100644 --- a/Product/BundledProductOffering.schema.json +++ b/Product/BundledProductOffering.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BundledProductOffering.schema.json", - "title": "BundledProductOffering", - "definitions": { - "BundledProductOffering": { - "$id": "#BundledProductOffering", - "type": "object", - "description": "A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering.", - "properties": { - "href": { - "type": "string", - "description": "Unique reference of the BundledProductOffering" - }, - "id": { - "type": "string", - "description": "Unique identifier of the BundledProductOffering" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the BundledProductOffering" - }, - "bundledProductOfferingOption": { - "$ref": "BundledProductOfferingOption.schema.json#BundledProductOfferingOption", - "description": "A set of numbers that specifies the lower and upper limits for a ProductOffering that can be procured as part of the related BundledProductOffering. Values can range from 0 to unbounded." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BundledProductOffering.schema.json", + "title": "BundledProductOffering", + "definitions": { + "BundledProductOffering": { + "$id": "#BundledProductOffering", + "type": "object", + "description": "A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering.", + "properties": { + "href": { + "type": "string", + "description": "Unique reference of the BundledProductOffering" + }, + "id": { + "type": "string", + "description": "Unique identifier of the BundledProductOffering" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the BundledProductOffering" + }, + "bundledProductOfferingOption": { + "$ref": "../Product/BundledProductOfferingOption.schema.json#BundledProductOfferingOption", + "description": "A set of numbers that specifies the lower and upper limits for a ProductOffering that can be procured as part of the related BundledProductOffering. Values can range from 0 to unbounded." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/BundledProductOfferingOption.schema.json b/Product/BundledProductOfferingOption.schema.json index 619efb4a..f854cb69 100644 --- a/Product/BundledProductOfferingOption.schema.json +++ b/Product/BundledProductOfferingOption.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BundledProductOfferingOption.schema.json", - "title": "BundledProductOfferingOption", - "definitions": { - "BundledProductOfferingOption": { - "$id": "#BundledProductOfferingOption", - "type": "object", - "description": "A set of numbers that specifies the lower and upper limits for a ProductOffering that can be procured as part of the related BundledProductOffering. Values can range from 0 to unbounded", - "properties": { - "numberRelOfferDefault": { - "type": "integer", - "description": "Default number of produc offereings that should be procured as part of the related BundledProductOffering" - }, - "numberRelOfferLowerLimit": { - "type": "integer", - "description": "lower limit for a product offering that can be procured as part of the related BundledProductOffering" - }, - "numberRelOfferUpperLimit": { - "type": "integer", - "description": "upper limit for a product offering that can be procured as part of the related BundledProductOffering" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BundledProductOfferingOption.schema.json", + "title": "BundledProductOfferingOption", + "definitions": { + "BundledProductOfferingOption": { + "$id": "#BundledProductOfferingOption", + "type": "object", + "description": "A set of numbers that specifies the lower and upper limits for a ProductOffering that can be procured as part of the related BundledProductOffering. Values can range from 0 to unbounded", + "properties": { + "numberRelOfferDefault": { + "type": "integer", + "description": "Default number of produc offereings that should be procured as part of the related BundledProductOffering" + }, + "numberRelOfferLowerLimit": { + "type": "integer", + "description": "lower limit for a product offering that can be procured as part of the related BundledProductOffering" + }, + "numberRelOfferUpperLimit": { + "type": "integer", + "description": "upper limit for a product offering that can be procured as part of the related BundledProductOffering" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/BundledProductOfferingPriceRelationship.schema.json b/Product/BundledProductOfferingPriceRelationship.schema.json index 398a62e1..3cdaaa0f 100644 --- a/Product/BundledProductOfferingPriceRelationship.schema.json +++ b/Product/BundledProductOfferingPriceRelationship.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BundledProductOfferingPriceRelationship.schema.json", - "title": "BundledProductOfferingPriceRelationship", - "definitions": { - "BundledProductOfferingPriceRelationship": { - "$id": "#BundledProductOfferingPriceRelationship", - "type": "object", - "description": "This represents a bundling pricing relationship, allowing a price to be composed of multiple other prices (e.g. a recurring charge and a onetime charge).", - "properties": { - "href": { - "type": "string", - "description": "hyperlink reference of the bundled product offering price" - }, - "id": { - "type": "string", - "description": "Unique identifier of the bundled product offering price" - }, - "name": { - "type": "string", - "description": "Name of the bundled product offering price" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BundledProductOfferingPriceRelationship.schema.json", + "title": "BundledProductOfferingPriceRelationship", + "definitions": { + "BundledProductOfferingPriceRelationship": { + "$id": "#BundledProductOfferingPriceRelationship", + "type": "object", + "description": "This represents a bundling pricing relationship, allowing a price to be composed of multiple other prices (e.g. a recurring charge and a onetime charge).", + "properties": { + "href": { + "type": "string", + "description": "hyperlink reference of the bundled product offering price" + }, + "id": { + "type": "string", + "description": "Unique identifier of the bundled product offering price" + }, + "name": { + "type": "string", + "description": "Name of the bundled product offering price" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/BundledProductOfferingRef.schema.json b/Product/BundledProductOfferingRef.schema.json index 45933a5b..07c83e67 100644 --- a/Product/BundledProductOfferingRef.schema.json +++ b/Product/BundledProductOfferingRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BundledProductOfferingRef.schema.json", - "title": "BundledProductOfferingRef", - "definitions": { - "BundledProductOfferingRef": { - "$id": "#BundledProductOfferingRef", - "description": "BundledProductOffering Reference. A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the product offering" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product offering" - }, - "name": { - "type": "string", - "description": "Name of the product offering" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BundledProductOfferingRef.schema.json", + "title": "BundledProductOfferingRef", + "definitions": { + "BundledProductOfferingRef": { + "$id": "#BundledProductOfferingRef", + "description": "BundledProductOffering Reference. A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the product offering" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product offering" + }, + "name": { + "type": "string", + "description": "Name of the product offering" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/BundledProductSpecification.schema.json b/Product/BundledProductSpecification.schema.json index 4773d80c..734858cf 100644 --- a/Product/BundledProductSpecification.schema.json +++ b/Product/BundledProductSpecification.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BundledProductSpecification.schema.json", - "title": "BundledProductSpecification", - "definitions": { - "BundledProductSpecification": { - "$id": "#BundledProductSpecification", - "description": "A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the product specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product specification" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the product specification" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BundledProductSpecification.schema.json", + "title": "BundledProductSpecification", + "definitions": { + "BundledProductSpecification": { + "$id": "#BundledProductSpecification", + "description": "A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the product specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product specification" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the product specification" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/CancelOrder.schema.json b/Product/CancelOrder.schema.json index e670fbf4..cf462bb3 100644 --- a/Product/CancelOrder.schema.json +++ b/Product/CancelOrder.schema.json @@ -1,45 +1,45 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CancelOrder.schema.json", - "title": "CancelOrder", - "definitions": { - "CancelOrder": { - "$id": "#CancelOrder", - "description": "A Order cancel is a type of task which can be used to place a request to cancel an order", - "type": "object", - "properties": { - "requestedCancellationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the submitter wants the order to be cancelled" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the cancellation request" - }, - "id": { - "type": "string", - "description": "id of the cancellation request (this is not an order id)" - }, - "effectiveCancellationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order is cancelled." - }, - "cancellationReason": { - "type": "string", - "description": "Reason why the order is cancelled." - }, - "state": { - "description": "Tracks the lifecycle status of the cancellation request, such as Acknowledged, Rejected, InProgress, Pending and so on.", - "$ref": "../Common/TaskStateType.schema.json#TaskStateType" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CancelOrder.schema.json", + "title": "CancelOrder", + "definitions": { + "CancelOrder": { + "$id": "#CancelOrder", + "description": "A Order cancel is a type of task which can be used to place a request to cancel an order", + "type": "object", + "properties": { + "requestedCancellationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the submitter wants the order to be cancelled" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the cancellation request" + }, + "id": { + "type": "string", + "description": "id of the cancellation request (this is not an order id)" + }, + "effectiveCancellationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order is cancelled." + }, + "cancellationReason": { + "type": "string", + "description": "Reason why the order is cancelled." + }, + "state": { + "description": "Tracks the lifecycle status of the cancellation request, such as Acknowledged, Rejected, InProgress, Pending and so on.", + "$ref": "../Common/TaskStateType.schema.json#TaskStateType" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/CancelProductOrder.schema.json b/Product/CancelProductOrder.schema.json index 2a4e32a2..f9867496 100644 --- a/Product/CancelProductOrder.schema.json +++ b/Product/CancelProductOrder.schema.json @@ -1,25 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CancelProductOrder.schema.json", - "title": "CancelProductOrder", - "definitions": { - "CancelProductOrder": { - "$id": "#CancelProductOrder", - "description": "Request for cancellation an existing product order", - "type": "object", - "required": [ - "productOrder" - ], - "properties": { - "productOrder": { - "$ref": "../Customer/ProductOrderRef.schema.json#ProductOrderRef" - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#CancelOrderRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CancelProductOrder.schema.json", + "title": "CancelProductOrder", + "definitions": { + "CancelProductOrder": { + "$id": "#CancelProductOrder", + "description": "Request for cancellation an existing product order", + "type": "object", + "required": [ + "productOrder" + ], + "properties": { + "productOrder": { + "$ref": "../Customer/ProductOrderRef.schema.json#ProductOrderRef" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#CancelOrder" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/Catalog.schema.json b/Product/Catalog.schema.json index 7167d215..20a997a6 100644 --- a/Product/Catalog.schema.json +++ b/Product/Catalog.schema.json @@ -1,70 +1,70 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Catalog.schema.json", - "title": "Catalog", - "definitions": { - "Catalog": { - "$id": "#Catalog", - "description": "A collection of Product Offerings, intended for a specific DistributionChannel, enhanced with additional information such as SLA parameters, invoicing and shipping details", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Unique reference of the catalog" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Catalog" - }, - "description": { - "type": "string", - "description": "Description of this catalog" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the catalog" - }, - "catalogType": { - "type": "string", - "description": "Indicates if the catalog is a product, service or resource catalog" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the catalog is valid" - }, - "version": { - "type": "string", - "description": "Catalog version" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "description": "List of parties involved in this catalog" - }, - "category": { - "type": "array", - "items": { - "$ref": "CategoryRef.schema.json#CategoryRef" - }, - "description": "List of root categories contained in this catalog" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Catalog.schema.json", + "title": "Catalog", + "definitions": { + "Catalog": { + "$id": "#Catalog", + "description": "A collection of Product Offerings, intended for a specific DistributionChannel, enhanced with additional information such as SLA parameters, invoicing and shipping details", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Unique reference of the catalog" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Catalog" + }, + "description": { + "type": "string", + "description": "Description of this catalog" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the catalog" + }, + "catalogType": { + "type": "string", + "description": "Indicates if the catalog is a product, service or resource catalog" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the catalog is valid" + }, + "version": { + "type": "string", + "description": "Catalog version" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "List of parties involved in this catalog" + }, + "category": { + "type": "array", + "items": { + "$ref": "../Product/CategoryRef.schema.json#CategoryRef" + }, + "description": "List of root categories contained in this catalog" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/Category.schema.json b/Product/Category.schema.json index 518aead4..661dc30c 100644 --- a/Product/Category.schema.json +++ b/Product/Category.schema.json @@ -1,74 +1,74 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Category.schema.json", - "title": "Category", - "definitions": { - "Category": { - "$id": "#Category", - "type": "object", - "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.", - "properties": { - "description": { - "type": "string", - "description": "Description of the category" - }, - "href": { - "type": "string", - "description": "Reference of the category" - }, - "id": { - "type": "string", - "description": "Unique identifier of the category" - }, - "isRoot": { - "type": "boolean", - "description": "If true, this Boolean indicates that the category is a root of categories" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the category" - }, - "parentId": { - "type": "string", - "description": "Unique identifier of the parent category" - }, - "productOffering": { - "type": "array", - "items": { - "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "description": "A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information." - }, - "subCategory": { - "type": "array", - "items": { - "$ref": "CategoryRef.schema.json#CategoryRef" - }, - "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other (sub-)categories and/or product offerings." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the category is valid" - }, - "version": { - "type": "string", - "description": "Category version" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Category.schema.json", + "title": "Category", + "definitions": { + "Category": { + "$id": "#Category", + "type": "object", + "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.", + "properties": { + "description": { + "type": "string", + "description": "Description of the category" + }, + "href": { + "type": "string", + "description": "Reference of the category" + }, + "id": { + "type": "string", + "description": "Unique identifier of the category" + }, + "isRoot": { + "type": "boolean", + "description": "If true, this Boolean indicates that the category is a root of categories" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the category" + }, + "parentId": { + "type": "string", + "description": "Unique identifier of the parent category" + }, + "productOffering": { + "type": "array", + "items": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "description": "A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information." + }, + "subCategory": { + "type": "array", + "items": { + "$ref": "../Product/CategoryRef.schema.json#CategoryRef" + }, + "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other (sub-)categories and/or product offerings." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the category is valid" + }, + "version": { + "type": "string", + "description": "Category version" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/CategoryRef.schema.json b/Product/CategoryRef.schema.json index 30f90337..1df2370b 100644 --- a/Product/CategoryRef.schema.json +++ b/Product/CategoryRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "CategoryRef.schema.json", - "title": "CategoryRef", - "definitions": { - "CategoryRef": { - "$id": "#CategoryRef", - "description": "The category for grouping recommendations", - "type": "object", - "properties": { - "version": { - "type": "string", - "description": "Category version" - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "CategoryRef.schema.json", + "title": "CategoryRef", + "definitions": { + "CategoryRef": { + "$id": "#CategoryRef", + "description": "The category for grouping recommendations", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "Category version" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ConsumptionSummary.schema.json b/Product/ConsumptionSummary.schema.json index 8908f9ec..10b19ac8 100644 --- a/Product/ConsumptionSummary.schema.json +++ b/Product/ConsumptionSummary.schema.json @@ -1,47 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ConsumptionSummary.schema.json", - "title": "ConsumptionSummary", - "definitions": { - "ConsumptionSummary": { - "$id": "#ConsumptionSummary", - "type": "object", - "description": "The consumption counters (called ConsumptionSummary in the SID model) detail for example the different kind of consumption done on the bucket.", - "properties": { - "consumptionPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Consumption counter period between a start date time and an end date time. For prepaid bucket, the period of counters is between the start date of the bucket and the effective date of the usage consumption report generation. For postpaid bucket, the period of counters is between the last bill date and the effective date of the usage consumption report generation." - }, - "counterType": { - "type": "string", - "description": "Type of the consumption counter. We can give for example a counter of the used value for a bucket (counterType=used for example) or the value of the consumption done out of the bucket(s) (counterType=outOfBucket for example)" - }, - "level": { - "type": "string", - "description": "Counter level. The counter can be given globally for the bucket or detailed by user or by network product for example in case of shared bucket" - }, - "product": { - "$ref": "NetworkProductRef.schema.json#NetworkProductRef", - "description": "Public identifier associated to the product for which the consumption counter is detailed. If the level of the counter is global (i.e. concerning all the network products), the list of them is not specified. It can be found through the network products listed in the bucket sub-resource" - }, - "user": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty", - "description": "Reference of the user for which the consumption counter is detailed. If the level of the counter is global (i.e. concerning all the users), the list of them is not specified. It can be found through the users listed in the network products of the bucket sub-resource" - }, - "value": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "Numeric value of the bucket counter in a given unit" - }, - "valueName": { - "type": "string", - "description": "Value of the counter in a formatted string used for display needs for example" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ConsumptionSummary.schema.json", + "title": "ConsumptionSummary", + "definitions": { + "ConsumptionSummary": { + "$id": "#ConsumptionSummary", + "type": "object", + "description": "The consumption counters (called ConsumptionSummary in the SID model) detail for example the different kind of consumption done on the bucket.", + "properties": { + "consumptionPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Consumption counter period between a start date time and an end date time. For prepaid bucket, the period of counters is between the start date of the bucket and the effective date of the usage consumption report generation. For postpaid bucket, the period of counters is between the last bill date and the effective date of the usage consumption report generation." + }, + "counterType": { + "type": "string", + "description": "Type of the consumption counter. We can give for example a counter of the used value for a bucket (counterType=used for example) or the value of the consumption done out of the bucket(s) (counterType=outOfBucket for example)" + }, + "level": { + "type": "string", + "description": "Counter level. The counter can be given globally for the bucket or detailed by user or by network product for example in case of shared bucket" + }, + "product": { + "$ref": "../Product/NetworkProductRef.schema.json#NetworkProductRef", + "description": "Public identifier associated to the product for which the consumption counter is detailed. If the level of the counter is global (i.e. concerning all the network products), the list of them is not specified. It can be found through the network products listed in the bucket sub-resource" + }, + "user": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty", + "description": "Reference of the user for which the consumption counter is detailed. If the level of the counter is global (i.e. concerning all the users), the list of them is not specified. It can be found through the users listed in the network products of the bucket sub-resource" + }, + "value": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "Numeric value of the bucket counter in a given unit" + }, + "valueName": { + "type": "string", + "description": "Value of the counter in a formatted string used for display needs for example" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/EligibilityUnavailabilityReason.schema.json b/Product/EligibilityUnavailabilityReason.schema.json index 140df858..8cfb586d 100644 --- a/Product/EligibilityUnavailabilityReason.schema.json +++ b/Product/EligibilityUnavailabilityReason.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "EligibilityUnavailabilityReason.schema.json", - "title": "EligibilityUnavailabilityReason", - "definitions": { - "EligibilityUnavailabilityReason": { - "$id": "#EligibilityUnavailabilityReason", - "description": "Reason for eligibility result if the productOfferingQualification result is no (meaning the productOffering or productSpec is not available).", - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Unavailability reason code." - }, - "label": { - "type": "string", - "description": "Unavailability reason label." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "EligibilityUnavailabilityReason.schema.json", + "title": "EligibilityUnavailabilityReason", + "definitions": { + "EligibilityUnavailabilityReason": { + "$id": "#EligibilityUnavailabilityReason", + "description": "Reason for eligibility result if the productOfferingQualification result is no (meaning the productOffering or productSpec is not available).", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Unavailability reason code." + }, + "label": { + "type": "string", + "description": "Unavailability reason label." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyAccount.schema.json b/Product/LoyaltyAccount.schema.json index bffb87c7..1a462f51 100644 --- a/Product/LoyaltyAccount.schema.json +++ b/Product/LoyaltyAccount.schema.json @@ -1,25 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyAccount.schema.json", - "title": "LoyaltyAccount", - "definitions": { - "LoyaltyAccount": { - "$id": "#LoyaltyAccount", - "description": "A loyalty account, containing loyalty balances.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the account." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty member’s loyalty account." - }, - "loyaltyProgramProduct": { - "$ref": "LoyaltyProgramProductRef.schema.json#LoyaltyProgramProductRef" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyAccount.schema.json", + "title": "LoyaltyAccount", + "definitions": { + "LoyaltyAccount": { + "$id": "#LoyaltyAccount", + "description": "A loyalty account, containing loyalty balances.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the account." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty member’s loyalty account." + }, + "loyaltyProgramProduct": { + "$ref": "../Product/LoyaltyProgramProductRef.schema.json#LoyaltyProgramProductRef" } + } } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyAccountRef.schema.json b/Product/LoyaltyAccountRef.schema.json index 283747a2..d8337803 100644 --- a/Product/LoyaltyAccountRef.schema.json +++ b/Product/LoyaltyAccountRef.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyAccountRef.schema.json", - "title": "LoyaltyAccountRef", - "definitions": { - "LoyaltyAccountRef": { - "$id": "#LoyaltyAccountRef", - "description": "Reference to a loyalty account.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the account." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty member’s loyalty account." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyAccountRef.schema.json", + "title": "LoyaltyAccountRef", + "definitions": { + "LoyaltyAccountRef": { + "$id": "#LoyaltyAccountRef", + "description": "Reference to a loyalty account.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the account." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty member’s loyalty account." } + } } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyAction.schema.json b/Product/LoyaltyAction.schema.json index e94d6bec..f4c6865d 100644 --- a/Product/LoyaltyAction.schema.json +++ b/Product/LoyaltyAction.schema.json @@ -1,73 +1,73 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyAction.schema.json", - "title": "LoyaltyAction", - "definitions": { - "LoyaltyAction": { - "$id": "#LoyaltyAction", - "description": "Contains information on a loyalty action that should be applied should certain conditions be met for a loyalty rule and program.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty event type." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty event type." - }, - "type": { - "type": "string", - "description": "The type of loyalty action.", - "enum": [ - "LoyaltyEarn", - "CustomerOrder", - "BusinessInteraction" - ] - }, - "actionAttributes": { - "type": "object", - "$ref": "../Common/Any.schema.json#Any", - "description": "Additional attributes required to perform the action. These attributes will depend on the type of the loyalty action. For example, if it is a LoyaltyEarn action, there will be a “quantity” attribute value pair indicating how many points should be earned." - }, - "body": { - "type": "object", - "$ref": "../Common/Any.schema.json#Any", - "description": "The body if the request that is made when this action i executed. The body is assumed to be of type text/json. Any tokens denoted with {} will be replaced by attributes present in: Member profile, actionAttributes or event attributes in the loyalty event request." - }, - "headers": { - "type": "object", - "$ref": "../Common/Any.schema.json#Any", - "description": "The HTTP headers that is added to the action call." - }, - "version": { - "type": "string", - "description": "A string that identifies the version of the loyalty action." - }, - "commonName": { - "type": "string", - "description": "A user-friendly identifier of the loyalty execution point." - }, - "description": { - "type": "string", - "description": "A free-form description of the loyalty execution point." - }, - "action": { - "type": "string", - "description": "The HTTP operation to be used when calling the endpoint", - "enum": [ - "POST", - "PUT", - "GET", - "PATCH", - "DELETE" - ] - }, - "endpoint": { - "type": "string", - "description": "The endpoint to call to trigger a BusinessInteraction, CustomerOrder or LoyaltyEarn." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyAction.schema.json", + "title": "LoyaltyAction", + "definitions": { + "LoyaltyAction": { + "$id": "#LoyaltyAction", + "description": "Contains information on a loyalty action that should be applied should certain conditions be met for a loyalty rule and program.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty event type." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty event type." + }, + "type": { + "type": "string", + "description": "The type of loyalty action.", + "enum": [ + "LoyaltyEarn", + "CustomerOrder", + "BusinessInteraction" + ] + }, + "actionAttributes": { + "type": "object", + "$ref": "../Common/Any.schema.json#Any", + "description": "Additional attributes required to perform the action. These attributes will depend on the type of the loyalty action. For example, if it is a LoyaltyEarn action, there will be a “quantity” attribute value pair indicating how many points should be earned." + }, + "body": { + "type": "object", + "$ref": "../Common/Any.schema.json#Any", + "description": "The body if the request that is made when this action i executed. The body is assumed to be of type text/json. Any tokens denoted with {} will be replaced by attributes present in: Member profile, actionAttributes or event attributes in the loyalty event request." + }, + "headers": { + "type": "object", + "$ref": "../Common/Any.schema.json#Any", + "description": "The HTTP headers that is added to the action call." + }, + "version": { + "type": "string", + "description": "A string that identifies the version of the loyalty action." + }, + "commonName": { + "type": "string", + "description": "A user-friendly identifier of the loyalty execution point." + }, + "description": { + "type": "string", + "description": "A free-form description of the loyalty execution point." + }, + "action": { + "type": "string", + "description": "The HTTP operation to be used when calling the endpoint", + "enum": [ + "POST", + "PUT", + "GET", + "PATCH", + "DELETE" + ] + }, + "endpoint": { + "type": "string", + "description": "The endpoint to call to trigger a BusinessInteraction, CustomerOrder or LoyaltyEarn." } + } } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyActionRef.schema.json b/Product/LoyaltyActionRef.schema.json index a62edf61..e3922a7f 100644 --- a/Product/LoyaltyActionRef.schema.json +++ b/Product/LoyaltyActionRef.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyActionRef.schema.json", - "title": "LoyaltyActionRef", - "definitions": { - "LoyaltyActionRef": { - "$id": "#LoyaltyActionRef", - "description": "A reference to a loyalty action.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty action." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty action." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyActionRef.schema.json", + "title": "LoyaltyActionRef", + "definitions": { + "LoyaltyActionRef": { + "$id": "#LoyaltyActionRef", + "description": "A reference to a loyalty action.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty action." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty action." } + } } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyBalance.schema.json b/Product/LoyaltyBalance.schema.json index 5f40ffd5..c77592f8 100644 --- a/Product/LoyaltyBalance.schema.json +++ b/Product/LoyaltyBalance.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyBalance.schema.json", - "title": "LoyaltyBalance", - "definitions": { - "LoyaltyBalance": { - "$id": "#LoyaltyBalance", - "description": "A loyalty balance, containing a balance unit and value.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty balance." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty member’s loyalty balance." - }, - "quantity": { - "type": "object", - "description": "Unit and value of the balance.", - "$ref": "../Common/Money.schema.json#Money" - }, - "loyaltyProgramMember": { - "type": "object", - "description": "Reference to the loyaltyProgramMember to whom the loyaltyAccount belongs.", - "$ref": "LoyaltyProgramMemberRef.schema.json#LoyaltyProgramMemberRef" - }, - "validFor": { - "type": "object", - "description": "The validity period in which loyalty can be burned using the account.", - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyBalance.schema.json", + "title": "LoyaltyBalance", + "definitions": { + "LoyaltyBalance": { + "$id": "#LoyaltyBalance", + "description": "A loyalty balance, containing a balance unit and value.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty balance." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty member’s loyalty balance." + }, + "quantity": { + "type": "object", + "description": "Unit and value of the balance.", + "$ref": "../Common/Money.schema.json#Money" + }, + "loyaltyProgramMember": { + "type": "object", + "description": "Reference to the loyaltyProgramMember to whom the loyaltyAccount belongs.", + "$ref": "../Product/LoyaltyProgramMemberRef.schema.json#LoyaltyProgramMemberRef" + }, + "validFor": { + "type": "object", + "description": "The validity period in which loyalty can be burned using the account.", + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" } + } } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyCondition.schema.json b/Product/LoyaltyCondition.schema.json index 6ff375b2..b9e18434 100644 --- a/Product/LoyaltyCondition.schema.json +++ b/Product/LoyaltyCondition.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyCondition.schema.json", - "title": "LoyaltyCondition", - "definitions": { - "LoyaltyCondition": { - "$id": "#LoyaltyCondition", - "description": "A condition, comprised of a attribute that will be tested against a value.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty condition." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty event type." - }, - "attribute": { - "type": "string", - "description": "The attribute to evaluate." - }, - "operator": { - "type": "string", - "description": "Comparison operator to be used in the evaluation." - }, - "value": { - "type": "string", - "description": "The value of the attribute to be evaluated." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyCondition.schema.json", + "title": "LoyaltyCondition", + "definitions": { + "LoyaltyCondition": { + "$id": "#LoyaltyCondition", + "description": "A condition, comprised of a attribute that will be tested against a value.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty condition." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty event type." + }, + "attribute": { + "type": "string", + "description": "The attribute to evaluate." + }, + "operator": { + "type": "string", + "description": "Comparison operator to be used in the evaluation." + }, + "value": { + "type": "string", + "description": "The value of the attribute to be evaluated." } + } } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyConditionRef.schema.json b/Product/LoyaltyConditionRef.schema.json index 818f7bd8..1b60c371 100644 --- a/Product/LoyaltyConditionRef.schema.json +++ b/Product/LoyaltyConditionRef.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyConditionRef.schema.json", - "title": "LoyaltyConditionRef", - "definitions": { - "LoyaltyConditionRef": { - "$id": "#LoyaltyConditionRef", - "description": "A reference to a loyalty condition.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty condition." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty condition." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyConditionRef.schema.json", + "title": "LoyaltyConditionRef", + "definitions": { + "LoyaltyConditionRef": { + "$id": "#LoyaltyConditionRef", + "description": "A reference to a loyalty condition.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty condition." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty condition." } + } } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyEvent.schema.json b/Product/LoyaltyEvent.schema.json index e3f854e6..13ceec49 100644 --- a/Product/LoyaltyEvent.schema.json +++ b/Product/LoyaltyEvent.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyEvent.schema.json", - "title": "LoyaltyEvent", - "definitions": { - "LoyaltyEvent": { - "$id": "#LoyaltyEvent", - "description": "A loyalty event notification.", - "type": "object", - "properties": { - "eventId": { - "$ref": "LoyaltyProgramProductRef.schema.json#LoyaltyProgramProductRef" - }, - "eventType": { - "type": "string", - "description": "The incoming loyalty event type." - }, - "eventTime": { - "type": "string", - "description": "The time that the event was received." - }, - "memberId": { - "type": "string", - "description": "The loyalty program member ID associated with the event." - }, - "event": { - "type": "object", - "$ref": "../Common/Any.schema.json#Any", - "description": "The event attributes." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyEvent.schema.json", + "title": "LoyaltyEvent", + "definitions": { + "LoyaltyEvent": { + "$id": "#LoyaltyEvent", + "description": "A loyalty event notification.", + "type": "object", + "properties": { + "eventId": { + "$ref": "../Product/LoyaltyProgramProductRef.schema.json#LoyaltyProgramProductRef" + }, + "eventType": { + "type": "string", + "description": "The incoming loyalty event type." + }, + "eventTime": { + "type": "string", + "description": "The time that the event was received." + }, + "memberId": { + "type": "string", + "description": "The loyalty program member ID associated with the event." + }, + "event": { + "type": "object", + "$ref": "../Common/Any.schema.json#Any", + "description": "The event attributes." } + } } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyEventType.schema.json b/Product/LoyaltyEventType.schema.json index 44af2231..83a62508 100644 --- a/Product/LoyaltyEventType.schema.json +++ b/Product/LoyaltyEventType.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyEventType.schema.json", - "title": "LoyaltyEventType", - "definitions": { - "LoyaltyEventType": { - "$id": "#LoyaltyEventType", - "description": "An event type used to match filter incoming loyalty events.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty event type." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty event type." - }, - "eventType": { - "type": "string", - "description": "The type of loyalty event expected to trigger the loyalty rule evaluation, e.g. a CustomerOrder or an Invoice. The eventType should be unique to prevent existing resources not being reused. An eventType that already exists will result in a 422 error." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyEventType.schema.json", + "title": "LoyaltyEventType", + "definitions": { + "LoyaltyEventType": { + "$id": "#LoyaltyEventType", + "description": "An event type used to match filter incoming loyalty events.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty event type." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty event type." + }, + "eventType": { + "type": "string", + "description": "The type of loyalty event expected to trigger the loyalty rule evaluation, e.g. a CustomerOrder or an Invoice. The eventType should be unique to prevent existing resources not being reused. An eventType that already exists will result in a 422 error." } + } } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyEventTypeRef.schema.json b/Product/LoyaltyEventTypeRef.schema.json index c5625f4c..846289b6 100644 --- a/Product/LoyaltyEventTypeRef.schema.json +++ b/Product/LoyaltyEventTypeRef.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyEventTypeRef.schema.json", - "title": "LoyaltyEventTypeRef", - "definitions": { - "LoyaltyEventTypeRef": { - "$id": "#LoyaltyEventTypeRef", - "description": "A reference to a loyalty event type.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty event type." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty event type." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyEventTypeRef.schema.json", + "title": "LoyaltyEventTypeRef", + "definitions": { + "LoyaltyEventTypeRef": { + "$id": "#LoyaltyEventTypeRef", + "description": "A reference to a loyalty event type.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty event type." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty event type." } + } } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyExecutionPoint.schema.json b/Product/LoyaltyExecutionPoint.schema.json index 59001c32..444ccfab 100644 --- a/Product/LoyaltyExecutionPoint.schema.json +++ b/Product/LoyaltyExecutionPoint.schema.json @@ -1,79 +1,79 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyExecutionPoint.schema.json", - "title": "LoyaltyExecutionPoint", - "definitions": { - "LoyaltyAccount": { - "$id": "#LoyaltyExecutionPoint", - "description": "A record of a loyalty action that was applied.", - "type": "object", - "title": "LoyaltyExecutionPoint", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty event type." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty event type." - }, - "type": { - "type": "string", - "description": "The type of loyalty action.", - "enum": [ - "LoyaltyEarn", - "CustomerOrder", - "BusinessInteraction" - ] - }, - "actionAttributes": { - "type": "object", - "$ref": "../Common/Any.schema.json#/definitions/Any", - "description": "Additional attributes required to perform the action. These attributes will depend on the type of the loyalty action. For example, if it is a LoyaltyEarn action, there will be a “quantity” attribute value pair indicating how many points should be earned." - }, - "body": { - "type": "object", - "$ref": "../Common/Any.schema.json#/definitions/Any", - "description": "The body if the request that is made when this action i executed. The body is assumed to be of type text/json. Any tokens denoted with {} will be replaced by attributes present in: Member profile, actionAttributes or event attributes in the loyalty event request." - }, - "headers": { - "type": "object", - "$ref": "../Common/Any.schema.json#/definitions/Any", - "description": "The HTTP headers that is added to the action call." - }, - "version": { - "type": "string", - "description": "A string that identifies the version of the loyalty action." - }, - "commonName": { - "type": "string", - "description": "A user-friendly identifier of the loyalty execution point." - }, - "description": { - "type": "string", - "description": "A free-form description of the loyalty execution point." - }, - "action": { - "type": "string", - "description": "The HTTP operation to be used when calling the endpoint", - "enum": [ - "POST", - "PUT", - "GET", - "PATCH", - "DELETE" - ] - }, - "endpoint": { - "type": "string", - "description": "The endpoint to call to trigger a BusinessInteraction, CustomerOrder or LoyaltyEarn." - }, - "datetime": { - "type": "string", - "description": "The timestamp that the action was applied.", - "format": "date-time" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyExecutionPoint.schema.json", + "title": "LoyaltyExecutionPoint", + "definitions": { + "LoyaltyAccount": { + "$id": "#LoyaltyAccount", + "description": "A record of a loyalty action that was applied.", + "type": "object", + "title": "LoyaltyExecutionPoint", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty event type." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty event type." + }, + "type": { + "type": "string", + "description": "The type of loyalty action.", + "enum": [ + "LoyaltyEarn", + "CustomerOrder", + "BusinessInteraction" + ] + }, + "actionAttributes": { + "type": "object", + "$ref": "../Common/Any.schema.json#/definitions/Any", + "description": "Additional attributes required to perform the action. These attributes will depend on the type of the loyalty action. For example, if it is a LoyaltyEarn action, there will be a “quantity” attribute value pair indicating how many points should be earned." + }, + "body": { + "type": "object", + "$ref": "../Common/Any.schema.json#/definitions/Any", + "description": "The body if the request that is made when this action i executed. The body is assumed to be of type text/json. Any tokens denoted with {} will be replaced by attributes present in: Member profile, actionAttributes or event attributes in the loyalty event request." + }, + "headers": { + "type": "object", + "$ref": "../Common/Any.schema.json#/definitions/Any", + "description": "The HTTP headers that is added to the action call." + }, + "version": { + "type": "string", + "description": "A string that identifies the version of the loyalty action." + }, + "commonName": { + "type": "string", + "description": "A user-friendly identifier of the loyalty execution point." + }, + "description": { + "type": "string", + "description": "A free-form description of the loyalty execution point." + }, + "action": { + "type": "string", + "description": "The HTTP operation to be used when calling the endpoint", + "enum": [ + "POST", + "PUT", + "GET", + "PATCH", + "DELETE" + ] + }, + "endpoint": { + "type": "string", + "description": "The endpoint to call to trigger a BusinessInteraction, CustomerOrder or LoyaltyEarn." + }, + "datetime": { + "type": "string", + "description": "The timestamp that the action was applied.", + "format": "date-time" } + } } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyProgramMember.schema.json b/Product/LoyaltyProgramMember.schema.json index 177333f7..9219ca74 100644 --- a/Product/LoyaltyProgramMember.schema.json +++ b/Product/LoyaltyProgramMember.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyProgramMember.schema.json", - "title": "LoyaltyProgramMember", - "definitions": { - "LoyaltyProgramMember": { - "$id": "#LoyaltyProgramMember", - "description": "A person or group that opts in to a loyalty program.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty program member." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty program member." - }, - "name": { - "type": "string", - "description": "The loyalty member’s name." - }, - "status": { - "type": "string", - "description": "A free-form field in which the member’s status may be captured, e.g. 'active', 'suspended', .etc." - }, - "ValidFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period during which the loyalty member is valid for." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyProgramMember.schema.json", + "title": "LoyaltyProgramMember", + "definitions": { + "LoyaltyProgramMember": { + "$id": "#LoyaltyProgramMember", + "description": "A person or group that opts in to a loyalty program.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty program member." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty program member." + }, + "name": { + "type": "string", + "description": "The loyalty member’s name." + }, + "status": { + "type": "string", + "description": "A free-form field in which the member’s status may be captured, e.g. 'active', 'suspended', .etc." + }, + "ValidFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period during which the loyalty member is valid for." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyProgramMemberRef.schema.json b/Product/LoyaltyProgramMemberRef.schema.json index c59155e3..3bc85536 100644 --- a/Product/LoyaltyProgramMemberRef.schema.json +++ b/Product/LoyaltyProgramMemberRef.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyProgramMemberRef.schema.json", - "title": "LoyaltyProgramMemberRef", - "definitions": { - "LoyaltyProgramMemberRef": { - "$id": "#LoyaltyProgramMemberRef", - "description": "Reference to a loyalty member.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty program member." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty program member." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyProgramMemberRef.schema.json", + "title": "LoyaltyProgramMemberRef", + "definitions": { + "LoyaltyProgramMemberRef": { + "$id": "#LoyaltyProgramMemberRef", + "description": "Reference to a loyalty member.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty program member." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty program member." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyProgramProduct.schema.json b/Product/LoyaltyProgramProduct.schema.json index f00f77a0..17c9ee21 100644 --- a/Product/LoyaltyProgramProduct.schema.json +++ b/Product/LoyaltyProgramProduct.schema.json @@ -1,57 +1,57 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyProgramProduct.schema.json", - "title": "LoyaltyProgramProduct", - "definitions": { - "LoyaltyProgramProduct": { - "$id": "#LoyaltyProgramProduct", - "description": "An instance of a loyalty program specification, linked to a specified loyalty member.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty program product." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty account." - }, - "name": { - "type": "string", - "description": "A word, term, or phrase by which the product is known and distinguished from other products." - }, - "description": { - "type": "string", - "description": "An explanation of what the product is." - }, - "productStatus": { - "type": "string", - "description": "The condition of the product, such as planned, designed, activated, disconnected." - }, - "characteristic": { - "type": "array", - "description": "Name value pairs of product characteristics.", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - } - }, - "loyaltyProgramProductSpec": { - "type": "object", - "$ref": "LoyaltyProgramProductSpecRef.schema.json#LoyaltyProgramProductSpecRef" - }, - "loyaltyAccount": { - "type": "object", - "$ref": "LoyaltyAccountRef.schema.json#LoyaltyAccountRef" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyProgramProduct.schema.json", + "title": "LoyaltyProgramProduct", + "definitions": { + "LoyaltyProgramProduct": { + "$id": "#LoyaltyProgramProduct", + "description": "An instance of a loyalty program specification, linked to a specified loyalty member.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty program product." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty account." + }, + "name": { + "type": "string", + "description": "A word, term, or phrase by which the product is known and distinguished from other products." + }, + "description": { + "type": "string", + "description": "An explanation of what the product is." + }, + "productStatus": { + "type": "string", + "description": "The condition of the product, such as planned, designed, activated, disconnected." + }, + "characteristic": { + "type": "array", + "description": "Name value pairs of product characteristics.", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "loyaltyProgramProductSpec": { + "type": "object", + "$ref": "../Product/LoyaltyProgramProductSpecRef.schema.json#LoyaltyProgramProductSpecRef" + }, + "loyaltyAccount": { + "type": "object", + "$ref": "../Product/LoyaltyAccountRef.schema.json#LoyaltyAccountRef" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyProgramProductRef.schema.json b/Product/LoyaltyProgramProductRef.schema.json index 91881daa..989e752e 100644 --- a/Product/LoyaltyProgramProductRef.schema.json +++ b/Product/LoyaltyProgramProductRef.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyProgramProductRef.schema.json", - "title": "LoyaltyProgramProductRef", - "definitions": { - "LoyaltyProgramProductRef": { - "$id": "#LoyaltyProgramProductRef", - "type": "object", - "description": "A reference to a loyalty product.", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty program product." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty program product." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyProgramProductRef.schema.json", + "title": "LoyaltyProgramProductRef", + "definitions": { + "LoyaltyProgramProductRef": { + "$id": "#LoyaltyProgramProductRef", + "type": "object", + "description": "A reference to a loyalty product.", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty program product." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty program product." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyProgramProductSpec.schema.json b/Product/LoyaltyProgramProductSpec.schema.json index 09cf4d92..a301f921 100644 --- a/Product/LoyaltyProgramProductSpec.schema.json +++ b/Product/LoyaltyProgramProductSpec.schema.json @@ -1,49 +1,49 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyProgramProductSpec.schema.json", - "title": "LoyaltyProgramProductSpec", - "definitions": { - "LoyaltyProgramProductSpec": { - "$id": "#LoyaltyProgramProductSpec", - "type": "object", - "description": "A reference to a loyalty program specification.", - "properties": { - "brand": { - "type": "string", - "description": "The manufacturer or trademark of the specification." - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the product specification is." - }, - "id": { - "type": "string", - "description": "Unique identifier for the product specification." - }, - "href": { - "type": "string", - "description": "A reference to the product specification." - }, - "lifeCycleStatus": { - "type": "string", - "description": "The condition of the product specification, such as active, inactive, planned." - }, - "name": { - "type": "string", - "description": "The name of the product specification." - }, - "needsLoyaltyAccount": { - "type": "boolean", - "description": "A narrative that explains in detail what the product specification is." - }, - "productNumber": { - "type": "string", - "productNumber": "An identification number assigned to uniquely identify the specification." - }, - "ValidFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyProgramProductSpec.schema.json", + "title": "LoyaltyProgramProductSpec", + "definitions": { + "LoyaltyProgramProductSpec": { + "$id": "#LoyaltyProgramProductSpec", + "type": "object", + "description": "A reference to a loyalty program specification.", + "properties": { + "brand": { + "type": "string", + "description": "The manufacturer or trademark of the specification." + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the product specification is." + }, + "id": { + "type": "string", + "description": "Unique identifier for the product specification." + }, + "href": { + "type": "string", + "description": "A reference to the product specification." + }, + "lifeCycleStatus": { + "type": "string", + "description": "The condition of the product specification, such as active, inactive, planned." + }, + "name": { + "type": "string", + "description": "The name of the product specification." + }, + "needsLoyaltyAccount": { + "type": "boolean", + "description": "A narrative that explains in detail what the product specification is." + }, + "productNumber": { + "type": "string", + "productNumber": "An identification number assigned to uniquely identify the specification." + }, + "ValidFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" } + } } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyProgramProductSpecRef.schema.json b/Product/LoyaltyProgramProductSpecRef.schema.json index 4b6f2719..3c47c955 100644 --- a/Product/LoyaltyProgramProductSpecRef.schema.json +++ b/Product/LoyaltyProgramProductSpecRef.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyProgramProductSpecRef.schema.json", - "title": "LoyaltyProgramProductSpecRef", - "definitions": { - "LoyaltyProgramProductSpecRef": { - "$id": "#LoyaltyProgramProductSpecRef", - "description": "A reference to a loyalty program specification.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the product specification." - }, - "href": { - "type": "string", - "description": "A reference to the product specification." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyProgramProductSpecRef.schema.json", + "title": "LoyaltyProgramProductSpecRef", + "definitions": { + "LoyaltyProgramProductSpecRef": { + "$id": "#LoyaltyProgramProductSpecRef", + "description": "A reference to a loyalty program specification.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the product specification." + }, + "href": { + "type": "string", + "description": "A reference to the product specification." } + } } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyRule.schema.json b/Product/LoyaltyRule.schema.json index fd8d7273..1c6c71f5 100644 --- a/Product/LoyaltyRule.schema.json +++ b/Product/LoyaltyRule.schema.json @@ -1,75 +1,75 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyRule.schema.json", - "title": "LoyaltyRule", - "definitions": { - "LoyaltyRule": { - "$id": "#LoyaltyRule", - "description": "Loyalty rule, containing conditions, event types and actions.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty rule." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty rule." - }, - "isCNF": { - "type": "boolean", - "description": "Unit and value of the balance." - }, - "hasSubRules": { - "type": "boolean", - "description": "A Boolean attribute that signifies whether this loyalty rule has one or more sub-rules. Sub-rules are used to enforce a hierarchical nesting of rules, so that parent rules may control the execution and other semantics of sub-rules that they contain." - }, - "isMandatoryEvaluation": { - "type": "boolean", - "description": "A Boolean attribute that, if true, signifies that evaluation (and possibly action execution) of this entity is mandatory and must be attempted. If the Mandatory property value of this entity is false, then the evaluation of this entity is considered to be 'best effort' and may be ignored." - }, - "usage": { - "type": "string", - "description": "A free-form string attribute that recommends how this policy object should be used." - }, - "keywords": { - "type": "string", - "description": "A string attribute that defines a set of one or more keywords that a policy administrator may use to assist in characterizing or categorizing a policy object to facilitate search operations." - }, - "policyName": { - "type": "string", - "description": "A generic naming attribute that can be used to identify different policy entities." - }, - "commonName": { - "type": "string", - "description": "A user-friendly identifier of the loyalty rule." - }, - "description": { - "type": "string", - "description": "A free-form description of the rule." - }, - "loyaltyEventType": { - "type": "array", - "description": "References to linked event types.", - "items": { - "$ref": "LoyaltyEventTypeRef.schema.json#LoyaltyEventTypeRef" - } - }, - "loyaltyCondition": { - "type": "array", - "description": "References to linked conditions.", - "items": { - "$ref": "LoyaltyConditionRef.schema.json#LoyaltyConditionRef" - } - }, - "loyaltyAction": { - "type": "array", - "description": "References to linked actions.", - "items": { - "$ref": "LoyaltyActionRef.schema.json#LoyaltyActionRef" - } - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyRule.schema.json", + "title": "LoyaltyRule", + "definitions": { + "LoyaltyRule": { + "$id": "#LoyaltyRule", + "description": "Loyalty rule, containing conditions, event types and actions.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty rule." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty rule." + }, + "isCNF": { + "type": "boolean", + "description": "Unit and value of the balance." + }, + "hasSubRules": { + "type": "boolean", + "description": "A Boolean attribute that signifies whether this loyalty rule has one or more sub-rules. Sub-rules are used to enforce a hierarchical nesting of rules, so that parent rules may control the execution and other semantics of sub-rules that they contain." + }, + "isMandatoryEvaluation": { + "type": "boolean", + "description": "A Boolean attribute that, if true, signifies that evaluation (and possibly action execution) of this entity is mandatory and must be attempted. If the Mandatory property value of this entity is false, then the evaluation of this entity is considered to be 'best effort' and may be ignored." + }, + "usage": { + "type": "string", + "description": "A free-form string attribute that recommends how this policy object should be used." + }, + "keywords": { + "type": "string", + "description": "A string attribute that defines a set of one or more keywords that a policy administrator may use to assist in characterizing or categorizing a policy object to facilitate search operations." + }, + "policyName": { + "type": "string", + "description": "A generic naming attribute that can be used to identify different policy entities." + }, + "commonName": { + "type": "string", + "description": "A user-friendly identifier of the loyalty rule." + }, + "description": { + "type": "string", + "description": "A free-form description of the rule." + }, + "loyaltyEventType": { + "type": "array", + "description": "References to linked event types.", + "items": { + "$ref": "../Product/LoyaltyEventTypeRef.schema.json#LoyaltyEventTypeRef" + } + }, + "loyaltyCondition": { + "type": "array", + "description": "References to linked conditions.", + "items": { + "$ref": "../Product/LoyaltyConditionRef.schema.json#LoyaltyConditionRef" + } + }, + "loyaltyAction": { + "type": "array", + "description": "References to linked actions.", + "items": { + "$ref": "../Product/LoyaltyActionRef.schema.json#LoyaltyActionRef" + } } + } } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyRuleAction.schema.json b/Product/LoyaltyRuleAction.schema.json index f50d05f5..427fd5d9 100644 --- a/Product/LoyaltyRuleAction.schema.json +++ b/Product/LoyaltyRuleAction.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyRuleAction.schema.json", - "title": "LoyaltyRuleAction", - "definitions": { - "LoyaltyRuleAction": { - "$id": "#LoyaltyRuleAction", - "description": "Resource containing a the ID of a action to link to a loyalty rule.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty action." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty action." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyRuleAction.schema.json", + "title": "LoyaltyRuleAction", + "definitions": { + "LoyaltyRuleAction": { + "$id": "#LoyaltyRuleAction", + "description": "Resource containing a the ID of a action to link to a loyalty rule.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty action." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty action." } + } } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyRuleCondition.schema.json b/Product/LoyaltyRuleCondition.schema.json index 5c1cecf1..5a48e62c 100644 --- a/Product/LoyaltyRuleCondition.schema.json +++ b/Product/LoyaltyRuleCondition.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyRuleCondition.schema.json", - "title": "LoyaltyRuleCondition", - "definitions": { - "LoyaltyRuleCondition": { - "$id": "#LoyaltyRuleCondition", - "description": "Resource containing a the ID of a condition to link to a loyalty rule.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty condition." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty condition." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyRuleCondition.schema.json", + "title": "LoyaltyRuleCondition", + "definitions": { + "LoyaltyRuleCondition": { + "$id": "#LoyaltyRuleCondition", + "description": "Resource containing a the ID of a condition to link to a loyalty rule.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty condition." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty condition." } + } } -} \ No newline at end of file + } +} diff --git a/Product/LoyaltyRuleEventType.schema.json b/Product/LoyaltyRuleEventType.schema.json index 3d6b1970..f69fbc91 100644 --- a/Product/LoyaltyRuleEventType.schema.json +++ b/Product/LoyaltyRuleEventType.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LoyaltyRuleEventType.schema.json", - "title": "LoyaltyRuleEventType", - "definitions": { - "LoyaltyRuleEventType": { - "$id": "#LoyaltyRuleEventType", - "description": "Resource containing a the ID of a event type to link to a loyalty rule.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier for the loyalty event type." - }, - "href": { - "type": "string", - "description": "A reference to the loyalty event type." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LoyaltyRuleEventType.schema.json", + "title": "LoyaltyRuleEventType", + "definitions": { + "LoyaltyRuleEventType": { + "$id": "#LoyaltyRuleEventType", + "description": "Resource containing a the ID of a event type to link to a loyalty rule.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the loyalty event type." + }, + "href": { + "type": "string", + "description": "A reference to the loyalty event type." } + } } -} \ No newline at end of file + } +} diff --git a/Product/NetworkProduct.schema.json b/Product/NetworkProduct.schema.json index 7203d354..739e3fbf 100644 --- a/Product/NetworkProduct.schema.json +++ b/Product/NetworkProduct.schema.json @@ -1,49 +1,49 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "NetworkProduct.schema.json", - "title": "NetworkProduct", - "definitions": { - "NetworkProduct": { - "$id": "#NetworkProduct", - "type": "object", - "description": "An instantiated network product (specialization of a product) subscribed by a customer.", - "properties": { - "href": { - "type": "string", - "description": "Reference to the network product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the network product" - }, - "name": { - "type": "string", - "description": "Network product name" - }, - "outOfBucketCounter": { - "type": "array", - "description": "Counters detailing usage consumption out of the buckets", - "items": { - "$ref": "ConsumptionSummary.schema.json#ConsumptionSummary" - } - }, - "publicIdentifier": { - "type": "string", - "description": "Public number associated to the network product (msisdn number for mobile line for example)" - }, - "user": { - "type": "array", - "description": "References of the users of the network product", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "NetworkProduct.schema.json", + "title": "NetworkProduct", + "definitions": { + "NetworkProduct": { + "$id": "#NetworkProduct", + "type": "object", + "description": "An instantiated network product (specialization of a product) subscribed by a customer.", + "properties": { + "href": { + "type": "string", + "description": "Reference to the network product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the network product" + }, + "name": { + "type": "string", + "description": "Network product name" + }, + "outOfBucketCounter": { + "type": "array", + "description": "Counters detailing usage consumption out of the buckets", + "items": { + "$ref": "../Product/ConsumptionSummary.schema.json#ConsumptionSummary" + } + }, + "publicIdentifier": { + "type": "string", + "description": "Public number associated to the network product (msisdn number for mobile line for example)" + }, + "user": { + "type": "array", + "description": "References of the users of the network product", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/NetworkProductRef.schema.json b/Product/NetworkProductRef.schema.json index e4e3afd5..bc9cbfa3 100644 --- a/Product/NetworkProductRef.schema.json +++ b/Product/NetworkProductRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "NetworkProductRef.schema.json", - "title": "NetworkProductRef", - "definitions": { - "NetworkProductRef": { - "$id": "#NetworkProductRef", - "type": "object", - "description": "Reference of a product", - "properties": { - "@referredType": { - "type": "string", - "description": "Generic attribute indicating the name of the class type of the referred resource entity" - }, - "href": { - "type": "string", - "description": "Reference to the network product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the network product" - }, - "name": { - "type": "string", - "description": "Network product name" - }, - "publicIdentifier": { - "type": "string", - "description": "Public number associated to the product (msisdn number for mobile line for example)" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "NetworkProductRef.schema.json", + "title": "NetworkProductRef", + "definitions": { + "NetworkProductRef": { + "$id": "#NetworkProductRef", + "type": "object", + "description": "Reference of a product", + "properties": { + "@referredType": { + "type": "string", + "description": "Generic attribute indicating the name of the class type of the referred resource entity" + }, + "href": { + "type": "string", + "description": "Reference to the network product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the network product" + }, + "name": { + "type": "string", + "description": "Network product name" + }, + "publicIdentifier": { + "type": "string", + "description": "Public number associated to the product (msisdn number for mobile line for example)" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/OrderStateType.schema.json b/Product/OrderStateType.schema.json index 20085318..fb3fa246 100644 --- a/Product/OrderStateType.schema.json +++ b/Product/OrderStateType.schema.json @@ -1,25 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "OrderStateType.schema.json", - "title": "OrderStateType", - "definitions": { - "OrderStateType": { - "$id": "#OrderStateType", - "type": "string", - "description": "Possible values for the state of the order", - "enum": [ - "acknowledged", - "rejected", - "pending", - "held", - "inProgress", - "cancelled", - "completed", - "failed", - "partial", - "assessingCancellation", - "pendingCancellation" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "OrderStateType.schema.json", + "title": "OrderStateType", + "definitions": { + "OrderStateType": { + "$id": "#OrderStateType", + "type": "string", + "description": "Possible values for the state of the order", + "enum": [ + "acknowledged", + "rejected", + "pending", + "held", + "inProgress", + "cancelled", + "completed", + "failed", + "partial", + "assessingCancellation", + "pendingCancellation" + ] } -} \ No newline at end of file + } +} diff --git a/Product/PriceAlteration.schema.json b/Product/PriceAlteration.schema.json index 0c1c1179..95b70019 100644 --- a/Product/PriceAlteration.schema.json +++ b/Product/PriceAlteration.schema.json @@ -1,57 +1,57 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PriceAlteration.schema.json", - "title": "PriceAlteration", - "definitions": { - "PriceAlteration": { - "$id": "#PriceAlteration", - "description": "Is an amount, usually of money, that modifies the price charged for an order item.", - "type": "object", - "required": [ - "priceType", - "price" - ], - "properties": { - "applicationDuration": { - "type": "integer", - "description": "Duration during which the alteration applies on the order item price (for instance 2 months free of charge for the recurring charge)" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail the semantics of this order item price alteration" - }, - "name": { - "type": "string", - "description": "Name of the order item price alteration" - }, - "productOfferingPrice": { - "$ref": "ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" - }, - "priceType": { - "type": "string", - "description": "A category that describes the price such as recurring, one time and usage." - }, - "priority": { - "type": "integer", - "description": "Priority level for applying this alteration among all the defined alterations on the order item price" - }, - "recurringChargePeriod": { - "type": "string", - "description": "Could be month, week..." - }, - "unitOfMeasure": { - "type": "string", - "description": "Could be minutes, GB..." - }, - "price": { - "$ref": "../Customer/Price.schema.json#Price" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PriceAlteration.schema.json", + "title": "PriceAlteration", + "definitions": { + "PriceAlteration": { + "$id": "#PriceAlteration", + "description": "Is an amount, usually of money, that modifies the price charged for an order item.", + "type": "object", + "required": [ + "priceType", + "price" + ], + "properties": { + "applicationDuration": { + "type": "integer", + "description": "Duration during which the alteration applies on the order item price (for instance 2 months free of charge for the recurring charge)" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail the semantics of this order item price alteration" + }, + "name": { + "type": "string", + "description": "Name of the order item price alteration" + }, + "productOfferingPrice": { + "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" + }, + "priceType": { + "type": "string", + "description": "A category that describes the price such as recurring, one time and usage." + }, + "priority": { + "type": "integer", + "description": "Priority level for applying this alteration among all the defined alterations on the order item price" + }, + "recurringChargePeriod": { + "type": "string", + "description": "Could be month, week..." + }, + "unitOfMeasure": { + "type": "string", + "description": "Could be minutes, GB..." + }, + "price": { + "$ref": "../Customer/Price.schema.json#Price" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/PricingLogicAlgorithm.schema.json b/Product/PricingLogicAlgorithm.schema.json index d9cfb2c6..f249b2e8 100644 --- a/Product/PricingLogicAlgorithm.schema.json +++ b/Product/PricingLogicAlgorithm.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PricingLogicAlgorithm.schema.json", - "title": "PricingLogicAlgorithm", - "definitions": { - "PricingLogicAlgorithm": { - "$id": "#PricingLogicAlgorithm", - "type": "object", - "description": "The PricingLogicAlgorithm entity represents an instantiation of an interface specification to external rating function (without a modeled bahavior in SID). Some of the parameters of the interface definiition may be already set (such as price per unit) and some may be gathered during the rating process from the event (such as call duration) or from ProductCharacteristicValues (such as assigned bandwidth)", - "properties": { - "description": { - "type": "string", - "description": "Description of the PricingLogicAlgorithm" - }, - "href": { - "type": "string", - "description": "hyperlink reference of this PricingLogicAlgorithm" - }, - "id": { - "type": "string", - "description": "unique id of the PricingLogicAlgorithm" - }, - "name": { - "type": "string", - "description": "Name given to the PricingLogicAlgorithm" - }, - "plaSpecId": { - "type": "string", - "description": "id of corresponding PricingLogicAlgorithm specification" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the PricingLogicAlgorithm is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PricingLogicAlgorithm.schema.json", + "title": "PricingLogicAlgorithm", + "definitions": { + "PricingLogicAlgorithm": { + "$id": "#PricingLogicAlgorithm", + "type": "object", + "description": "The PricingLogicAlgorithm entity represents an instantiation of an interface specification to external rating function (without a modeled bahavior in SID). Some of the parameters of the interface definiition may be already set (such as price per unit) and some may be gathered during the rating process from the event (such as call duration) or from ProductCharacteristicValues (such as assigned bandwidth)", + "properties": { + "description": { + "type": "string", + "description": "Description of the PricingLogicAlgorithm" + }, + "href": { + "type": "string", + "description": "hyperlink reference of this PricingLogicAlgorithm" + }, + "id": { + "type": "string", + "description": "unique id of the PricingLogicAlgorithm" + }, + "name": { + "type": "string", + "description": "Name given to the PricingLogicAlgorithm" + }, + "plaSpecId": { + "type": "string", + "description": "id of corresponding PricingLogicAlgorithm specification" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the PricingLogicAlgorithm is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/Product.schema.json b/Product/Product.schema.json index 96969cfa..5b0c67b2 100644 --- a/Product/Product.schema.json +++ b/Product/Product.schema.json @@ -1,141 +1,141 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Product.schema.json", - "title": "Product", - "definitions": { - "Product": { - "$id": "#Product", - "type": "object", - "description": "A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service(s) and / or resource(s).", - "properties": { - "agreement": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AgreementItemRef.schema.json#AgreementItemRef" - } - }, - "billingAccount": { - "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" - }, - "description": { - "type": "string", - "description": "Is the description of the product. It could be copied from the description of the Product Offering." - }, - "href": { - "type": "string", - "description": "Reference of the product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product" - }, - "isBundle": { - "type": "boolean", - "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." - }, - "isCustomerVisible": { - "type": "boolean", - "description": "If true, the product is visible by the customer." - }, - "name": { - "type": "string", - "description": "Name of the product. It could be the same as the name of the product offering" - }, - "orderDate": { - "type": "string", - "format": "date-time", - "description": "Is the date when the product was ordered" - }, - "productCharacteristic": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - } - }, - "productOffering": { - "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "productOrderItem": { - "type": "array", - "items": { - "$ref": "RelatedProductOrderItem.schema.json#RelatedProductOrderItem" - } - }, - "product": { - "type": "array", - "items": { - "$ref": "ProductRefOrValue.schema.json#ProductRefOrValue" - } - }, - "productPrice": { - "type": "array", - "items": { - "$ref": "ProductPrice.schema.json#ProductPrice" - } - }, - "productRelationship": { - "type": "array", - "items": { - "$ref": "ProductRelationship.schema.json#ProductRelationship" - } - }, - "productSerialNumber": { - "type": "string", - "description": "Is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router." - }, - "productSpecification": { - "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef" - }, - "productTerm": { - "type": "array", - "items": { - "$ref": "ProductTerm.schema.json#ProductTerm" - } - }, - "realizingResource": { - "type": "array", - "items": { - "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" - } - }, - "realizingService": { - "type": "array", - "items": { - "$ref": "../Service/ServiceRef.schema.json#ServiceRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "place": { - "type": "array", - "items": { - "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" - } - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "Is the date from which the product starts" - }, - "status": { - "$ref": "ProductStatusType.schema.json#ProductStatusType", - "description": "Is the lifecycle status of the product." - }, - "terminationDate": { - "type": "string", - "format": "date-time", - "description": "Is the date when the product was terminated" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Product.schema.json", + "title": "Product", + "definitions": { + "Product": { + "$id": "#Product", + "type": "object", + "description": "A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service(s) and / or resource(s).", + "properties": { + "agreement": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementItemRef.schema.json#AgreementItemRef" + } + }, + "billingAccount": { + "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" + }, + "description": { + "type": "string", + "description": "Is the description of the product. It could be copied from the description of the Product Offering." + }, + "href": { + "type": "string", + "description": "Reference of the product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product" + }, + "isBundle": { + "type": "boolean", + "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." + }, + "isCustomerVisible": { + "type": "boolean", + "description": "If true, the product is visible by the customer." + }, + "name": { + "type": "string", + "description": "Name of the product. It could be the same as the name of the product offering" + }, + "orderDate": { + "type": "string", + "format": "date-time", + "description": "Is the date when the product was ordered" + }, + "productCharacteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "productOffering": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "productOrderItem": { + "type": "array", + "items": { + "$ref": "../Product/RelatedProductOrderItem.schema.json#RelatedProductOrderItem" + } + }, + "product": { + "type": "array", + "items": { + "$ref": "../Product/ProductRefOrValue.schema.json#ProductRefOrValue" + } + }, + "productPrice": { + "type": "array", + "items": { + "$ref": "../Product/ProductPrice.schema.json#ProductPrice" + } + }, + "productRelationship": { + "type": "array", + "items": { + "$ref": "../Product/ProductRelationship.schema.json#ProductRelationship" + } + }, + "productSerialNumber": { + "type": "string", + "description": "Is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router." + }, + "productSpecification": { + "$ref": "../Product/ProductSpecificationRef.schema.json#ProductSpecificationRef" + }, + "productTerm": { + "type": "array", + "items": { + "$ref": "../Product/ProductTerm.schema.json#ProductTerm" + } + }, + "realizingResource": { + "type": "array", + "items": { + "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" + } + }, + "realizingService": { + "type": "array", + "items": { + "$ref": "../Service/ServiceRef.schema.json#ServiceRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "place": { + "type": "array", + "items": { + "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" + } + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "Is the date from which the product starts" + }, + "status": { + "$ref": "../Product/ProductStatusType.schema.json#ProductStatusType", + "description": "Is the lifecycle status of the product." + }, + "terminationDate": { + "type": "string", + "format": "date-time", + "description": "Is the date when the product was terminated" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductActionType.schema.json b/Product/ProductActionType.schema.json index 06db8508..f1cd827f 100644 --- a/Product/ProductActionType.schema.json +++ b/Product/ProductActionType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductActionType.schema.json", - "title": "ProductActionType", - "definitions": { - "ProductActionType": { - "$id": "#ProductActionType", - "description": "action to be performed on the product", - "type": "string", - "enum": [ - "add", - "modify", - "delete", - "noChange" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductActionType.schema.json", + "title": "ProductActionType", + "definitions": { + "ProductActionType": { + "$id": "#ProductActionType", + "description": "action to be performed on the product", + "type": "string", + "enum": [ + "add", + "modify", + "delete", + "noChange" + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductCharacteristic.schema.json b/Product/ProductCharacteristic.schema.json index f43473ea..d9209887 100644 --- a/Product/ProductCharacteristic.schema.json +++ b/Product/ProductCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductCharacteristic.schema.json", - "title": "ProductCharacteristic", - "definitions": { - "ProductCharacteristic": { - "$id": "#ProductCharacteristic", - "description": "Characteristics of the product to instantiate or to modify", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "value": { - "type": "string", - "description": "Value of the characteristic" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductCharacteristic.schema.json", + "title": "ProductCharacteristic", + "definitions": { + "ProductCharacteristic": { + "$id": "#ProductCharacteristic", + "description": "Characteristics of the product to instantiate or to modify", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "value": { + "type": "string", + "description": "Value of the characteristic" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductInventoryRelationship.schema.json b/Product/ProductInventoryRelationship.schema.json index cf0bf96b..d62935fd 100644 --- a/Product/ProductInventoryRelationship.schema.json +++ b/Product/ProductInventoryRelationship.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductInventoryRelationship.schema.json", - "title": "ProductInventoryRelationship", - "definitions": { - "ProductInventoryRelationship": { - "$id": "#ProductInventoryRelationship", - "description": "Linked products to the one instantiate, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful", - "type": "object", - "required": [ - "relationshipType", - "product" - ], - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of the product relationship, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful" - }, - "product": { - "$ref": "ProductRef.schema.json#ProductRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductInventoryRelationship.schema.json", + "title": "ProductInventoryRelationship", + "definitions": { + "ProductInventoryRelationship": { + "$id": "#ProductInventoryRelationship", + "description": "Linked products to the one instantiate, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful", + "type": "object", + "required": [ + "relationshipType", + "product" + ], + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of the product relationship, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful" + }, + "product": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductOffering.schema.json b/Product/ProductOffering.schema.json index c0b3846a..a6cdf9cf 100644 --- a/Product/ProductOffering.schema.json +++ b/Product/ProductOffering.schema.json @@ -1,150 +1,150 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOffering.schema.json", - "title": "ProductOffering", - "definitions": { - "ProductOffering": { - "$id": "#ProductOffering", - "description": "Represents entities that are orderable from the provider of the catalog, this resource includes pricing information.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the productOffering" - }, - "href": { - "type": "string", - "description": "Reference of the ProductOffering" - }, - "id": { - "type": "string", - "description": "Unique identifier of the productOffering" - }, - "isBundle": { - "type": "boolean", - "description": "isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true)." - }, - "isSellable": { - "type": "boolean", - "description": "A flag indicating if this product offer can be sold stand-alone for sale or not. If this flag is false it indicates that the offer can only be sold within a bundle." - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the productOffering" - }, - "statusReason": { - "type": "string", - "description": "A string providing a complementary information on the value of the lifecycle status attribute." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productOffering is valid" - }, - "version": { - "type": "string", - "description": "ProductOffering version" - }, - "place": { - "type": "array", - "items": { - "$ref": "../Common/PlaceRef.schema.json#PlaceRef" - }, - "description": "Place defines the places where the products are sold or delivered." - }, - "serviceLevelAgreement": { - "$ref": "../EngagedParty/SLARef.schema.json#SLARef", - "description": "A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so forth. The SLA is a set of appropriate procedures and targets formally or informally agreed between parties in order to achieve and maintain specified Quality of Service." - }, - "productSpecification": { - "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef", - "description": "A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role." - }, - "channel": { - "type": "array", - "items": { - "$ref": "../Common/ChannelRef.schema.json#ChannelRef" - }, - "description": "The channel defines the channel for selling product offerings." - }, - "serviceCandidate": { - "$ref": "../Service/ServiceCandidateRef.schema.json#ServiceCandidateRef", - "description": "ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog." - }, - "category": { - "type": "array", - "items": { - "$ref": "CategoryRef.schema.json#CategoryRef" - }, - "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates." - }, - "resourceCandidate": { - "$ref": "../Resource/ResourceCandidateRef.schema.json#ResourceCandidateRef", - "description": "A resource candidate is an entity that makes a ResourceSpecification available to a catalog." - }, - "productOfferingTerm": { - "type": "array", - "items": { - "$ref": "ProductOfferingTerm.schema.json#ProductOfferingTerm" - }, - "description": "A condition under which a ProductOffering is made available to Customers. For instance, a productOffering can be offered with multiple commitment periods." - }, - "productOfferingPrice": { - "type": "array", - "items": { - "$ref": "ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" - }, - "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time and may not represent the actual price paid by a customer." - }, - "agreement": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" - }, - "description": "An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications." - }, - "attachment": { - "type": "array", - "items": { - "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" - }, - "description": "Complements the description of an element (for instance a product) through video, pictures..." - }, - "marketSegment": { - "type": "array", - "items": { - "$ref": "../MarketingSales/MarketSegmentRef.schema.json#MarketSegmentRef" - }, - "description": "provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth." - }, - "bundledProductOffering": { - "type": "array", - "items": { - "$ref": "BundledProductOffering.schema.json#BundledProductOffering" - }, - "description": "A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering." - }, - "prodSpecCharValueUse": { - "type": "array", - "items": { - "$ref": "ProductSpecificationCharacteristicValueUse.schema.json#ProductSpecificationCharacteristicValueUse" - }, - "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOffering.schema.json", + "title": "ProductOffering", + "definitions": { + "ProductOffering": { + "$id": "#ProductOffering", + "description": "Represents entities that are orderable from the provider of the catalog, this resource includes pricing information.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the productOffering" + }, + "href": { + "type": "string", + "description": "Reference of the ProductOffering" + }, + "id": { + "type": "string", + "description": "Unique identifier of the productOffering" + }, + "isBundle": { + "type": "boolean", + "description": "isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true)." + }, + "isSellable": { + "type": "boolean", + "description": "A flag indicating if this product offer can be sold stand-alone for sale or not. If this flag is false it indicates that the offer can only be sold within a bundle." + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the productOffering" + }, + "statusReason": { + "type": "string", + "description": "A string providing a complementary information on the value of the lifecycle status attribute." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productOffering is valid" + }, + "version": { + "type": "string", + "description": "ProductOffering version" + }, + "place": { + "type": "array", + "items": { + "$ref": "../Common/PlaceRef.schema.json#PlaceRef" + }, + "description": "Place defines the places where the products are sold or delivered." + }, + "serviceLevelAgreement": { + "$ref": "../EngagedParty/SLARef.schema.json#SLARef", + "description": "A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so forth. The SLA is a set of appropriate procedures and targets formally or informally agreed between parties in order to achieve and maintain specified Quality of Service." + }, + "productSpecification": { + "$ref": "../Product/ProductSpecificationRef.schema.json#ProductSpecificationRef", + "description": "A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role." + }, + "channel": { + "type": "array", + "items": { + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "description": "The channel defines the channel for selling product offerings." + }, + "serviceCandidate": { + "$ref": "../Service/ServiceCandidateRef.schema.json#ServiceCandidateRef", + "description": "ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog." + }, + "category": { + "type": "array", + "items": { + "$ref": "../Product/CategoryRef.schema.json#CategoryRef" + }, + "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates." + }, + "resourceCandidate": { + "$ref": "../Resource/ResourceCandidateRef.schema.json#ResourceCandidateRef", + "description": "A resource candidate is an entity that makes a ResourceSpecification available to a catalog." + }, + "productOfferingTerm": { + "type": "array", + "items": { + "$ref": "../Product/ProductOfferingTerm.schema.json#ProductOfferingTerm" + }, + "description": "A condition under which a ProductOffering is made available to Customers. For instance, a productOffering can be offered with multiple commitment periods." + }, + "productOfferingPrice": { + "type": "array", + "items": { + "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" + }, + "description": "An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time and may not represent the actual price paid by a customer." + }, + "agreement": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" + }, + "description": "An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications." + }, + "attachment": { + "type": "array", + "items": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + }, + "description": "Complements the description of an element (for instance a product) through video, pictures..." + }, + "marketSegment": { + "type": "array", + "items": { + "$ref": "../MarketingSales/MarketSegmentRef.schema.json#MarketSegmentRef" + }, + "description": "provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth." + }, + "bundledProductOffering": { + "type": "array", + "items": { + "$ref": "../Product/BundledProductOffering.schema.json#BundledProductOffering" + }, + "description": "A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering." + }, + "prodSpecCharValueUse": { + "type": "array", + "items": { + "$ref": "../Product/ProductSpecificationCharacteristicValueUse.schema.json#ProductSpecificationCharacteristicValueUse" + }, + "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductOfferingPrice.schema.json b/Product/ProductOfferingPrice.schema.json index 032ef06e..05dfba1b 100644 --- a/Product/ProductOfferingPrice.schema.json +++ b/Product/ProductOfferingPrice.schema.json @@ -1,149 +1,149 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingPrice.schema.json", - "title": "ProductOfferingPrice", - "definitions": { - "ProductOfferingPrice": { - "$id": "#ProductOfferingPrice", - "description": "Is based on both the basic cost to develop and produce products and the enterprises policy on revenue targets. This price may be further revised through discounting (productOfferPriceAlteration). The price, applied for a productOffering may also be influenced by the productOfferingTerm, the customer selected, eg: a productOffering can be offered with multiple terms, like commitment periods for the contract. The price may be influenced by this productOfferingTerm. A productOffering may be cheaper with a 24 month commitment than with a 12 month commitment.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "unique id of this resource" - }, - "href": { - "type": "string", - "description": "Reference of the ProductOfferingPrice" - }, - "name": { - "type": "string", - "description": "Name of the productOfferingPrice" - }, - "description": { - "type": "string", - "description": "Description of the productOfferingPrice" - }, - "version": { - "type": "string", - "description": "ProductOffering version" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productOfferingPrice is valid" - }, - "priceType": { - "type": "string", - "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth." - }, - "unitOfMeasure": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "A number and unit representing how many (for instance 1 dozen) of an ProductOffering is available at the offered price. Its meaning depends on the priceType. It could be a price, a rate, or a discount." - }, - "recurringChargePeriodType": { - "type": "string", - "description": "The period to repeat the application of the price\nCould be month, week..." - }, - "recurringChargePeriodLength": { - "type": "integer", - "description": "the period of the recurring charge: 1, 2, ... .It sets to zero if it is not applicable" - }, - "@type": { - "type": "string", - "description": "The class type of this Product offering" - }, - "@baseType": { - "type": "string", - "description": "the immediate base class type of this product offering" - }, - "@schemaLocation": { - "type": "string", - "description": "hyperlink reference to the schema describing this resource" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "the last update time of this ProductOfferingPrice" - }, - "isBundle": { - "type": "boolean", - "description": "A flag indicating if this ProductOfferingPrice is composite (bundle) or not" - }, - "lifecycleStatus": { - "type": "string", - "description": "the lifecycle status of this ProductOfferingPrice" - }, - "price": { - "$ref": "../Common/Money.schema.json#Money", - "description": "The amount of money that characterizes the price." - }, - "percentage": { - "type": "number", - "format": "float", - "description": "Percentage to apply for ProductOfferPriceAlteration (Discount)" - }, - "bundledPopRelationship": { - "type": "array", - "items": { - "$ref": "BundledProductOfferingPriceRelationship.schema.json#BundledProductOfferingPriceRelationship" - }, - "description": "this object represents a bundle relationship from a bundle product offering price (parent) to a simple product offering price (child). A simple product offering price may participate in more than one bundle relationship." - }, - "popRelationship": { - "type": "array", - "items": { - "$ref": "ProductOfferingPriceRelationship.schema.json#ProductOfferingPriceRelationship" - }, - "description": "Product Offering Prices related to this Product Offering Price, for example a price alteration such as allowance or discount" - }, - "prodSpecCharValueUse": { - "type": "array", - "items": { - "$ref": "ProductSpecificationCharacteristicValueUse.schema.json#ProductSpecificationCharacteristicValueUse" - }, - "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOfferingPrice to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering and ProcuctOfferingPrice level. The list of values in ProductSpecificationCharacteristicValueUse is a strict subset of the list of values as defined in the corresponding product specification characteristics." - }, - "productOfferingTerm": { - "type": "array", - "items": { - "$ref": "ProductOfferingTerm.schema.json#ProductOfferingTerm" - }, - "description": "A list of conditions under which a ProductOfferingPrice is made available to Customers. For instance, a Product Offering Price can be offered with multiple commitment periods." - }, - "place": { - "type": "array", - "items": { - "$ref": "../Common/PlaceRef.schema.json#PlaceRef" - }, - "description": "Place defines the places where the products are sold or delivered." - }, - "constraint": { - "type": "array", - "items": { - "$ref": "../Common/ConstraintRef.schema.json#ConstraintRef" - }, - "description": "The Constraint resource represents a policy/rule applied to ProductOfferingPrice." - }, - "pricingLogicAlgorithm": { - "type": "array", - "items": { - "$ref": "PricingLogicAlgorithm.schema.json#PricingLogicAlgorithm" - }, - "description": "The PricingLogicAlgorithm entity represents an instantiation of an interface specification to external rating function (without a modeled behavior in SID). Some of the parameters of the interface definition may be already set (such as price per unit) and some may be gathered during the rating process from the event (such as call duration) or from ProductCharacteristicValues (such as assigned bandwidth)." - }, - "tax": { - "type": "array", - "items": { - "$ref": "../Customer/TaxItem.schema.json#TaxItem" - }, - "description": "An amount of money levied on the price of a Product by a legislative body." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingPrice.schema.json", + "title": "ProductOfferingPrice", + "definitions": { + "ProductOfferingPrice": { + "$id": "#ProductOfferingPrice", + "description": "Is based on both the basic cost to develop and produce products and the enterprises policy on revenue targets. This price may be further revised through discounting (productOfferPriceAlteration). The price, applied for a productOffering may also be influenced by the productOfferingTerm, the customer selected, eg: a productOffering can be offered with multiple terms, like commitment periods for the contract. The price may be influenced by this productOfferingTerm. A productOffering may be cheaper with a 24 month commitment than with a 12 month commitment.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "unique id of this resource" + }, + "href": { + "type": "string", + "description": "Reference of the ProductOfferingPrice" + }, + "name": { + "type": "string", + "description": "Name of the productOfferingPrice" + }, + "description": { + "type": "string", + "description": "Description of the productOfferingPrice" + }, + "version": { + "type": "string", + "description": "ProductOffering version" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productOfferingPrice is valid" + }, + "priceType": { + "type": "string", + "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth." + }, + "unitOfMeasure": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "A number and unit representing how many (for instance 1 dozen) of an ProductOffering is available at the offered price. Its meaning depends on the priceType. It could be a price, a rate, or a discount." + }, + "recurringChargePeriodType": { + "type": "string", + "description": "The period to repeat the application of the price\nCould be month, week..." + }, + "recurringChargePeriodLength": { + "type": "integer", + "description": "the period of the recurring charge: 1, 2, ... .It sets to zero if it is not applicable" + }, + "@type": { + "type": "string", + "description": "The class type of this Product offering" + }, + "@baseType": { + "type": "string", + "description": "the immediate base class type of this product offering" + }, + "@schemaLocation": { + "type": "string", + "description": "hyperlink reference to the schema describing this resource" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "the last update time of this ProductOfferingPrice" + }, + "isBundle": { + "type": "boolean", + "description": "A flag indicating if this ProductOfferingPrice is composite (bundle) or not" + }, + "lifecycleStatus": { + "type": "string", + "description": "the lifecycle status of this ProductOfferingPrice" + }, + "price": { + "$ref": "../Common/Money.schema.json#Money", + "description": "The amount of money that characterizes the price." + }, + "percentage": { + "type": "number", + "format": "float", + "description": "Percentage to apply for ProductOfferPriceAlteration (Discount)" + }, + "bundledPopRelationship": { + "type": "array", + "items": { + "$ref": "../Product/BundledProductOfferingPriceRelationship.schema.json#BundledProductOfferingPriceRelationship" + }, + "description": "this object represents a bundle relationship from a bundle product offering price (parent) to a simple product offering price (child). A simple product offering price may participate in more than one bundle relationship." + }, + "popRelationship": { + "type": "array", + "items": { + "$ref": "../Product/ProductOfferingPriceRelationship.schema.json#ProductOfferingPriceRelationship" + }, + "description": "Product Offering Prices related to this Product Offering Price, for example a price alteration such as allowance or discount" + }, + "prodSpecCharValueUse": { + "type": "array", + "items": { + "$ref": "../Product/ProductSpecificationCharacteristicValueUse.schema.json#ProductSpecificationCharacteristicValueUse" + }, + "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOfferingPrice to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering and ProcuctOfferingPrice level. The list of values in ProductSpecificationCharacteristicValueUse is a strict subset of the list of values as defined in the corresponding product specification characteristics." + }, + "productOfferingTerm": { + "type": "array", + "items": { + "$ref": "../Product/ProductOfferingTerm.schema.json#ProductOfferingTerm" + }, + "description": "A list of conditions under which a ProductOfferingPrice is made available to Customers. For instance, a Product Offering Price can be offered with multiple commitment periods." + }, + "place": { + "type": "array", + "items": { + "$ref": "../Common/PlaceRef.schema.json#PlaceRef" + }, + "description": "Place defines the places where the products are sold or delivered." + }, + "constraint": { + "type": "array", + "items": { + "$ref": "../Common/ConstraintRef.schema.json#ConstraintRef" + }, + "description": "The Constraint resource represents a policy/rule applied to ProductOfferingPrice." + }, + "pricingLogicAlgorithm": { + "type": "array", + "items": { + "$ref": "../Product/PricingLogicAlgorithm.schema.json#PricingLogicAlgorithm" + }, + "description": "The PricingLogicAlgorithm entity represents an instantiation of an interface specification to external rating function (without a modeled behavior in SID). Some of the parameters of the interface definition may be already set (such as price per unit) and some may be gathered during the rating process from the event (such as call duration) or from ProductCharacteristicValues (such as assigned bandwidth)." + }, + "tax": { + "type": "array", + "items": { + "$ref": "../Customer/TaxItem.schema.json#TaxItem" + }, + "description": "An amount of money levied on the price of a Product by a legislative body." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductOfferingPriceRef.schema.json b/Product/ProductOfferingPriceRef.schema.json index 830eb049..a09adf92 100644 --- a/Product/ProductOfferingPriceRef.schema.json +++ b/Product/ProductOfferingPriceRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingPriceRef.schema.json", - "title": "ProductOfferingPriceRef", - "definitions": { - "ProductOfferingPriceRef": { - "$id": "#ProductOfferingPriceRef", - "description": "ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingPriceRef.schema.json", + "title": "ProductOfferingPriceRef", + "definitions": { + "ProductOfferingPriceRef": { + "$id": "#ProductOfferingPriceRef", + "description": "ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductOfferingPriceRelationship.schema.json b/Product/ProductOfferingPriceRelationship.schema.json index bfec733d..4c5cdd90 100644 --- a/Product/ProductOfferingPriceRelationship.schema.json +++ b/Product/ProductOfferingPriceRelationship.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingPriceRelationship.schema.json", - "title": "ProductOfferingPriceRelationship", - "definitions": { - "ProductOfferingPriceRelationship": { - "$id": "#ProductOfferingPriceRelationship", - "type": "object", - "description": "Describes a non-composite relationship between product offering prices. For example one price might be an discount alteration for another price.", - "properties": { - "href": { - "type": "string", - "description": "hyperlink reference of the associated product offering price" - }, - "id": { - "type": "string", - "description": "Unique identifier of the associated product offering price" - }, - "name": { - "type": "string", - "description": "Name of the associated product offering price" - }, - "relationshipType": { - "type": "string", - "description": "type of the relationship, for example override, discount, etc." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingPriceRelationship.schema.json", + "title": "ProductOfferingPriceRelationship", + "definitions": { + "ProductOfferingPriceRelationship": { + "$id": "#ProductOfferingPriceRelationship", + "type": "object", + "description": "Describes a non-composite relationship between product offering prices. For example one price might be an discount alteration for another price.", + "properties": { + "href": { + "type": "string", + "description": "hyperlink reference of the associated product offering price" + }, + "id": { + "type": "string", + "description": "Unique identifier of the associated product offering price" + }, + "name": { + "type": "string", + "description": "Name of the associated product offering price" + }, + "relationshipType": { + "type": "string", + "description": "type of the relationship, for example override, discount, etc." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductOfferingQualification.schema.json b/Product/ProductOfferingQualification.schema.json index 74cd8cfe..c9ab732b 100644 --- a/Product/ProductOfferingQualification.schema.json +++ b/Product/ProductOfferingQualification.schema.json @@ -1,109 +1,114 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingQualification.schema.json", - "title": "ProductOfferingQualification", - "definitions": { - "ProductOfferingQualification": { - "$id": "#ProductOfferingQualification", - "type": "object", - "required": [ - "productOfferingQualificationItem" - ], - "description": "ProductOfferingQualification is used to perform a commercial eligibility. It allows to retrieve a list of productOffering that are commercially available in the context of the interaction (defined be place, channel, party, product).", - "properties": { - "channel": { - "description": "Channel used for the qualification", - "$ref": "../Common/ChannelRef.schema.json#ChannelRef" - }, - "description": { - "type": "string", - "description": "Description of the productOfferingQualification" - }, - "effectiveQualificationDate": { - "type": "string", - "format": "date-time", - "description": "Effective date to productOfferingQualification completion" - }, - "expectedPOQCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Date when the requester expect to provide an answer for the qualification request" - }, - "expirationDate": { - "type": "string", - "format": "date-time", - "description": "Date the qualification response expires" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the productOfferingQualification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the productOfferingQualification resource" - }, - "instantSyncQualification": { - "type": "boolean", - "description": "An indicator which when the value is \"true\" means that requester expects to get qualifcation result immediately in the response. If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201." - }, - "note": { - "type": "array", - "description": "Free form text associated with the qualification request", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "productOfferingQualificationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the productOfferingQualification has been submitted" - }, - "productOfferingQualificationItem": { - "type": "array", - "description": "Qualification item for a product or a category", - "items": { - "$ref": "ProductOfferingQualificationItem.schema.json#ProductOfferingQualificationItem" - }, - "minItems": 1 - }, - "provideAlternative": { - "type": "boolean", - "description": "An indicator which when the value is \"true\" means that alternative solutions should be provided" - }, - "provideOnlyAvailable": { - "type": "boolean", - "description": "An indicator which when the value is \"true\" means that only available product offering must be listed in the response" - }, - "provideUnavailabilityReason": { - "type": "boolean", - "description": "An indicator which when the value is \"true\" means that unavailability reason are expected for non available product offering" - }, - "qualificationResult": { - "type": "string", - "description": "Result of the qualification (example: green, yellow, red)" - }, - "relatedParty": { - "type": "array", - "description": "Party playing a role for this qualification (as requester for example)", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "requestedPOQCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Deadline date when the requester expected a qualification answer" - }, - "state": { - "$ref": "../Common/TaskStateType.schema.json#TaskStateType", - "description": "State of the productOfferingQualification defined in the state engine" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingQualification.schema.json", + "title": "ProductOfferingQualification", + "definitions": { + "ProductOfferingQualification": { + "$id": "#ProductOfferingQualification", + "type": "object", + "description": "ProductOfferingQualification is used to perform a commercial eligibility. It allows to retrieve a list of productOffering that are commercially available in the context of the interaction (defined be place, channel, party, product).", + "properties": { + "channel": { + "description": "Channel used for the qualification", + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "category": { + "$ref": "../Product/CategoryRef.schema.json#CategoryRef" + }, + "description": { + "type": "string", + "description": "Description of the productOfferingQualification" + }, + "effectiveQualificationDate": { + "type": "string", + "format": "date-time", + "description": "Effective date to productOfferingQualification completion" + }, + "expectedPOQCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Date when the requester expect to provide an answer for the qualification request" + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "Date the qualification response expires" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the productOfferingQualification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the productOfferingQualification resource" + }, + "instantSyncQualification": { + "type": "boolean", + "description": "An indicator which when the value is \"true\" means that requester expects to get qualifcation result immediately in the response. If the indicator is true then the response code of 200 indicates the operation is successful otherwise a task is created with a response 201." + }, + "note": { + "type": "array", + "description": "Free form text associated with the qualification request", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "productOfferingQualificationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the productOfferingQualification has been submitted" + }, + "productOfferingQualificationItem": { + "type": "array", + "description": "Qualification item for a product or a category", + "items": { + "$ref": "../Product/ProductOfferingQualificationItem.schema.json#ProductOfferingQualificationItem" + } + }, + "provideAlternative": { + "type": "boolean", + "description": "An indicator which when the value is \"true\" means that alternative solutions should be provided" + }, + "provideOnlyAvailable": { + "type": "boolean", + "description": "An indicator which when the value is \"true\" means that only available product offering must be listed in the response" + }, + "provideUnavailabilityReason": { + "type": "boolean", + "description": "An indicator which when the value is \"true\" means that unavailability reason are expected for non available product offering" + }, + "qualificationResult": { + "type": "string", + "description": "Result of the qualification (example: green, yellow, red)" + }, + "relatedParty": { + "type": "array", + "description": "Party playing a role for this qualification (as requester for example)", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "place": { + "type": "array", + "items": { + "$ref": "../Common/RelatedPlaceRefOrValue.schema.json#RelatedPlaceRefOrValue" + } + }, + "requestedPOQCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Deadline date when the requester expected a qualification answer" + }, + "state": { + "$ref": "../Common/TaskStateType.schema.json#TaskStateType", + "description": "State of the productOfferingQualification defined in the state engine" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductOfferingQualificationItem.schema.json b/Product/ProductOfferingQualificationItem.schema.json index 0d8c97db..1fc7150e 100644 --- a/Product/ProductOfferingQualificationItem.schema.json +++ b/Product/ProductOfferingQualificationItem.schema.json @@ -1,78 +1,75 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingQualificationItem.schema.json", - "title": "ProductOfferingQualificationItem", - "definitions": { - "ProductOfferingQualificationItem": { - "$id": "#ProductOfferingQualificationItem", - "type": "object", - "properties": { - "expectedActivationDate": { - "type": "string", - "format": "date-time", - "description": "Date when the requester look for productOfferingQualification activation" - }, - "id": { - "type": "string", - "description": "Id of the productOfferingQualification item" - }, - "action": { - "description": "Can be \"add\" / \"modify\" / \"no_change\"/ \"delete\" - by default add is considered", - "$ref": "ProductActionType.schema.json#ProductActionType" - }, - "qualificationItemResult": { - "type": "string", - "description": "Qualification result for this productOfferingQualification item. It could be:\n\n qualified (request productOffering or productSpecification are available), \n unqualified (requested not available and not alternate available),\n alternate (requested not available but proposal available)\n" - }, - "state": { - "description": "State of the productOfferingQualification item defined in the state engine", - "$ref": "../Common/TaskStateType.schema.json#TaskStateType" - }, - "eligibilityUnavailabilityReason": { - "type": "array", - "items": { - "$ref": "EligibilityUnavailabilityReason.schema.json#EligibilityUnavailabilityReason" - } - }, - "category": { - "$ref": "CategoryRef.schema.json#CategoryRef" - }, - "qualificationItemRelationship": { - "type": "array", - "items": { - "$ref": "QualificationItemRelationship.schema.json#QualificationItemRelationship" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "product": { - "$ref": "ProductRefOrValue.schema.json#ProductRefOrValue" - }, - "terminationError": { - "type": "array", - "items": { - "$ref": "../Service/TerminationError.schema.json#TerminationError" - } - }, - "productOffering": { - "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "alternateProductOfferingProposal": { - "type": "array", - "items": { - "$ref": "AlternateProductOfferingProposal.schema.json#AlternateProductOfferingProposal" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingQualificationItem.schema.json", + "title": "ProductOfferingQualificationItem", + "definitions": { + "ProductOfferingQualificationItem": { + "$id": "#ProductOfferingQualificationItem", + "type": "object", + "properties": { + "expectedActivationDate": { + "type": "string", + "format": "date-time", + "description": "Date when the requester look for productOfferingQualification activation" + }, + "id": { + "type": "string", + "description": "Id of the productOfferingQualification item" + }, + "action": { + "description": "Can be \"add\" / \"modify\" / \"no_change\"/ \"delete\" - by default add is considered", + "$ref": "../Product/ProductActionType.schema.json#ProductActionType" + }, + "qualificationItemResult": { + "type": "string", + "description": "Qualification result for this productOfferingQualification item. It could be:\n\n qualified (request productOffering or productSpecification are available), \n unqualified (requested not available and not alternate available),\n alternate (requested not available but proposal available)\n" + }, + "state": { + "description": "State of the productOfferingQualification item defined in the state engine", + "$ref": "../Common/TaskStateType.schema.json#TaskStateType" + }, + "eligibilityUnavailabilityReason": { + "type": "array", + "items": { + "$ref": "../Product/EligibilityUnavailabilityReason.schema.json#EligibilityUnavailabilityReason" + } + }, + "qualificationItemRelationship": { + "type": "array", + "items": { + "$ref": "../Product/QualificationItemRelationship.schema.json#QualificationItemRelationship" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "product": { + "$ref": "../Product/ProductRefOrValue.schema.json#ProductRefOrValue" + }, + "terminationError": { + "type": "array", + "items": { + "$ref": "../Service/TerminationError.schema.json#TerminationError" + } + }, + "productOffering": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "alternateProductOfferingProposal": { + "type": "array", + "items": { + "$ref": "../Product/AlternateProductOfferingProposal.schema.json#AlternateProductOfferingProposal" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductOfferingQualificationItemRef.schema.json b/Product/ProductOfferingQualificationItemRef.schema.json index d437d635..c14c3b62 100644 --- a/Product/ProductOfferingQualificationItemRef.schema.json +++ b/Product/ProductOfferingQualificationItemRef.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingQualificationItemRef.schema.json", - "title": "ProductOfferingQualificationItemRef", - "definitions": { - "ProductOfferingQualificationItemRef": { - "$id": "#ProductOfferingQualificationItemRef", - "type": "object", - "description": "It's a productOfferingQualification item that has been executed previously.", - "required": [ - "id", - "productOfferingQualificationId" - ], - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "productOfferingQualificationHref": { - "type": "string", - "description": "Reference of the related entity." - }, - "productOfferingQualificationId": { - "type": "string", - "description": "Unique identifier of a related entity." - }, - "productOfferingQualificationName": { - "type": "string", - "description": "Name of the related entity." - }, - "id": { - "type": "string", - "description": "Id of an item of a product offering qualification" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingQualificationItemRef.schema.json", + "title": "ProductOfferingQualificationItemRef", + "definitions": { + "ProductOfferingQualificationItemRef": { + "$id": "#ProductOfferingQualificationItemRef", + "type": "object", + "description": "It's a productOfferingQualification item that has been executed previously.", + "required": [ + "id", + "productOfferingQualificationId" + ], + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "productOfferingQualificationHref": { + "type": "string", + "description": "Reference of the related entity." + }, + "productOfferingQualificationId": { + "type": "string", + "description": "Unique identifier of a related entity." + }, + "productOfferingQualificationName": { + "type": "string", + "description": "Name of the related entity." + }, + "id": { + "type": "string", + "description": "Id of an item of a product offering qualification" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductOfferingQualificationRef.schema.json b/Product/ProductOfferingQualificationRef.schema.json index 350b93cf..eb95bc13 100644 --- a/Product/ProductOfferingQualificationRef.schema.json +++ b/Product/ProductOfferingQualificationRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingQualificationRef.schema.json", - "title": "ProductOfferingQualificationRef", - "definitions": { - "ProductOfferingQualificationRef": { - "$id": "#ProductOfferingQualificationRef", - "type": "object", - "description": "It's a productOfferingQualification that has been executed previously", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingQualificationRef.schema.json", + "title": "ProductOfferingQualificationRef", + "definitions": { + "ProductOfferingQualificationRef": { + "$id": "#ProductOfferingQualificationRef", + "type": "object", + "description": "It's a productOfferingQualification that has been executed previously", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductOfferingQualificationStateType.schema.json b/Product/ProductOfferingQualificationStateType.schema.json index ccf4d9e2..116230c0 100644 --- a/Product/ProductOfferingQualificationStateType.schema.json +++ b/Product/ProductOfferingQualificationStateType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingQualificationStateType.schema.json", - "title": "ProductOfferingQualificationStateType", - "definitions": { - "ProductOfferingQualificationStateType": { - "$id": "#ProductOfferingQualificationStateType", - "type": "string", - "description": "Possible values for the state of the product offering qualification & item", - "enum": [ - "acknowledged", - "terminatedWithError", - "inProgress", - "done" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingQualificationStateType.schema.json", + "title": "ProductOfferingQualificationStateType", + "definitions": { + "ProductOfferingQualificationStateType": { + "$id": "#ProductOfferingQualificationStateType", + "type": "string", + "description": "Possible values for the state of the product offering qualification & item", + "enum": [ + "acknowledged", + "terminatedWithError", + "inProgress", + "done" + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductOfferingRef.schema.json b/Product/ProductOfferingRef.schema.json index dccf75b6..1d00c9e1 100644 --- a/Product/ProductOfferingRef.schema.json +++ b/Product/ProductOfferingRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingRef.schema.json", - "title": "ProductOfferingRef", - "definitions": { - "ProductOfferingRef": { - "$id": "#ProductOfferingRef", - "description": "ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingRef.schema.json", + "title": "ProductOfferingRef", + "definitions": { + "ProductOfferingRef": { + "$id": "#ProductOfferingRef", + "description": "ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductOfferingTerm.schema.json b/Product/ProductOfferingTerm.schema.json index 4cf84a49..24c1db6b 100644 --- a/Product/ProductOfferingTerm.schema.json +++ b/Product/ProductOfferingTerm.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductOfferingTerm.schema.json", - "title": "ProductOfferingTerm", - "definitions": { - "ProductOfferingTerm": { - "$id": "#ProductOfferingTerm", - "description": "A condition under which a ProductOffering is made available to Customers. For instance, a productOffering can be offered with multiple commitment periods.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the productOfferingTerm" - }, - "duration": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "Duration of the productOfferingTerm" - }, - "name": { - "type": "string", - "description": "Name of the productOfferingTerm" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productOfferingTerm is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductOfferingTerm.schema.json", + "title": "ProductOfferingTerm", + "definitions": { + "ProductOfferingTerm": { + "$id": "#ProductOfferingTerm", + "description": "A condition under which a ProductOffering is made available to Customers. For instance, a productOffering can be offered with multiple commitment periods.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the productOfferingTerm" + }, + "duration": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "Duration of the productOfferingTerm" + }, + "name": { + "type": "string", + "description": "Name of the productOfferingTerm" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productOfferingTerm is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductPrice.schema.json b/Product/ProductPrice.schema.json index 7959687e..e38cd4a1 100644 --- a/Product/ProductPrice.schema.json +++ b/Product/ProductPrice.schema.json @@ -1,58 +1,58 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductPrice.schema.json", - "title": "ProductPrice", - "definitions": { - "ProductPrice": { - "$id": "#ProductPrice", - "description": "An amount, usually of money, that represents the actual price paid by a Customer for a purchase, a rent or a lease of a Product. The price is valid for a defined period of time.", - "type": "object", - "required": [ - "priceType", - "price" - ], - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail the semantics of this product price." - }, - "name": { - "type": "string", - "description": "A short descriptive name such as \"Subscription price\"." - }, - "productOfferingPrice": { - "$ref": "ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" - }, - "billingAccount": { - "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" - }, - "priceType": { - "type": "string", - "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth." - }, - "recurringChargePeriod": { - "type": "string", - "description": "Could be month, week..." - }, - "unitOfMeasure": { - "type": "string", - "description": "Could be minutes, GB..." - }, - "productPriceAlteration": { - "type": "array", - "items": { - "$ref": "PriceAlteration.schema.json#PriceAlteration" - } - }, - "price": { - "$ref": "../Customer/Price.schema.json#Price" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductPrice.schema.json", + "title": "ProductPrice", + "definitions": { + "ProductPrice": { + "$id": "#ProductPrice", + "description": "An amount, usually of money, that represents the actual price paid by a Customer for a purchase, a rent or a lease of a Product. The price is valid for a defined period of time.", + "type": "object", + "required": [ + "priceType", + "price" + ], + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail the semantics of this product price." + }, + "name": { + "type": "string", + "description": "A short descriptive name such as \"Subscription price\"." + }, + "productOfferingPrice": { + "$ref": "../Product/ProductOfferingPriceRef.schema.json#ProductOfferingPriceRef" + }, + "billingAccount": { + "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" + }, + "priceType": { + "type": "string", + "description": "A category that describes the price, such as recurring, discount, allowance, penalty, and so forth." + }, + "recurringChargePeriod": { + "type": "string", + "description": "Could be month, week..." + }, + "unitOfMeasure": { + "type": "string", + "description": "Could be minutes, GB..." + }, + "productPriceAlteration": { + "type": "array", + "items": { + "$ref": "../Product/PriceAlteration.schema.json#PriceAlteration" + } + }, + "price": { + "$ref": "../Customer/Price.schema.json#Price" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductRef.schema.json b/Product/ProductRef.schema.json index b0ff84ec..64269d04 100644 --- a/Product/ProductRef.schema.json +++ b/Product/ProductRef.schema.json @@ -1,17 +1,17 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductRef.schema.json", - "title": "ProductRef", - "definitions": { - "ProductRef": { - "$id": "#ProductRef", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductRef.schema.json", + "title": "ProductRef", + "definitions": { + "ProductRef": { + "$id": "#ProductRef", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductRefOrValue.schema.json b/Product/ProductRefOrValue.schema.json index 66801d88..4b55313c 100644 --- a/Product/ProductRefOrValue.schema.json +++ b/Product/ProductRefOrValue.schema.json @@ -1,21 +1,21 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductRefOrValue.schema.json", - "title": "ProductRefOrValue", - "definitions": { - "ProductRefOrValue": { - "$id": "#ProductRefOrValue", - "description": "A product to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the product entity and not the RelatedProductRefOrValue class itself", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "ProductRef.schema.json#ProductRef" - }, - { - "$ref": "Product.schema.json#Product" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductRefOrValue.schema.json", + "title": "ProductRefOrValue", + "definitions": { + "ProductRefOrValue": { + "$id": "#ProductRefOrValue", + "description": "A product to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the product entity and not the RelatedProductRefOrValue class itself", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + { + "$ref": "../Product/Product.schema.json#Product" } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductRelationship.schema.json b/Product/ProductRelationship.schema.json index 8c84bc96..c90fabc4 100644 --- a/Product/ProductRelationship.schema.json +++ b/Product/ProductRelationship.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductRelationship.schema.json", - "title": "ProductRelationship", - "definitions": { - "ProductRelationship": { - "$id": "#ProductRelationship", - "description": "Linked products to the one instantiate, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful", - "type": "object", - "required": [ - "relationshipType", - "product" - ], - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of the product relationship, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful" - }, - "product": { - "$ref": "ProductRefOrValue.schema.json#ProductRefOrValue" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductRelationship.schema.json", + "title": "ProductRelationship", + "definitions": { + "ProductRelationship": { + "$id": "#ProductRelationship", + "description": "Linked products to the one instantiate, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful", + "type": "object", + "required": [ + "relationshipType", + "product" + ], + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of the product relationship, such as [bundled] if the product is a bundle and you want to describe the bundled products inside this bundle; [reliesOn] if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful" + }, + "product": { + "$ref": "../Product/ProductRefOrValue.schema.json#ProductRefOrValue" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductRequest.schema.json b/Product/ProductRequest.schema.json index 85534b74..caa4bbed 100644 --- a/Product/ProductRequest.schema.json +++ b/Product/ProductRequest.schema.json @@ -1,128 +1,128 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductRequest.schema.json", - "title": "ProductRequest", - "definitions": { - "ProductRequest": { - "$id": "#ProductRequest", - "type": "object", - "properties": { - "referredProduct": { - "$ref": "ProductRef.schema.json#ProductRef" - }, - "description": { - "type": "string", - "description": "Is the description of the product. It could be copied from the description of the Product Offering." - }, - "href": { - "type": "string", - "description": "Reference of the product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product" - }, - "isBundle": { - "type": "boolean", - "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." - }, - "isCustomerVisible": { - "type": "boolean", - "description": "If true, the product is visible by the customer." - }, - "name": { - "type": "string", - "description": "Name of the product. It could be the same as the name of the product offering" - }, - "orderDate": { - "type": "string", - "format": "date-time", - "description": "Is the date when the product was ordered" - }, - "productSerialNumber": { - "type": "string", - "description": "Is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router." - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "Is the date from which the product starts" - }, - "status": { - "type": "string", - "description": "Is the lifecycle status of the product." - }, - "terminationDate": { - "type": "string", - "format": "date-time", - "description": "Is the date when the product was terminated" - }, - "realizingService": { - "type": "array", - "items": { - "$ref": "../Service/ServiceRef.schema.json#ServiceRef" - } - }, - "billingAccount": { - "type": "array", - "items": { - "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" - } - }, - "productOffering": { - "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef" - }, - "agreement": { - "type": "array", - "items": { - "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "ProductCharacteristic.schema.json#ProductCharacteristic" - } - }, - "productRelationship": { - "type": "array", - "items": { - "$ref": "ProductRelationship.schema.json#ProductRelationship" - } - }, - "realizingResource": { - "type": "array", - "items": { - "$ref": "../Resource/RealizingResourceRef.schema.json#RealizingResourceRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "productPrice": { - "type": "array", - "items": { - "$ref": "ProductPrice.schema.json#ProductPrice" - } - }, - "productSpecification": { - "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef" - }, - "place": { - "type": "array", - "items": { - "$ref": "../Common/Place.schema.json#Place" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductRequest.schema.json", + "title": "ProductRequest", + "definitions": { + "ProductRequest": { + "$id": "#ProductRequest", + "type": "object", + "properties": { + "referredProduct": { + "$ref": "../Product/ProductRef.schema.json#ProductRef" + }, + "description": { + "type": "string", + "description": "Is the description of the product. It could be copied from the description of the Product Offering." + }, + "href": { + "type": "string", + "description": "Reference of the product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product" + }, + "isBundle": { + "type": "boolean", + "description": "If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering." + }, + "isCustomerVisible": { + "type": "boolean", + "description": "If true, the product is visible by the customer." + }, + "name": { + "type": "string", + "description": "Name of the product. It could be the same as the name of the product offering" + }, + "orderDate": { + "type": "string", + "format": "date-time", + "description": "Is the date when the product was ordered" + }, + "productSerialNumber": { + "type": "string", + "description": "Is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router." + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "Is the date from which the product starts" + }, + "status": { + "type": "string", + "description": "Is the lifecycle status of the product." + }, + "terminationDate": { + "type": "string", + "format": "date-time", + "description": "Is the date when the product was terminated" + }, + "realizingService": { + "type": "array", + "items": { + "$ref": "../Service/ServiceRef.schema.json#ServiceRef" + } + }, + "billingAccount": { + "type": "array", + "items": { + "$ref": "../Customer/BillingAccountRef.schema.json#BillingAccountRef" + } + }, + "productOffering": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef" + }, + "agreement": { + "type": "array", + "items": { + "$ref": "../EngagedParty/AgreementRef.schema.json#AgreementRef" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "../Product/ProductCharacteristic.schema.json#ProductCharacteristic" + } + }, + "productRelationship": { + "type": "array", + "items": { + "$ref": "../Product/ProductRelationship.schema.json#ProductRelationship" + } + }, + "realizingResource": { + "type": "array", + "items": { + "$ref": "../Resource/RealizingResourceRef.schema.json#RealizingResourceRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "productPrice": { + "type": "array", + "items": { + "$ref": "../Product/ProductPrice.schema.json#ProductPrice" + } + }, + "productSpecification": { + "$ref": "../Product/ProductSpecificationRef.schema.json#ProductSpecificationRef" + }, + "place": { + "type": "array", + "items": { + "$ref": "../Common/Place.schema.json#Place" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductRestriction.schema.json b/Product/ProductRestriction.schema.json index 09d68388..d258b7c3 100644 --- a/Product/ProductRestriction.schema.json +++ b/Product/ProductRestriction.schema.json @@ -1,58 +1,58 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductRestriction.schema.json", - "title": "ProductRestriction", - "definitions": { - "ProductRestriction": { - "$id": "#ProductRestriction", - "description": "In the context of a product order or a product offering qualification, this data structure captures the product information useful to order or qualified an existing subscribed product or to a new one. This is a subset of relevant product attributes for ordering and qualification", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the product" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product" - }, - "name": { - "type": "string", - "description": "This is the name of the product." - }, - "productCharacteristic": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - } - }, - "productRelationship": { - "type": "array", - "items": { - "$ref": "ProductRelationship.schema.json#ProductRelationship" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" - } - }, - "productSpecification": { - "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef" - }, - "relatedPlace": { - "type": "array", - "items": { - "$ref": "../Common/RelatedPlace.schema.json#RelatedPlace" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductRestriction.schema.json", + "title": "ProductRestriction", + "definitions": { + "ProductRestriction": { + "$id": "#ProductRestriction", + "description": "In the context of a product order or a product offering qualification, this data structure captures the product information useful to order or qualified an existing subscribed product or to a new one. This is a subset of relevant product attributes for ordering and qualification", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the product" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product" + }, + "name": { + "type": "string", + "description": "This is the name of the product." + }, + "productCharacteristic": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "productRelationship": { + "type": "array", + "items": { + "$ref": "../Product/ProductRelationship.schema.json#ProductRelationship" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedPartyRef.schema.json#RelatedPartyRef" + } + }, + "productSpecification": { + "$ref": "../Product/ProductSpecificationRef.schema.json#ProductSpecificationRef" + }, + "relatedPlace": { + "type": "array", + "items": { + "$ref": "../Common/RelatedPlace.schema.json#RelatedPlace" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductSpecCharRelationship.schema.json b/Product/ProductSpecCharRelationship.schema.json index b005c94e..f16977fa 100644 --- a/Product/ProductSpecCharRelationship.schema.json +++ b/Product/ProductSpecCharRelationship.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecCharRelationship.schema.json", - "title": "ProductSpecCharRelationship", - "definitions": { - "ProductSpecCharRelationship": { - "$id": "#ProductSpecCharRelationship", - "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productSpecCharRelationship is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecCharRelationship.schema.json", + "title": "ProductSpecCharRelationship", + "definitions": { + "ProductSpecCharRelationship": { + "$id": "#ProductSpecCharRelationship", + "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productSpecCharRelationship is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductSpecCharacteristic.schema.json b/Product/ProductSpecCharacteristic.schema.json index dc11e61b..1e4c4524 100644 --- a/Product/ProductSpecCharacteristic.schema.json +++ b/Product/ProductSpecCharacteristic.schema.json @@ -1,51 +1,51 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecCharacteristic.schema.json", - "title": "ProductSpecCharacteristic", - "definitions": { - "ProductSpecCharacteristic": { - "$id": "#ProductSpecCharacteristic", - "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", - "type": "object", - "properties": { - "configurable": { - "type": "boolean", - "description": "If true, the Boolean indicates that the productSpecCharacteristic is configurable" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the productSpecCharacteristic is" - }, - "name": { - "type": "string", - "description": "Name of the productSpecCharacteristic" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productSpecCharacteristic is valid" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" - }, - "productSpecCharRelationship": { - "type": "array", - "items": { - "$ref": "ProductSpecCharRelationship.schema.json#ProductSpecCharRelationship" - } - }, - "productSpecCharacteristicValue": { - "type": "array", - "items": { - "$ref": "ProductSpecCharacteristicValue.schema.json#ProductSpecCharacteristicValue" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecCharacteristic.schema.json", + "title": "ProductSpecCharacteristic", + "definitions": { + "ProductSpecCharacteristic": { + "$id": "#ProductSpecCharacteristic", + "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", + "type": "object", + "properties": { + "configurable": { + "type": "boolean", + "description": "If true, the Boolean indicates that the productSpecCharacteristic is configurable" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the productSpecCharacteristic is" + }, + "name": { + "type": "string", + "description": "Name of the productSpecCharacteristic" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productSpecCharacteristic is valid" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" + }, + "productSpecCharRelationship": { + "type": "array", + "items": { + "$ref": "../Product/ProductSpecCharRelationship.schema.json#ProductSpecCharRelationship" + } + }, + "productSpecCharacteristicValue": { + "type": "array", + "items": { + "$ref": "../Product/ProductSpecCharacteristicValue.schema.json#ProductSpecCharacteristicValue" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductSpecCharacteristicValue.schema.json b/Product/ProductSpecCharacteristicValue.schema.json index 60ddb502..af86f01d 100644 --- a/Product/ProductSpecCharacteristicValue.schema.json +++ b/Product/ProductSpecCharacteristicValue.schema.json @@ -1,47 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecCharacteristicValue.schema.json", - "title": "ProductSpecCharacteristicValue", - "definitions": { - "ProductSpecCharacteristicValue": { - "$id": "#ProductSpecCharacteristicValue", - "description": "A number or text that can be assigned to a ProductSpecCharacteristic.", - "type": "object", - "properties": { - "default": { - "type": "boolean", - "description": "Indicates if the value is the default value for a characteristic" - }, - "unitOfMeasure": { - "type": "string", - "description": "Could be minutes, GB..." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period of time for which a value is applicable" - }, - "value": { - "type": "string", - "description": "A discrete value that the characteristic can take on" - }, - "valueFrom": { - "type": "string", - "description": "The low range value that a characteristic can take on" - }, - "valueTo": { - "type": "string", - "description": "The upper range value that a characteristic can take on" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecCharacteristicValue.schema.json", + "title": "ProductSpecCharacteristicValue", + "definitions": { + "ProductSpecCharacteristicValue": { + "$id": "#ProductSpecCharacteristicValue", + "description": "A number or text that can be assigned to a ProductSpecCharacteristic.", + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Indicates if the value is the default value for a characteristic" + }, + "unitOfMeasure": { + "type": "string", + "description": "Could be minutes, GB..." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period of time for which a value is applicable" + }, + "value": { + "type": "string", + "description": "A discrete value that the characteristic can take on" + }, + "valueFrom": { + "type": "string", + "description": "The low range value that a characteristic can take on" + }, + "valueTo": { + "type": "string", + "description": "The upper range value that a characteristic can take on" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductSpecification.schema.json b/Product/ProductSpecification.schema.json index 4f7ba3b6..3b813909 100644 --- a/Product/ProductSpecification.schema.json +++ b/Product/ProductSpecification.schema.json @@ -1,117 +1,117 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecification.schema.json", - "title": "ProductSpecification", - "definitions": { - "ProductSpecification": { - "$id": "#ProductSpecification", - "description": "Is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.", - "type": "object", - "properties": { - "brand": { - "type": "string", - "description": "The manufacturer or trademark of the specification" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the product specification is" - }, - "href": { - "type": "string", - "description": "Reference of the product specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the product specification" - }, - "isBundle": { - "type": "boolean", - "description": "isBundle determines whether a productSpecification represents a single productSpecification (false), or a bundle of productSpecification (true)." - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "name": { - "type": "string", - "description": "Name of the product specification" - }, - "productNumber": { - "type": "string", - "description": "An identification number assigned to uniquely identity the specification" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the product specification is valid" - }, - "version": { - "type": "string", - "description": "Product specification version" - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "description": "A related party defines party or party role linked to a specific entity." - }, - "productSpecCharacteristic": { - "type": "array", - "items": { - "$ref": "ProductSpecificationCharacteristic.schema.json#ProductSpecificationCharacteristic" - }, - "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process." - }, - "serviceSpecification": { - "type": "array", - "items": { - "$ref": "../Service/ServiceSpecificationRef.schema.json#ServiceSpecificationRef" - }, - "description": "ServiceSpecification(s) required to realize a ProductSpecification." - }, - "productSpecificationRelationship": { - "type": "array", - "items": { - "$ref": "ProductSpecificationRelationship.schema.json#ProductSpecificationRelationship" - }, - "description": "A migration, substitution, dependency or exclusivity relationship between/among product specifications." - }, - "resourceSpecification": { - "type": "array", - "items": { - "$ref": "../Resource/ResourceSpecificationRef.schema.json#ResourceSpecificationRef" - }, - "description": "The ResourceSpecification is required to realize a ProductSpecification." - }, - "attachment": { - "type": "array", - "items": { - "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" - }, - "description": "Complements the description of an element (for instance a product) through video, pictures..." - }, - "bundledProductSpecification": { - "type": "array", - "items": { - "$ref": "BundledProductSpecification.schema.json#BundledProductSpecification" - }, - "description": "A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification." - }, - "targetProductSchema": { - "description": "A target product schema reference. The reference object to the schema and type of target product which is described by product specification.", - "$ref": "TargetProductSchema.schema.json#TargetProductSchema" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecification.schema.json", + "title": "ProductSpecification", + "definitions": { + "ProductSpecification": { + "$id": "#ProductSpecification", + "description": "Is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.", + "type": "object", + "properties": { + "brand": { + "type": "string", + "description": "The manufacturer or trademark of the specification" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the product specification is" + }, + "href": { + "type": "string", + "description": "Reference of the product specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the product specification" + }, + "isBundle": { + "type": "boolean", + "description": "isBundle determines whether a productSpecification represents a single productSpecification (false), or a bundle of productSpecification (true)." + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "name": { + "type": "string", + "description": "Name of the product specification" + }, + "productNumber": { + "type": "string", + "description": "An identification number assigned to uniquely identity the specification" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the product specification is valid" + }, + "version": { + "type": "string", + "description": "Product specification version" + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "description": "A related party defines party or party role linked to a specific entity." + }, + "productSpecCharacteristic": { + "type": "array", + "items": { + "$ref": "../Product/ProductSpecificationCharacteristic.schema.json#ProductSpecificationCharacteristic" + }, + "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process." + }, + "serviceSpecification": { + "type": "array", + "items": { + "$ref": "../Service/ServiceSpecificationRef.schema.json#ServiceSpecificationRef" + }, + "description": "ServiceSpecification(s) required to realize a ProductSpecification." + }, + "productSpecificationRelationship": { + "type": "array", + "items": { + "$ref": "../Product/ProductSpecificationRelationship.schema.json#ProductSpecificationRelationship" + }, + "description": "A migration, substitution, dependency or exclusivity relationship between/among product specifications." + }, + "resourceSpecification": { + "type": "array", + "items": { + "$ref": "../Resource/ResourceSpecificationRef.schema.json#ResourceSpecificationRef" + }, + "description": "The ResourceSpecification is required to realize a ProductSpecification." + }, + "attachment": { + "type": "array", + "items": { + "$ref": "../Common/AttachmentRefOrValue.schema.json#AttachmentRefOrValue" + }, + "description": "Complements the description of an element (for instance a product) through video, pictures..." + }, + "bundledProductSpecification": { + "type": "array", + "items": { + "$ref": "../Product/BundledProductSpecification.schema.json#BundledProductSpecification" + }, + "description": "A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification." + }, + "targetProductSchema": { + "description": "A target product schema reference. The reference object to the schema and type of target product which is described by product specification.", + "$ref": "../Product/TargetProductSchema.schema.json#TargetProductSchema" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductSpecificationCharacteristic.schema.json b/Product/ProductSpecificationCharacteristic.schema.json index b427e84c..fb4b36b4 100644 --- a/Product/ProductSpecificationCharacteristic.schema.json +++ b/Product/ProductSpecificationCharacteristic.schema.json @@ -1,73 +1,73 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationCharacteristic.schema.json", - "title": "ProductSpecificationCharacteristic", - "definitions": { - "ProductSpecificationCharacteristic": { - "$id": "#ProductSpecificationCharacteristic", - "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", - "type": "object", - "properties": { - "configurable": { - "type": "boolean", - "description": "If true, the Boolean indicates that the ProductSpecificationCharacteristic is configurable" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the ProductSpecificationCharacteristic is" - }, - "extensible": { - "type": "boolean", - "description": "An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a product" - }, - "isUnique": { - "type": "boolean", - "description": "An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"" - }, - "maxCardinality": { - "type": "integer", - "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality" - }, - "minCardinality": { - "type": "integer", - "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality" - }, - "name": { - "type": "string", - "description": "Name of the ProductSpecificationCharacteristic" - }, - "regex": { - "type": "string", - "description": "A rule or principle represented in regular expression used to derive the value of a characteristic value" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" - }, - "productSpecCharacteristicValue": { - "type": "array", - "items": { - "$ref": "ProductSpecificationCharacteristicValue.schema.json#ProductSpecificationCharacteristicValue" - }, - "description": "A ProductSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ProductSpecificationCharacteristic object. The values of the attributes in the ProductSpecificationCharacteristicValue object describe the values of the attributes that a corresponding ProductSpecificationCharacteristic object can take on." - }, - "productSpecCharRelationship": { - "type": "array", - "items": { - "$ref": "ProductSpecificationCharacteristicRelationship.schema.json#ProductSpecificationCharacteristicRelationship" - }, - "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the ProductSpecificationCharacteristic is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationCharacteristic.schema.json", + "title": "ProductSpecificationCharacteristic", + "definitions": { + "ProductSpecificationCharacteristic": { + "$id": "#ProductSpecificationCharacteristic", + "description": "A characteristic quality or distinctive feature of a ProductSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.", + "type": "object", + "properties": { + "configurable": { + "type": "boolean", + "description": "If true, the Boolean indicates that the ProductSpecificationCharacteristic is configurable" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the ProductSpecificationCharacteristic is" + }, + "extensible": { + "type": "boolean", + "description": "An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a product" + }, + "isUnique": { + "type": "boolean", + "description": "An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"" + }, + "maxCardinality": { + "type": "integer", + "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality" + }, + "minCardinality": { + "type": "integer", + "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality" + }, + "name": { + "type": "string", + "description": "Name of the ProductSpecificationCharacteristic" + }, + "regex": { + "type": "string", + "description": "A rule or principle represented in regular expression used to derive the value of a characteristic value" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" + }, + "productSpecCharacteristicValue": { + "type": "array", + "items": { + "$ref": "../Product/ProductSpecificationCharacteristicValue.schema.json#ProductSpecificationCharacteristicValue" + }, + "description": "A ProductSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ProductSpecificationCharacteristic object. The values of the attributes in the ProductSpecificationCharacteristicValue object describe the values of the attributes that a corresponding ProductSpecificationCharacteristic object can take on." + }, + "productSpecCharRelationship": { + "type": "array", + "items": { + "$ref": "../Product/ProductSpecificationCharacteristicRelationship.schema.json#ProductSpecificationCharacteristicRelationship" + }, + "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the ProductSpecificationCharacteristic is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductSpecificationCharacteristicRelationship.schema.json b/Product/ProductSpecificationCharacteristicRelationship.schema.json index f060913a..138c059f 100644 --- a/Product/ProductSpecificationCharacteristicRelationship.schema.json +++ b/Product/ProductSpecificationCharacteristicRelationship.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationCharacteristicRelationship.schema.json", - "title": "ProductSpecificationCharacteristicRelationship", - "definitions": { - "ProductSpecificationCharacteristicRelationship": { - "$id": "#ProductSpecificationCharacteristicRelationship", - "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecificationCharacteristics.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "the identifier of the associated product specification" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to the target product specification" - }, - "charSpecSeq": { - "type": "integer", - "description": "The order in which a CharacteristicSpecification appears within another CharacteristicSpecification that defines a grouping of CharacteristicSpecifications.\n\nFor example, a grouping may represent the name of an individual. The given name is first, the middle name is second, and the last name is third." - }, - "name": { - "type": "string", - "description": "Name of the target product specification characteristic" - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productSpecificationCharacteristicRelationship is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationCharacteristicRelationship.schema.json", + "title": "ProductSpecificationCharacteristicRelationship", + "definitions": { + "ProductSpecificationCharacteristicRelationship": { + "$id": "#ProductSpecificationCharacteristicRelationship", + "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecificationCharacteristics.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "the identifier of the associated product specification" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to the target product specification" + }, + "charSpecSeq": { + "type": "integer", + "description": "The order in which a CharacteristicSpecification appears within another CharacteristicSpecification that defines a grouping of CharacteristicSpecifications.\n\nFor example, a grouping may represent the name of an individual. The given name is first, the middle name is second, and the last name is third." + }, + "name": { + "type": "string", + "description": "Name of the target product specification characteristic" + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productSpecificationCharacteristicRelationship is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductSpecificationCharacteristicValue.schema.json b/Product/ProductSpecificationCharacteristicValue.schema.json index c60c7dfe..7d4ee472 100644 --- a/Product/ProductSpecificationCharacteristicValue.schema.json +++ b/Product/ProductSpecificationCharacteristicValue.schema.json @@ -1,55 +1,55 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationCharacteristicValue.schema.json", - "title": "ProductSpecificationCharacteristicValue", - "definitions": { - "ProductSpecificationCharacteristicValue": { - "$id": "#ProductSpecificationCharacteristicValue", - "description": "A ProductSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ProductSpecificationCharacteristic object. The values of the attributes in the ProductSpecificationCharacteristicValue object describe the values of the attributes that a corresponding ProductSpecificationCharacteristic object can take on.", - "type": "object", - "properties": { - "isDefault": { - "type": "boolean", - "description": "Indicates if the value is the default value for a characteristic" - }, - "rangeInterval": { - "type": "string", - "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." - }, - "regex": { - "type": "string", - "description": "Regular expression to define constraint on the allowed value" - }, - "unitOfMeasure": { - "type": "string", - "description": "A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period of time for which a value is applicable" - }, - "value": { - "$ref": "../Common/Any.schema.json#Any", - "description": "A discrete value that the characteristic can take on, or the actual value of the characteristic" - }, - "valueFrom": { - "type": "string", - "description": "The low range value that a characteristic can take on" - }, - "valueTo": { - "type": "string", - "description": "The upper range value that a characteristic can take on" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationCharacteristicValue.schema.json", + "title": "ProductSpecificationCharacteristicValue", + "definitions": { + "ProductSpecificationCharacteristicValue": { + "$id": "#ProductSpecificationCharacteristicValue", + "description": "A ProductSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ProductSpecificationCharacteristic object. The values of the attributes in the ProductSpecificationCharacteristicValue object describe the values of the attributes that a corresponding ProductSpecificationCharacteristic object can take on.", + "type": "object", + "properties": { + "isDefault": { + "type": "boolean", + "description": "Indicates if the value is the default value for a characteristic" + }, + "rangeInterval": { + "type": "string", + "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." + }, + "regex": { + "type": "string", + "description": "Regular expression to define constraint on the allowed value" + }, + "unitOfMeasure": { + "type": "string", + "description": "A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period of time for which a value is applicable" + }, + "value": { + "$ref": "../Common/Any.schema.json#Any", + "description": "A discrete value that the characteristic can take on, or the actual value of the characteristic" + }, + "valueFrom": { + "type": "string", + "description": "The low range value that a characteristic can take on" + }, + "valueTo": { + "type": "string", + "description": "The upper range value that a characteristic can take on" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductSpecificationCharacteristicValueUse.schema.json b/Product/ProductSpecificationCharacteristicValueUse.schema.json index ed1f2415..0904efc8 100644 --- a/Product/ProductSpecificationCharacteristicValueUse.schema.json +++ b/Product/ProductSpecificationCharacteristicValueUse.schema.json @@ -1,49 +1,49 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationCharacteristicValueUse.schema.json", - "title": "ProductSpecificationCharacteristicValueUse", - "definitions": { - "ProductSpecificationCharacteristicValueUse": { - "$id": "#ProductSpecificationCharacteristicValueUse", - "type": "object", - "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.", - "properties": { - "name": { - "type": "string", - "description": "Name of the associated productSpecificationCharacteristic" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the productSpecificationCharacteristic is" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" - }, - "minCardinality": { - "type": "integer", - "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality." - }, - "maxCardinality": { - "type": "integer", - "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productSpecificationCharacteristic is valid" - }, - "productSpecCharacteristicValue": { - "type": "array", - "items": { - "$ref": "ProductSpecificationCharacteristicValue.schema.json#ProductSpecificationCharacteristicValue" - }, - "description": "A number or text that can be assigned to a ProductSpecificationCharacteristic." - }, - "productSpecification": { - "$ref": "ProductSpecificationRef.schema.json#ProductSpecificationRef", - "description": "A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role." - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationCharacteristicValueUse.schema.json", + "title": "ProductSpecificationCharacteristicValueUse", + "definitions": { + "ProductSpecificationCharacteristicValueUse": { + "$id": "#ProductSpecificationCharacteristicValueUse", + "type": "object", + "description": "A use of the ProductSpecificationCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProductSpecificationCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.", + "properties": { + "name": { + "type": "string", + "description": "Name of the associated productSpecificationCharacteristic" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the productSpecificationCharacteristic is" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" + }, + "minCardinality": { + "type": "integer", + "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality." + }, + "maxCardinality": { + "type": "integer", + "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productSpecificationCharacteristic is valid" + }, + "productSpecCharacteristicValue": { + "type": "array", + "items": { + "$ref": "../Product/ProductSpecificationCharacteristicValue.schema.json#ProductSpecificationCharacteristicValue" + }, + "description": "A number or text that can be assigned to a ProductSpecificationCharacteristic." + }, + "productSpecification": { + "$ref": "../Product/ProductSpecificationRef.schema.json#ProductSpecificationRef", + "description": "A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role." } + } } -} \ No newline at end of file + } +} diff --git a/Product/ProductSpecificationRef.schema.json b/Product/ProductSpecificationRef.schema.json index 84bbfe76..18aa5634 100644 --- a/Product/ProductSpecificationRef.schema.json +++ b/Product/ProductSpecificationRef.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationRef.schema.json", - "title": "ProductSpecificationRef", - "definitions": { - "ProductSpecificationRef": { - "$id": "#ProductSpecificationRef", - "description": "Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.", - "type": "object", - "properties": { - "version": { - "type": "string", - "description": "Version of the product specification" - }, - "targetProductSchema": { - "description": "A target product schema reference. The reference object to the schema and type of target product which is described by product specification.", - "$ref": "TargetProductSchema.schema.json#TargetProductSchema" - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationRef.schema.json", + "title": "ProductSpecificationRef", + "definitions": { + "ProductSpecificationRef": { + "$id": "#ProductSpecificationRef", + "description": "Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "Version of the product specification" + }, + "targetProductSchema": { + "description": "A target product schema reference. The reference object to the schema and type of target product which is described by product specification.", + "$ref": "../Product/TargetProductSchema.schema.json#TargetProductSchema" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductSpecificationRelationship.schema.json b/Product/ProductSpecificationRelationship.schema.json index 577e0ce6..d95fb408 100644 --- a/Product/ProductSpecificationRelationship.schema.json +++ b/Product/ProductSpecificationRelationship.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationRelationship.schema.json", - "title": "ProductSpecificationRelationship", - "definitions": { - "ProductSpecificationRelationship": { - "$id": "#ProductSpecificationRelationship", - "description": "A migration, substitution, dependency or exclusivity relationship between/among product specifications.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the productSpecification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the productSpecification" - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship such as migration, substitution, dependency, exclusivity" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the productSpecificationRelationship is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationRelationship.schema.json", + "title": "ProductSpecificationRelationship", + "definitions": { + "ProductSpecificationRelationship": { + "$id": "#ProductSpecificationRelationship", + "description": "A migration, substitution, dependency or exclusivity relationship between/among product specifications.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the productSpecification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the productSpecification" + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship such as migration, substitution, dependency, exclusivity" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the productSpecificationRelationship is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductSpecificationSchemaRef.schema.json b/Product/ProductSpecificationSchemaRef.schema.json index b2d5074a..3be9ed3b 100644 --- a/Product/ProductSpecificationSchemaRef.schema.json +++ b/Product/ProductSpecificationSchemaRef.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductSpecificationSchemaRef.schema.json", - "title": "ProductSpecificationSchemaRef", - "definitions": { - "ProductSpecificationSchemaRef": { - "$id": "#ProductSpecificationSchemaRef", - "description": "ProductSpecification description could be done with schema use. This information allows to retrieve schema type and location", - "type": "object", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductSpecificationSchemaRef.schema.json", + "title": "ProductSpecificationSchemaRef", + "definitions": { + "ProductSpecificationSchemaRef": { + "$id": "#ProductSpecificationSchemaRef", + "description": "ProductSpecification description could be done with schema use. This information allows to retrieve schema type and location", + "type": "object", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductStatusType.schema.json b/Product/ProductStatusType.schema.json index da3e0700..4c6a3a63 100644 --- a/Product/ProductStatusType.schema.json +++ b/Product/ProductStatusType.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductStatusType.schema.json", - "title": "ProductStatusType", - "definitions": { - "ProductStatusType": { - "$id": "#ProductStatusType", - "type": "string", - "description": "Possible values for the status of the product", - "enum": [ - "created", - "pendingActive", - "cancelled", - "active", - "pendingTerminate", - "terminated", - "suspended", - "aborted " - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductStatusType.schema.json", + "title": "ProductStatusType", + "definitions": { + "ProductStatusType": { + "$id": "#ProductStatusType", + "type": "string", + "description": "Possible values for the status of the product", + "enum": [ + "created", + "pendingActive", + "cancelled", + "active", + "pendingTerminate", + "terminated", + "suspended", + "aborted " + ] } -} \ No newline at end of file + } +} diff --git a/Product/ProductTerm.schema.json b/Product/ProductTerm.schema.json index 800b343b..84f92f3b 100644 --- a/Product/ProductTerm.schema.json +++ b/Product/ProductTerm.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProductTerm.schema.json", - "title": "ProductTerm", - "definitions": { - "ProductTerm": { - "$id": "#ProductTerm", - "description": "Description of a productTerm linked to this product. This represent a commitment with a duration", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the productTerm" - }, - "duration": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "Duration of the productTerm" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "productTerm validity period" - }, - "name": { - "type": "string", - "description": "Name of the productTerm" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProductTerm.schema.json", + "title": "ProductTerm", + "definitions": { + "ProductTerm": { + "$id": "#ProductTerm", + "description": "Description of a productTerm linked to this product. This represent a commitment with a duration", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the productTerm" + }, + "duration": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "Duration of the productTerm" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "productTerm validity period" + }, + "name": { + "type": "string", + "description": "Name of the productTerm" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/Promotion.schema.json b/Product/Promotion.schema.json index bd5b9be0..b7525fe1 100644 --- a/Product/Promotion.schema.json +++ b/Product/Promotion.schema.json @@ -1,58 +1,58 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Promotion.schema.json", - "title": "Promotion", - "definitions": { - "Promotion": { - "$id": "#Promotion", - "description": "Promotion Resource is used to provide the additional discount, voucher, bonus or gift to the customer who meets the pre-defined criteria. Using promotion, the enterprise is able to attract the users and encourage more consumption, especially continuous purchases. Normally Promotion is not regarded as one type of product or product offering. It is often applied when the customer buys the product offerings with the price or amount surpassing the certain limit.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of Promotion" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the Promotion" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Promotion" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Latest update date of the Promotion" - }, - "lifecycleStatus": { - "type": "string", - "description": "Status of the Promotion, including Draft/Test/WaitForApproval/Release/Suspend/Retirement" - }, - "name": { - "type": "string", - "description": "Name of the Promotion" - }, - "promotionType": { - "type": "string", - "description": "Type of the Promotion. The basic type is Award/Discount/Reduction. More types can be extended in future" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the Promotion is valid" - }, - "pattern": { - "type": "array", - "items": { - "$ref": "PromotionPattern.schema.json#PromotionPattern" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Promotion.schema.json", + "title": "Promotion", + "definitions": { + "Promotion": { + "$id": "#Promotion", + "description": "Promotion Resource is used to provide the additional discount, voucher, bonus or gift to the customer who meets the pre-defined criteria. Using promotion, the enterprise is able to attract the users and encourage more consumption, especially continuous purchases. Normally Promotion is not regarded as one type of product or product offering. It is often applied when the customer buys the product offerings with the price or amount surpassing the certain limit.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Promotion" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the Promotion" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Promotion" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Latest update date of the Promotion" + }, + "lifecycleStatus": { + "type": "string", + "description": "Status of the Promotion, including Draft/Test/WaitForApproval/Release/Suspend/Retirement" + }, + "name": { + "type": "string", + "description": "Name of the Promotion" + }, + "promotionType": { + "type": "string", + "description": "Type of the Promotion. The basic type is Award/Discount/Reduction. More types can be extended in future" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the Promotion is valid" + }, + "pattern": { + "type": "array", + "items": { + "$ref": "../Product/PromotionPattern.schema.json#PromotionPattern" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/PromotionAction.schema.json b/Product/PromotionAction.schema.json index 888a4c3b..0fb9cda9 100644 --- a/Product/PromotionAction.schema.json +++ b/Product/PromotionAction.schema.json @@ -1,36 +1,36 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PromotionAction.schema.json", - "title": "PromotionAction", - "definitions": { - "PromotionAction": { - "$id": "#PromotionAction", - "description": "Action of the promotion.When the customer meets the conditions in the promotion pattern, the customer can be given the benefits in the action.", - "type": "object", - "properties": { - "actionObjectId": { - "type": "string", - "description": "It refers to the object (entity) ID which is impacted by the promotion action. When the Promotion -> type is 1: Award, the actionObjectId is the sub-account ID; When the Promotion -> type is 2: Discount, it is the offering ID; When the Promotion -> type is 3: reduction, it is the offering ID." - }, - "actionType": { - "type": "string", - "description": "When the Promotion -> type is 1: Award, the action type can be one of the following:voice (minute),data (MB),data (GB),SMS,bonus point,physical gift,voucher,promotion code,an existing offering,currency. More types of action can be extended in future." - }, - "actionValue": { - "type": "number", - "format": "float", - "description": "When the Promotion -> type is 1: Award, it means the amount or value of the awards decided by actionType, such as:Amount of gift,Amount of bonus,Value of discount; When the Promotion -> type is 2: Discount, it means the value of the discount; When the Promotion -> type is 3: reduction, it means the value of the reduced money ." - }, - "id": { - "type": "string", - "description": "Unique identifier." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PromotionAction.schema.json", + "title": "PromotionAction", + "definitions": { + "PromotionAction": { + "$id": "#PromotionAction", + "description": "Action of the promotion.When the customer meets the conditions in the promotion pattern, the customer can be given the benefits in the action.", + "type": "object", + "properties": { + "actionObjectId": { + "type": "string", + "description": "It refers to the object (entity) ID which is impacted by the promotion action. When the Promotion -> type is 1: Award, the actionObjectId is the sub-account ID; When the Promotion -> type is 2: Discount, it is the offering ID; When the Promotion -> type is 3: reduction, it is the offering ID." + }, + "actionType": { + "type": "string", + "description": "When the Promotion -> type is 1: Award, the action type can be one of the following:voice (minute),data (MB),data (GB),SMS,bonus point,physical gift,voucher,promotion code,an existing offering,currency. More types of action can be extended in future." + }, + "actionValue": { + "type": "number", + "format": "float", + "description": "When the Promotion -> type is 1: Award, it means the amount or value of the awards decided by actionType, such as:Amount of gift,Amount of bonus,Value of discount; When the Promotion -> type is 2: Discount, it means the value of the discount; When the Promotion -> type is 3: reduction, it means the value of the reduced money ." + }, + "id": { + "type": "string", + "description": "Unique identifier." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/PromotionCriteria.schema.json b/Product/PromotionCriteria.schema.json index a8a4ff1b..8abd9fde 100644 --- a/Product/PromotionCriteria.schema.json +++ b/Product/PromotionCriteria.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PromotionCriteria.schema.json", - "title": "PromotionCriteria", - "definitions": { - "PromotionCriteria": { - "$id": "#PromotionCriteria", - "description": "Criteria of the promotion.", - "type": "object", - "properties": { - "criteriaOperator": { - "type": "string", - "description": "The logic expression including parameter and operator. including:=,>,<,>=,<=,<>" - }, - "criteriaPara": { - "type": "string", - "description": "The parameter (factor) of the criteria.The basic factors are abstracted from these data sources. There are several detail parameters ." - }, - "criteriaValue": { - "type": "string", - "description": "The value is filled for the comparison of the criteria." - }, - "id": { - "type": "string", - "description": "Unique identifier." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PromotionCriteria.schema.json", + "title": "PromotionCriteria", + "definitions": { + "PromotionCriteria": { + "$id": "#PromotionCriteria", + "description": "Criteria of the promotion.", + "type": "object", + "properties": { + "criteriaOperator": { + "type": "string", + "description": "The logic expression including parameter and operator. including:=,>,<,>=,<=,<>" + }, + "criteriaPara": { + "type": "string", + "description": "The parameter (factor) of the criteria.The basic factors are abstracted from these data sources. There are several detail parameters ." + }, + "criteriaValue": { + "type": "string", + "description": "The value is filled for the comparison of the criteria." + }, + "id": { + "type": "string", + "description": "Unique identifier." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/PromotionCriteriaGroup.schema.json b/Product/PromotionCriteriaGroup.schema.json index 6108cd54..77e480a1 100644 --- a/Product/PromotionCriteriaGroup.schema.json +++ b/Product/PromotionCriteriaGroup.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PromotionCriteriaGroup.schema.json", - "title": "PromotionCriteriaGroup", - "definitions": { - "PromotionCriteriaGroup": { - "$id": "#PromotionCriteriaGroup", - "description": "The group of the criteria of the promotion. The logical relationship between different groups is decided by the relationTypeInGroup.", - "type": "object", - "properties": { - "groupName": { - "type": "string", - "description": "Name of the group." - }, - "id": { - "type": "string", - "description": "Unique Identifier" - }, - "relationTypeInGroup": { - "type": "string", - "description": "AND/OR,The logical relation type amongst the various criteria inside a promotion criteria group." - }, - "criteria": { - "type": "array", - "items": { - "$ref": "PromotionCriteria.schema.json#PromotionCriteria" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PromotionCriteriaGroup.schema.json", + "title": "PromotionCriteriaGroup", + "definitions": { + "PromotionCriteriaGroup": { + "$id": "#PromotionCriteriaGroup", + "description": "The group of the criteria of the promotion. The logical relationship between different groups is decided by the relationTypeInGroup.", + "type": "object", + "properties": { + "groupName": { + "type": "string", + "description": "Name of the group." + }, + "id": { + "type": "string", + "description": "Unique Identifier" + }, + "relationTypeInGroup": { + "type": "string", + "description": "AND/OR,The logical relation type amongst the various criteria inside a promotion criteria group." + }, + "criteria": { + "type": "array", + "items": { + "$ref": "../Product/PromotionCriteria.schema.json#PromotionCriteria" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/PromotionPattern.schema.json b/Product/PromotionPattern.schema.json index eaf75155..06e9fb6e 100644 --- a/Product/PromotionPattern.schema.json +++ b/Product/PromotionPattern.schema.json @@ -1,55 +1,55 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PromotionPattern.schema.json", - "title": "PromotionPattern", - "definitions": { - "PromotionPattern": { - "$id": "#PromotionPattern", - "description": "Detailed pattern of the promotion.The pattern decides the conditions of promotion and the benefit of the promotion to be given to the eligible customer.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description" - }, - "id": { - "type": "string", - "description": "Unique identifier." - }, - "name": { - "type": "string", - "description": "Name" - }, - "priority": { - "type": "integer", - "description": "Priority. Smaller number means high." - }, - "relationTypeAmongGroup": { - "type": "string", - "description": "AND/OR ,The logical relation type amongst the promotion criteria group." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the promotion pattern is valid." - }, - "action": { - "type": "array", - "items": { - "$ref": "PromotionAction.schema.json#PromotionAction" - } - }, - "criteriaGroup": { - "type": "array", - "items": { - "$ref": "PromotionCriteriaGroup.schema.json#PromotionCriteriaGroup" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PromotionPattern.schema.json", + "title": "PromotionPattern", + "definitions": { + "PromotionPattern": { + "$id": "#PromotionPattern", + "description": "Detailed pattern of the promotion.The pattern decides the conditions of promotion and the benefit of the promotion to be given to the eligible customer.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description" + }, + "id": { + "type": "string", + "description": "Unique identifier." + }, + "name": { + "type": "string", + "description": "Name" + }, + "priority": { + "type": "integer", + "description": "Priority. Smaller number means high." + }, + "relationTypeAmongGroup": { + "type": "string", + "description": "AND/OR ,The logical relation type amongst the promotion criteria group." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the promotion pattern is valid." + }, + "action": { + "type": "array", + "items": { + "$ref": "../Product/PromotionAction.schema.json#PromotionAction" + } + }, + "criteriaGroup": { + "type": "array", + "items": { + "$ref": "../Product/PromotionCriteriaGroup.schema.json#PromotionCriteriaGroup" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/QualificationItemRelationship.schema.json b/Product/QualificationItemRelationship.schema.json index 176161b3..a8653998 100644 --- a/Product/QualificationItemRelationship.schema.json +++ b/Product/QualificationItemRelationship.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QualificationItemRelationship.schema.json", - "title": "QualificationItemRelationship", - "definitions": { - "QualificationItemRelationship": { - "$id": "#QualificationItemRelationship", - "description": "Structure used to describe relationship between productOfferingQualification item from the same ProductOfferingQualification.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Id of the ProductOfferingQualificationItem (from the same ProductOfferingQualificationItem)." - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship (ex: reliesOn, connectedTo, etc...)" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QualificationItemRelationship.schema.json", + "title": "QualificationItemRelationship", + "definitions": { + "QualificationItemRelationship": { + "$id": "#QualificationItemRelationship", + "description": "Structure used to describe relationship between productOfferingQualification item from the same ProductOfferingQualification.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Id of the ProductOfferingQualificationItem (from the same ProductOfferingQualificationItem)." + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship (ex: reliesOn, connectedTo, etc...)" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/QuoteItemStateType.schema.json b/Product/QuoteItemStateType.schema.json index 6384d362..0dd12b09 100644 --- a/Product/QuoteItemStateType.schema.json +++ b/Product/QuoteItemStateType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteItemStateType.schema.json", - "title": "QuoteItemStateType", - "definitions": { - "QuoteItemStateType": { - "$id": "#QuoteItemStateType", - "type": "string", - "description": "Possible values for the state of the quote item", - "enum": [ - "rejected", - "pending", - "inProgress", - "approved" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteItemStateType.schema.json", + "title": "QuoteItemStateType", + "definitions": { + "QuoteItemStateType": { + "$id": "#QuoteItemStateType", + "type": "string", + "description": "Possible values for the state of the quote item", + "enum": [ + "rejected", + "pending", + "inProgress", + "approved" + ] } -} \ No newline at end of file + } +} diff --git a/Product/QuoteStateType.schema.json b/Product/QuoteStateType.schema.json index 6ea3cb2f..56c54ddf 100644 --- a/Product/QuoteStateType.schema.json +++ b/Product/QuoteStateType.schema.json @@ -1,20 +1,20 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteStateType.schema.json", - "title": "QuoteStateType", - "definitions": { - "QuoteStateType": { - "$id": "#QuoteStateType", - "type": "string", - "description": "Possible values for the state of the quote", - "enum": [ - "rejected", - "pending", - "inProgress", - "cancelled", - "approved", - "accepted" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteStateType.schema.json", + "title": "QuoteStateType", + "definitions": { + "QuoteStateType": { + "$id": "#QuoteStateType", + "type": "string", + "description": "Possible values for the state of the quote", + "enum": [ + "rejected", + "pending", + "inProgress", + "cancelled", + "approved", + "accepted" + ] } -} \ No newline at end of file + } +} diff --git a/Product/QuoteTerm.schema.json b/Product/QuoteTerm.schema.json index 3d3928c4..af309184 100644 --- a/Product/QuoteTerm.schema.json +++ b/Product/QuoteTerm.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "QuoteTerm.schema.json", - "title": "QuoteTerm", - "definitions": { - "QuoteTerm": { - "$id": "#QuoteTerm", - "description": "Description of aproduct Term linked to this quoteItem. This represent a commitment with a duration", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the quoteTerm" - }, - "duration": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "Duration of the Term associated with this item" - }, - "name": { - "type": "string", - "description": "Name of the quoteTerm" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "QuoteTerm.schema.json", + "title": "QuoteTerm", + "definitions": { + "QuoteTerm": { + "$id": "#QuoteTerm", + "description": "Description of aproduct Term linked to this quoteItem. This represent a commitment with a duration", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the quoteTerm" + }, + "duration": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "Duration of the Term associated with this item" + }, + "name": { + "type": "string", + "description": "Name of the quoteTerm" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/Recommendation.schema.json b/Product/Recommendation.schema.json index 3f847206..a1325d2c 100644 --- a/Product/Recommendation.schema.json +++ b/Product/Recommendation.schema.json @@ -1,69 +1,69 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Recommendation.schema.json", - "title": "Recommendation", - "definitions": { - "Recommendation": { - "$id": "#Recommendation", - "description": "Recommendation API is used to recommend offering quickly based on the history and real-time context of customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omni-channel.", - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "href": { - "type": "string", - "description": "Hypertext Reference of the recommendation" - }, - "id": { - "type": "string", - "description": "Unique identifier of recommendation" - }, - "name": { - "type": "string", - "description": "Name of recommendation" - }, - "recommendationType": { - "type": "string", - "description": "The type of recommendation" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period in which the recommendation is valid" - }, - "order": { - "$ref": "../Customer/ProductOrderRef.schema.json#ProductOrderRef" - }, - "location": { - "$ref": "../Common/GeographicLocationRef.schema.json#GeographicLocationRef", - "description": "The geographic location which the recommendation is related to" - }, - "channel": { - "$ref": "../Common/ChannelRef.schema.json#ChannelRef" - }, - "category": { - "$ref": "CategoryRef.schema.json#CategoryRef", - "description": "The category for grouping recommendations" - }, - "shoppingCart": { - "$ref": "../Customer/ShoppingCartRef.schema.json#ShoppingCartRef", - "description": "The shopping cart which the recommendation is related to" - }, - "party": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "item": { - "type": "array", - "items": { - "$ref": "RecommendationItem.schema.json#RecommendationItem" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Recommendation.schema.json", + "title": "Recommendation", + "definitions": { + "Recommendation": { + "$id": "#Recommendation", + "description": "Recommendation API is used to recommend offering quickly based on the history and real-time context of customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omni-channel.", + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "href": { + "type": "string", + "description": "Hypertext Reference of the recommendation" + }, + "id": { + "type": "string", + "description": "Unique identifier of recommendation" + }, + "name": { + "type": "string", + "description": "Name of recommendation" + }, + "recommendationType": { + "type": "string", + "description": "The type of recommendation" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period in which the recommendation is valid" + }, + "order": { + "$ref": "../Customer/ProductOrderRef.schema.json#ProductOrderRef" + }, + "location": { + "$ref": "../Common/GeographicLocationRef.schema.json#GeographicLocationRef", + "description": "The geographic location which the recommendation is related to" + }, + "channel": { + "$ref": "../Common/ChannelRef.schema.json#ChannelRef" + }, + "category": { + "$ref": "../Product/CategoryRef.schema.json#CategoryRef", + "description": "The category for grouping recommendations" + }, + "shoppingCart": { + "$ref": "../Customer/ShoppingCartRef.schema.json#ShoppingCartRef", + "description": "The shopping cart which the recommendation is related to" + }, + "party": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "item": { + "type": "array", + "items": { + "$ref": "../Product/RecommendationItem.schema.json#RecommendationItem" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/RecommendationItem.schema.json b/Product/RecommendationItem.schema.json index 467837b5..fec632a0 100644 --- a/Product/RecommendationItem.schema.json +++ b/Product/RecommendationItem.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RecommendationItem.schema.json", - "title": "RecommendationItem", - "definitions": { - "RecommendationItem": { - "$id": "#RecommendationItem", - "description": "A list of recommendation items. Every item is a product offering and its rank.", - "type": "object", - "properties": { - "priority": { - "type": "integer", - "description": "The rank of the list of recommended offering." - }, - "offering": { - "$ref": "ProductOfferingRef.schema.json#ProductOfferingRef", - "description": "Recommended product offering" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RecommendationItem.schema.json", + "title": "RecommendationItem", + "definitions": { + "RecommendationItem": { + "$id": "#RecommendationItem", + "description": "A list of recommendation items. Every item is a product offering and its rank.", + "type": "object", + "properties": { + "priority": { + "type": "integer", + "description": "The rank of the list of recommended offering." + }, + "offering": { + "$ref": "../Product/ProductOfferingRef.schema.json#ProductOfferingRef", + "description": "Recommended product offering" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/RelatedProductOrderItem.schema.json b/Product/RelatedProductOrderItem.schema.json index b199678b..216c35f5 100644 --- a/Product/RelatedProductOrderItem.schema.json +++ b/Product/RelatedProductOrderItem.schema.json @@ -1,47 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RelatedProductOrderItem.schema.json", - "title": "RelatedProductOrderItem", - "definitions": { - "RelatedProductOrderItem": { - "$id": "#RelatedProductOrderItem", - "type": "object", - "description": "RelatedProductOrderItem (ProductOrder item) .The product order item which triggered product creation/change/termination.", - "required": [ - "orderItemId", - "productOrderId" - ], - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "productOrderHref": { - "type": "string", - "description": "Reference of the related entity." - }, - "productOrderId": { - "type": "string", - "description": "Unique identifier of a related entity." - }, - "orderItemAction": { - "type": "string", - "description": "Action of the order item for this product" - }, - "orderItemId": { - "type": "string", - "description": "Identifier of the order item where the product was managed" - }, - "role": { - "type": "string", - "description": "role of the product order item for this product" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RelatedProductOrderItem.schema.json", + "title": "RelatedProductOrderItem", + "definitions": { + "RelatedProductOrderItem": { + "$id": "#RelatedProductOrderItem", + "type": "object", + "description": "RelatedProductOrderItem (ProductOrder item) .The product order item which triggered product creation/change/termination.", + "required": [ + "orderItemId", + "productOrderId" + ], + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "productOrderHref": { + "type": "string", + "description": "Reference of the related entity." + }, + "productOrderId": { + "type": "string", + "description": "Unique identifier of a related entity." + }, + "orderItemAction": { + "type": "string", + "description": "Action of the order item for this product" + }, + "orderItemId": { + "type": "string", + "description": "Identifier of the order item where the product was managed" + }, + "role": { + "type": "string", + "description": "role of the product order item for this product" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/TargetProductSchema.schema.json b/Product/TargetProductSchema.schema.json index f0ef54fa..b56d0e6a 100644 --- a/Product/TargetProductSchema.schema.json +++ b/Product/TargetProductSchema.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TargetProductSchema.schema.json", - "title": "TargetProductSchema", - "definitions": { - "TargetProductSchema": { - "$id": "#TargetProductSchema", - "type": "object", - "description": "The reference object to the schema and type of target product which is described by product specification", - "properties": { - "@type": { - "type": "string", - "description": "Class type of the target product" - }, - "@schemaLocation": { - "type": "string", - "format": "uri", - "description": "This field provides a link to the schema describing the target product" - } - }, - "required": [ - "@type", - "@schemaLocation" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TargetProductSchema.schema.json", + "title": "TargetProductSchema", + "definitions": { + "TargetProductSchema": { + "$id": "#TargetProductSchema", + "type": "object", + "description": "The reference object to the schema and type of target product which is described by product specification", + "properties": { + "@type": { + "type": "string", + "description": "Class type of the target product" + }, + "@schemaLocation": { + "type": "string", + "format": "uri", + "description": "This field provides a link to the schema describing the target product" } + }, + "required": [ + "@type", + "@schemaLocation" + ] } -} \ No newline at end of file + } +} diff --git a/Product/Usage.schema.json b/Product/Usage.schema.json index bc1f9a01..cca7bbcd 100644 --- a/Product/Usage.schema.json +++ b/Product/Usage.schema.json @@ -1,65 +1,65 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Usage.schema.json", - "title": "Usage", - "definitions": { - "Usage": { - "$id": "#Usage", - "description": "An occurrence of employing a Product, Service, or Resource for its intended purpose, which is of interest to the business and can have charges applied to it. It is comprised of characteristics, which represent attributes of usage.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date-time", - "description": "Date of usage" - }, - "description": { - "type": "string", - "description": "Description of usage" - }, - "href": { - "type": "string", - "description": "Reference of usage" - }, - "id": { - "type": "string", - "description": "Usage unique identifier" - }, - "status": { - "type": "string", - "description": "Status of usage" - }, - "usageType": { - "type": "string", - "description": "Type of usage" - }, - "usageSpecification": { - "$ref": "UsageSpecificationRef.schema.json#UsageSpecificationRef" - }, - "usageCharacteristic": { - "type": "array", - "items": { - "$ref": "UsageCharacteristic.schema.json#UsageCharacteristic" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "ratedProductUsage": { - "type": "array", - "items": { - "$ref": "../Common/RatedProductUsage.schema.json#RatedProductUsage" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Usage.schema.json", + "title": "Usage", + "definitions": { + "Usage": { + "$id": "#Usage", + "description": "An occurrence of employing a Product, Service, or Resource for its intended purpose, which is of interest to the business and can have charges applied to it. It is comprised of characteristics, which represent attributes of usage.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "Date of usage" + }, + "description": { + "type": "string", + "description": "Description of usage" + }, + "href": { + "type": "string", + "description": "Reference of usage" + }, + "id": { + "type": "string", + "description": "Usage unique identifier" + }, + "status": { + "type": "string", + "description": "Status of usage" + }, + "usageType": { + "type": "string", + "description": "Type of usage" + }, + "usageSpecification": { + "$ref": "../Product/UsageSpecificationRef.schema.json#UsageSpecificationRef" + }, + "usageCharacteristic": { + "type": "array", + "items": { + "$ref": "../Product/UsageCharacteristic.schema.json#UsageCharacteristic" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "ratedProductUsage": { + "type": "array", + "items": { + "$ref": "../Common/RatedProductUsage.schema.json#RatedProductUsage" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/UsageCharacteristic.schema.json b/Product/UsageCharacteristic.schema.json index 19f3d891..f7186e4b 100644 --- a/Product/UsageCharacteristic.schema.json +++ b/Product/UsageCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageCharacteristic.schema.json", - "title": "UsageCharacteristic", - "definitions": { - "UsageCharacteristic": { - "$id": "#UsageCharacteristic", - "description": "Provides the value of a given characteristic", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the usage characteristic" - }, - "value": { - "type": "string", - "description": "A discrete value that the characteristic can take on" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageCharacteristic.schema.json", + "title": "UsageCharacteristic", + "definitions": { + "UsageCharacteristic": { + "$id": "#UsageCharacteristic", + "description": "Provides the value of a given characteristic", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the usage characteristic" + }, + "value": { + "type": "string", + "description": "A discrete value that the characteristic can take on" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/UsageConsumptionReport.schema.json b/Product/UsageConsumptionReport.schema.json index 155d3182..44b92fd1 100644 --- a/Product/UsageConsumptionReport.schema.json +++ b/Product/UsageConsumptionReport.schema.json @@ -1,50 +1,50 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageConsumptionReport.schema.json", - "title": "UsageConsumptionReport", - "definitions": { - "UsageConsumptionReport": { - "$id": "#UsageConsumptionReport", - "type": "object", - "description": "An usage consumption report enables to know at a given point the balances and the consumption counters related to various buckets (SMS, Voice, Data for example). It could be calculated for a device identified by a public key (msisdn number for a mobile device for example or PSTN or VOIP number for a fix device), for a subscribed offer or option or for an user.", - "properties": { - "bucket": { - "type": "array", - "description": "Bucket(s) included in the offer or option subscribed.", - "items": { - "$ref": "UsageVolumeProduct.schema.json#UsageVolumeProduct" - } - }, - "description": { - "type": "string", - "description": "Free short text describing the usage consumption report content" - }, - "effectiveDate": { - "type": "string", - "format": "date-time", - "description": "Date and time when the usage consumption report was calculated and generated" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the usage consumption report. The report is calculated at the time of the request by the server. Generally, this report is not recorded by the server. If it is, an unique identifier of the usage consumption report is given by the server" - }, - "id": { - "type": "string", - "description": "The report is calculated at the time of the request by the server. Generally, this report is not recorded by the server. If it is, an unique identifier of the usage consumption report is given by the server" - }, - "name": { - "type": "string", - "description": "Usage consumption report name" - }, - "relatedParty": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageConsumptionReport.schema.json", + "title": "UsageConsumptionReport", + "definitions": { + "UsageConsumptionReport": { + "$id": "#UsageConsumptionReport", + "type": "object", + "description": "An usage consumption report enables to know at a given point the balances and the consumption counters related to various buckets (SMS, Voice, Data for example). It could be calculated for a device identified by a public key (msisdn number for a mobile device for example or PSTN or VOIP number for a fix device), for a subscribed offer or option or for an user.", + "properties": { + "bucket": { + "type": "array", + "description": "Bucket(s) included in the offer or option subscribed.", + "items": { + "$ref": "../Product/UsageVolumeProduct.schema.json#UsageVolumeProduct" + } + }, + "description": { + "type": "string", + "description": "Free short text describing the usage consumption report content" + }, + "effectiveDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the usage consumption report was calculated and generated" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the usage consumption report. The report is calculated at the time of the request by the server. Generally, this report is not recorded by the server. If it is, an unique identifier of the usage consumption report is given by the server" + }, + "id": { + "type": "string", + "description": "The report is calculated at the time of the request by the server. Generally, this report is not recorded by the server. If it is, an unique identifier of the usage consumption report is given by the server" + }, + "name": { + "type": "string", + "description": "Usage consumption report name" + }, + "relatedParty": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/UsageConsumptionReportRef.schema.json b/Product/UsageConsumptionReportRef.schema.json index 5fda0c01..357eaa27 100644 --- a/Product/UsageConsumptionReportRef.schema.json +++ b/Product/UsageConsumptionReportRef.schema.json @@ -1,40 +1,40 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageConsumptionReportRef.schema.json", - "title": "UsageConsumptionReportRef", - "definitions": { - "UsageConsumptionReportRef": { - "$id": "#UsageConsumptionReportRef", - "type": "object", - "description": "Reference of an usage consumption report", - "properties": { - "description": { - "type": "string", - "description": "Free short text describing the usage consumption report content" - }, - "effectiveDate": { - "type": "string", - "format": "date-time", - "description": "Date and time when the usage consumption report was calculated and generated" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the usage consumption report" - }, - "id": { - "type": "string", - "description": "Unique identifier of the usage consumption report given by the server" - }, - "name": { - "type": "string", - "description": "Usage consumption report name" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageConsumptionReportRef.schema.json", + "title": "UsageConsumptionReportRef", + "definitions": { + "UsageConsumptionReportRef": { + "$id": "#UsageConsumptionReportRef", + "type": "object", + "description": "Reference of an usage consumption report", + "properties": { + "description": { + "type": "string", + "description": "Free short text describing the usage consumption report content" + }, + "effectiveDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the usage consumption report was calculated and generated" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the usage consumption report" + }, + "id": { + "type": "string", + "description": "Unique identifier of the usage consumption report given by the server" + }, + "name": { + "type": "string", + "description": "Usage consumption report name" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/UsageConsumptionReportRequest.schema.json b/Product/UsageConsumptionReportRequest.schema.json index 5c906e37..838ac85c 100644 --- a/Product/UsageConsumptionReportRequest.schema.json +++ b/Product/UsageConsumptionReportRequest.schema.json @@ -1,62 +1,62 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageConsumptionReportRequest.schema.json", - "title": "UsageConsumptionReportRequest", - "definitions": { - "UsageConsumptionReportRequest": { - "$id": "#UsageConsumptionReportRequest", - "type": "object", - "description": "An UsageConsumptionReportRequest allows to manage the calculation request of an usage consumption report", - "properties": { - "bucket": { - "type": "array", - "description": "Reference of the buckets for which the usage consumption report is requested", - "items": { - "$ref": "UsageVolumeProductRef.schema.json#UsageVolumeProductRef" - } - }, - "creationDate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the request creation" - }, - "href": { - "type": "string", - "description": "Reference of the usage consumption report request" - }, - "id": { - "type": "string", - "description": "Unique identifier of the usage consumption report request given by the server" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date when the status was last changed" - }, - "product": { - "$ref": "NetworkProductRef.schema.json#NetworkProductRef", - "description": "Network product reference for which the usage consumption report is requested" - }, - "relatedParty": { - "type": "array", - "description": "Reference and role of the related parties for which the usage consumption report is requested", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "status": { - "type": "string", - "description": "Status of the usage consumption report request (InProgress or done)" - }, - "usageConsumptionReport": { - "$ref": "UsageConsumptionReportRef.schema.json#UsageConsumptionReportRef", - "description": "References of the usage consumption report (given when it has been calculated and the status of the request is done)" - }, - "validPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Validity period" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageConsumptionReportRequest.schema.json", + "title": "UsageConsumptionReportRequest", + "definitions": { + "UsageConsumptionReportRequest": { + "$id": "#UsageConsumptionReportRequest", + "type": "object", + "description": "An UsageConsumptionReportRequest allows to manage the calculation request of an usage consumption report", + "properties": { + "bucket": { + "type": "array", + "description": "Reference of the buckets for which the usage consumption report is requested", + "items": { + "$ref": "../Product/UsageVolumeProductRef.schema.json#UsageVolumeProductRef" + } + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the request creation" + }, + "href": { + "type": "string", + "description": "Reference of the usage consumption report request" + }, + "id": { + "type": "string", + "description": "Unique identifier of the usage consumption report request given by the server" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date when the status was last changed" + }, + "product": { + "$ref": "../Product/NetworkProductRef.schema.json#NetworkProductRef", + "description": "Network product reference for which the usage consumption report is requested" + }, + "relatedParty": { + "type": "array", + "description": "Reference and role of the related parties for which the usage consumption report is requested", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "status": { + "type": "string", + "description": "Status of the usage consumption report request (InProgress or done)" + }, + "usageConsumptionReport": { + "$ref": "../Product/UsageConsumptionReportRef.schema.json#UsageConsumptionReportRef", + "description": "References of the usage consumption report (given when it has been calculated and the status of the request is done)" + }, + "validPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Validity period" } + } } -} \ No newline at end of file + } +} diff --git a/Product/UsageConsumptionReportRequestIn.schema.json b/Product/UsageConsumptionReportRequestIn.schema.json index 5e2ce699..adb42726 100644 --- a/Product/UsageConsumptionReportRequestIn.schema.json +++ b/Product/UsageConsumptionReportRequestIn.schema.json @@ -1,41 +1,41 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageConsumptionReportRequestIn.schema.json", - "title": "UsageConsumptionReportRequestIn", - "definitions": { - "UsageConsumptionReportRequestIn": { - "$id": "#UsageConsumptionReportRequestIn", - "type": "object", - "description": "An UsageConsumptionReportRequest allows to manage the calculation request of an usage consumption report", - "properties": { - "bucket": { - "type": "array", - "description": "Reference of the buckets for which the usage consumption report is requested", - "items": { - "$ref": "UsageVolumeProductRef.schema.json#UsageVolumeProductRef" - } - }, - "product": { - "$ref": "NetworkProductRef.schema.json#NetworkProductRef", - "description": "Network product reference for which the usage consumption report is requested" - }, - "relatedParty": { - "type": "array", - "description": "Reference and role of the related parties for which the usage consumption report is requested", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "validPeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Validity period" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageConsumptionReportRequestIn.schema.json", + "title": "UsageConsumptionReportRequestIn", + "definitions": { + "UsageConsumptionReportRequestIn": { + "$id": "#UsageConsumptionReportRequestIn", + "type": "object", + "description": "An UsageConsumptionReportRequest allows to manage the calculation request of an usage consumption report", + "properties": { + "bucket": { + "type": "array", + "description": "Reference of the buckets for which the usage consumption report is requested", + "items": { + "$ref": "../Product/UsageVolumeProductRef.schema.json#UsageVolumeProductRef" + } + }, + "product": { + "$ref": "../Product/NetworkProductRef.schema.json#NetworkProductRef", + "description": "Network product reference for which the usage consumption report is requested" + }, + "relatedParty": { + "type": "array", + "description": "Reference and role of the related parties for which the usage consumption report is requested", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "validPeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Validity period" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/UsageSpecCharacteristic.schema.json b/Product/UsageSpecCharacteristic.schema.json index a4af030e..d707ef18 100644 --- a/Product/UsageSpecCharacteristic.schema.json +++ b/Product/UsageSpecCharacteristic.schema.json @@ -1,37 +1,37 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageSpecCharacteristic.schema.json", - "title": "UsageSpecCharacteristic", - "definitions": { - "UsageSpecCharacteristic": { - "$id": "#UsageSpecCharacteristic", - "description": "A detailed description of an attribute that defines a particular type of usage, described by its name, category, type, presence and a set of allowed values", - "type": "object", - "properties": { - "configurable": { - "type": "boolean", - "description": "Boolean indicating if usageSpecCharacteristic is configurable or not" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the usage specification characteristic is" - }, - "name": { - "type": "string", - "description": "The name of the usage specification characteristic" - }, - "usageSpecCharacteristicValue": { - "type": "array", - "items": { - "$ref": "UsageSpecCharacteristicValue.schema.json#UsageSpecCharacteristicValue" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageSpecCharacteristic.schema.json", + "title": "UsageSpecCharacteristic", + "definitions": { + "UsageSpecCharacteristic": { + "$id": "#UsageSpecCharacteristic", + "description": "A detailed description of an attribute that defines a particular type of usage, described by its name, category, type, presence and a set of allowed values", + "type": "object", + "properties": { + "configurable": { + "type": "boolean", + "description": "Boolean indicating if usageSpecCharacteristic is configurable or not" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the usage specification characteristic is" + }, + "name": { + "type": "string", + "description": "The name of the usage specification characteristic" + }, + "usageSpecCharacteristicValue": { + "type": "array", + "items": { + "$ref": "../Product/UsageSpecCharacteristicValue.schema.json#UsageSpecCharacteristicValue" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/UsageSpecCharacteristicValue.schema.json b/Product/UsageSpecCharacteristicValue.schema.json index 39638bff..9e2cfc08 100644 --- a/Product/UsageSpecCharacteristicValue.schema.json +++ b/Product/UsageSpecCharacteristicValue.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageSpecCharacteristicValue.schema.json", - "title": "UsageSpecCharacteristicValue", - "definitions": { - "UsageSpecCharacteristicValue": { - "$id": "#UsageSpecCharacteristicValue", - "description": "A value that can be assigned to a UsageSpecCharacteristic.", - "type": "object", - "properties": { - "default": { - "type": "boolean", - "description": "If true, this is the default value for a characteristic" - }, - "value": { - "type": "string", - "description": "A narrative that explains in detail what the usage specification characteristic is" - }, - "valueFrom": { - "type": "string", - "description": "The low range value that a characteristic can take on" - }, - "valueTo": { - "type": "string", - "description": "The upper range value that a characteristic can take on" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageSpecCharacteristicValue.schema.json", + "title": "UsageSpecCharacteristicValue", + "definitions": { + "UsageSpecCharacteristicValue": { + "$id": "#UsageSpecCharacteristicValue", + "description": "A value that can be assigned to a UsageSpecCharacteristic.", + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "If true, this is the default value for a characteristic" + }, + "value": { + "type": "string", + "description": "A narrative that explains in detail what the usage specification characteristic is" + }, + "valueFrom": { + "type": "string", + "description": "The low range value that a characteristic can take on" + }, + "valueTo": { + "type": "string", + "description": "The upper range value that a characteristic can take on" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/UsageSpecification.schema.json b/Product/UsageSpecification.schema.json index a05c59db..fd9598b9 100644 --- a/Product/UsageSpecification.schema.json +++ b/Product/UsageSpecification.schema.json @@ -1,45 +1,45 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageSpecification.schema.json", - "title": "UsageSpecification", - "definitions": { - "UsageSpecification": { - "$id": "#UsageSpecification", - "description": "A detailed description of a usage event that are of interest to the business and can have charges applied to it. It is comprised of characteristics, which define all attributes known for a particular type of usage.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail what the usage specification is" - }, - "href": { - "type": "string", - "description": "Reference of usage specification" - }, - "id": { - "type": "string", - "description": "Usage specification unique identifier" - }, - "name": { - "type": "string", - "description": "The name of the usage specification." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the usage specification is valid" - }, - "usageSpecCharacteristic": { - "type": "array", - "items": { - "$ref": "UsageSpecCharacteristic.schema.json#UsageSpecCharacteristic" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageSpecification.schema.json", + "title": "UsageSpecification", + "definitions": { + "UsageSpecification": { + "$id": "#UsageSpecification", + "description": "A detailed description of a usage event that are of interest to the business and can have charges applied to it. It is comprised of characteristics, which define all attributes known for a particular type of usage.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail what the usage specification is" + }, + "href": { + "type": "string", + "description": "Reference of usage specification" + }, + "id": { + "type": "string", + "description": "Usage specification unique identifier" + }, + "name": { + "type": "string", + "description": "The name of the usage specification." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the usage specification is valid" + }, + "usageSpecCharacteristic": { + "type": "array", + "items": { + "$ref": "../Product/UsageSpecCharacteristic.schema.json#UsageSpecCharacteristic" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/UsageSpecificationRef.schema.json b/Product/UsageSpecificationRef.schema.json index 10191bb4..cce86026 100644 --- a/Product/UsageSpecificationRef.schema.json +++ b/Product/UsageSpecificationRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageSpecificationRef.schema.json", - "title": "UsageSpecificationRef", - "definitions": { - "UsageSpecificationRef": { - "$id": "#UsageSpecificationRef", - "description": "UsageSpecification reference. UsageSpecification is a detailed description of a usage event that are of interest to the business and can have charges applied to it. It is comprised of characteristics, which define all attributes known for a particular type of usage.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of usage specification" - }, - "id": { - "type": "string", - "description": "Usage specification unique identifier" - }, - "name": { - "type": "string", - "description": "The name of the usage specification" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageSpecificationRef.schema.json", + "title": "UsageSpecificationRef", + "definitions": { + "UsageSpecificationRef": { + "$id": "#UsageSpecificationRef", + "description": "UsageSpecification reference. UsageSpecification is a detailed description of a usage event that are of interest to the business and can have charges applied to it. It is comprised of characteristics, which define all attributes known for a particular type of usage.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of usage specification" + }, + "id": { + "type": "string", + "description": "Usage specification unique identifier" + }, + "name": { + "type": "string", + "description": "The name of the usage specification" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/UsageVolumeBalance.schema.json b/Product/UsageVolumeBalance.schema.json index 0315b98b..e820e7ed 100644 --- a/Product/UsageVolumeBalance.schema.json +++ b/Product/UsageVolumeBalance.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageVolumeBalance.schema.json", - "title": "UsageVolumeBalance", - "definitions": { - "UsageVolumeBalance": { - "$id": "#UsageVolumeBalance", - "type": "object", - "description": "The balance (called UsageVolumeBalance in the SID model) defines the remaining allowed product usage quantity in terms of volume, time, currency or events. It corresponds to the initial allowed usage quantity minus the usage consumed on the bucket.", - "properties": { - "remainingValue": { - "$ref": "../Common/Quantity.schema.json#Quantity", - "description": "Numeric remaining value for the bucket given in the unit (for example 1.9). This numeric value could be used for calculation for example" - }, - "remainingValueName": { - "type": "string", - "description": "Remaining value in a formatted string for the bucket given in the balance unit (for example 1.9 Gb). This formatted string could be used for display needs for example" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "Balance period between a start date time and an end date time. For prepaid bucket, the period of the balance is between the effective date of the usage consumption report generation and the end date of the bucket. For postpaid bucket, the period of the balance is between the effective date of the usage consumption report generation and the next bill date." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageVolumeBalance.schema.json", + "title": "UsageVolumeBalance", + "definitions": { + "UsageVolumeBalance": { + "$id": "#UsageVolumeBalance", + "type": "object", + "description": "The balance (called UsageVolumeBalance in the SID model) defines the remaining allowed product usage quantity in terms of volume, time, currency or events. It corresponds to the initial allowed usage quantity minus the usage consumed on the bucket.", + "properties": { + "remainingValue": { + "$ref": "../Common/Quantity.schema.json#Quantity", + "description": "Numeric remaining value for the bucket given in the unit (for example 1.9). This numeric value could be used for calculation for example" + }, + "remainingValueName": { + "type": "string", + "description": "Remaining value in a formatted string for the bucket given in the balance unit (for example 1.9 Gb). This formatted string could be used for display needs for example" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "Balance period between a start date time and an end date time. For prepaid bucket, the period of the balance is between the effective date of the usage consumption report generation and the end date of the bucket. For postpaid bucket, the period of the balance is between the effective date of the usage consumption report generation and the next bill date." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/UsageVolumeProduct.schema.json b/Product/UsageVolumeProduct.schema.json index e9f2cb52..2c91763e 100644 --- a/Product/UsageVolumeProduct.schema.json +++ b/Product/UsageVolumeProduct.schema.json @@ -1,53 +1,53 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageVolumeProduct.schema.json", - "title": "UsageVolumeProduct", - "definitions": { - "UsageVolumeProduct": { - "$id": "#UsageVolumeProduct", - "type": "object", - "description": "A bucket (called UsageVolumeProduct in the SID model) represents a quantity of usage, as 2 hours national calls or 50 sms for example. It could be either a quantity or an amount in a currency (i.e. It could represent a fixed number of SMS, MMS, minutes of calls, quantity of data, number of events as well as a specific amount in a given currency). It requires one or more network products from which usages will debit the bucket.", - "properties": { - "bucketBalance": { - "type": "array", - "items": { - "$ref": "UsageVolumeBalance.schema.json#UsageVolumeBalance" - } - }, - "bucketCounter": { - "type": "array", - "items": { - "$ref": "ConsumptionSummary.schema.json#ConsumptionSummary" - } - }, - "id": { - "type": "string", - "description": "Unique identifier of the bucket" - }, - "isShared": { - "type": "boolean", - "description": "True if the bucket is shared between several devices or users" - }, - "name": { - "type": "string", - "description": "Bucket name" - }, - "product": { - "type": "array", - "items": { - "$ref": "NetworkProduct.schema.json#NetworkProduct" - } - }, - "usageType": { - "type": "string", - "description": "Type of usage concerned by the bucket, such as voice, sms, data" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageVolumeProduct.schema.json", + "title": "UsageVolumeProduct", + "definitions": { + "UsageVolumeProduct": { + "$id": "#UsageVolumeProduct", + "type": "object", + "description": "A bucket (called UsageVolumeProduct in the SID model) represents a quantity of usage, as 2 hours national calls or 50 sms for example. It could be either a quantity or an amount in a currency (i.e. It could represent a fixed number of SMS, MMS, minutes of calls, quantity of data, number of events as well as a specific amount in a given currency). It requires one or more network products from which usages will debit the bucket.", + "properties": { + "bucketBalance": { + "type": "array", + "items": { + "$ref": "../Product/UsageVolumeBalance.schema.json#UsageVolumeBalance" + } + }, + "bucketCounter": { + "type": "array", + "items": { + "$ref": "../Product/ConsumptionSummary.schema.json#ConsumptionSummary" + } + }, + "id": { + "type": "string", + "description": "Unique identifier of the bucket" + }, + "isShared": { + "type": "boolean", + "description": "True if the bucket is shared between several devices or users" + }, + "name": { + "type": "string", + "description": "Bucket name" + }, + "product": { + "type": "array", + "items": { + "$ref": "../Product/NetworkProduct.schema.json#NetworkProduct" + } + }, + "usageType": { + "type": "string", + "description": "Type of usage concerned by the bucket, such as voice, sms, data" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Product/UsageVolumeProductRef.schema.json b/Product/UsageVolumeProductRef.schema.json index ff737a88..97e3340c 100644 --- a/Product/UsageVolumeProductRef.schema.json +++ b/Product/UsageVolumeProductRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "UsageVolumeProductRef.schema.json", - "title": "UsageVolumeProductRef", - "definitions": { - "UsageVolumeProductRef": { - "$id": "#UsageVolumeProductRef", - "type": "object", - "description": "Reference of a bucket", - "properties": { - "@referredType": { - "type": "string", - "description": "Generic attribute indicating the name of the class type of the referred resource entity" - }, - "id": { - "type": "string", - "description": "Unique identifier of the bucket" - }, - "name": { - "type": "string", - "description": "Bucket name" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "UsageVolumeProductRef.schema.json", + "title": "UsageVolumeProductRef", + "definitions": { + "UsageVolumeProductRef": { + "$id": "#UsageVolumeProductRef", + "type": "object", + "description": "Reference of a bucket", + "properties": { + "@referredType": { + "type": "string", + "description": "Generic attribute indicating the name of the class type of the referred resource entity" + }, + "id": { + "type": "string", + "description": "Unique identifier of the bucket" + }, + "name": { + "type": "string", + "description": "Bucket name" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Resource/LogicalResource.schema.json b/Resource/LogicalResource.schema.json index 6a783d2d..ba5d0a16 100644 --- a/Resource/LogicalResource.schema.json +++ b/Resource/LogicalResource.schema.json @@ -1,94 +1,94 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "LogicalResource.schema.json", - "title": "LogicalResource", - "definitions": { - "LogicalResource": { - "$id": "#LogicalResource", - "description": "Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses) in the inventory.", - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "The value of the logical resource, such as: 0044746712345 for an MSISDN" - }, - "category": { - "type": "string", - "description": "Category of the concrete resource, such as: Gold, Silver for MSISDN concrete resource" - }, - "description": { - "type": "string", - "description": "Free-text description of the resource" - }, - "endDate": { - "type": "string", - "format": "date-time", - "description": "The date till the resource is effective" - }, - "href": { - "type": "string", - "description": "The URI for the object itself." - }, - "id": { - "type": "string", - "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type" - }, - "lifecycleState": { - "type": "string", - "description": "The life cycle state of the resource" - }, - "name": { - "type": "string", - "description": "A string used to give a name to the resource" - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "A date time( DateTime). The date from which the resource is effective" - }, - "version": { - "type": "string", - "description": "A field that identifies the specific version of an instance of a resource" - }, - "resourceRelationship": { - "type": "array", - "items": { - "$ref": "ResourceRelationship.schema.json#ResourceRelationship" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "ResourceCharacteristic.schema.json#ResourceCharacteristic" - } - }, - "place": { - "$ref": "../Common/Place.schema.json#Place" - }, - "partyRole": { - "type": "array", - "items": { - "$ref": "../EngagedParty/PartyRoleRef.schema.json#PartyRoleRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "LogicalResource.schema.json", + "title": "LogicalResource", + "definitions": { + "LogicalResource": { + "$id": "#LogicalResource", + "description": "Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses) in the inventory.", + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The value of the logical resource, such as: 0044746712345 for an MSISDN" + }, + "category": { + "type": "string", + "description": "Category of the concrete resource, such as: Gold, Silver for MSISDN concrete resource" + }, + "description": { + "type": "string", + "description": "Free-text description of the resource" + }, + "endDate": { + "type": "string", + "format": "date-time", + "description": "The date till the resource is effective" + }, + "href": { + "type": "string", + "description": "The URI for the object itself." + }, + "id": { + "type": "string", + "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type" + }, + "lifecycleState": { + "type": "string", + "description": "The life cycle state of the resource" + }, + "name": { + "type": "string", + "description": "A string used to give a name to the resource" + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "A date time( DateTime). The date from which the resource is effective" + }, + "version": { + "type": "string", + "description": "A field that identifies the specific version of an instance of a resource" + }, + "resourceRelationship": { + "type": "array", + "items": { + "$ref": "../Resource/ResourceRelationship.schema.json#ResourceRelationship" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "../Resource/ResourceCharacteristic.schema.json#ResourceCharacteristic" + } + }, + "place": { + "$ref": "../Common/Place.schema.json#Place" + }, + "partyRole": { + "type": "array", + "items": { + "$ref": "../EngagedParty/PartyRoleRef.schema.json#PartyRoleRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Resource/PhysicalResource.schema.json b/Resource/PhysicalResource.schema.json index 8eea0b18..4c353998 100644 --- a/Resource/PhysicalResource.schema.json +++ b/Resource/PhysicalResource.schema.json @@ -1,107 +1,107 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "PhysicalResource.schema.json", - "title": "PhysicalResource", - "definitions": { - "PhysicalResource": { - "$id": "#PhysicalResource", - "description": "Physical resource is a type of resource that describes the common set of attributes shared by all concrete physical resources (e.g. EQUIPMENT) in the inventory.", - "type": "object", - "properties": { - "manufactureDate": { - "type": "string", - "format": "date-time", - "description": "This is a string attribute that defines the date of manufacture of this item in the fixed format \"dd/mm/yyyy\". This is an optional attribute." - }, - "powerState": { - "type": "string", - "description": "This defines the current power status of the hardware item. Values include:\n\n 0: Unknown\n 1: Not Applicable\n 2: No Power Applied\n 3: Full Power Applied\n 4: Power Save - Normal\n 5: Power Save - Degraded\n 6: Power Save - Standby\n 7: Power Save - Critical\n 8: Power Save - Low Power Mode\n 9: Power Save - Unknown\n 10: Power Cycle\n 11: Power Warning\n 12: Power Off" - }, - "serialNumber": { - "type": "string", - "description": "This is a string that represents a manufacturer-allocated number used to identify different instances of the same hardware item. The ModelNumber and PartNumber attributes are used to identify different types of hardware items. This is a REQUIRED attribute." - }, - "versionNumber": { - "type": "string", - "description": "This is a string that identifies the version of this object. This is an optional attribute." - }, - "category": { - "type": "string", - "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" - }, - "description": { - "type": "string", - "description": "free-text description of the resource" - }, - "endDate": { - "type": "string", - "format": "date-time", - "description": "A date time( DateTime). The date till the resource is effective" - }, - "href": { - "type": "string", - "description": "The URI for the object itself." - }, - "id": { - "type": "string", - "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." - }, - "lifecycleState": { - "type": "string", - "description": "The life cycle state of the resource." - }, - "name": { - "type": "string", - "description": "A string used to give a name to the resource" - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "A date time( DateTime). The date from which the resource is effective" - }, - "version": { - "type": "string", - "description": "A field that identifies the specific version of an instance of a resource." - }, - "resourceRelationship": { - "type": "array", - "items": { - "$ref": "ResourceRelationship.schema.json#ResourceRelationship" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "ResourceCharacteristic.schema.json#ResourceCharacteristic" - } - }, - "place": { - "$ref": "../Common/Place.schema.json#Place" - }, - "partyRole": { - "type": "array", - "items": { - "$ref": "../EngagedParty/PartyRoleRef.schema.json#PartyRoleRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "PhysicalResource.schema.json", + "title": "PhysicalResource", + "definitions": { + "PhysicalResource": { + "$id": "#PhysicalResource", + "description": "Physical resource is a type of resource that describes the common set of attributes shared by all concrete physical resources (e.g. EQUIPMENT) in the inventory.", + "type": "object", + "properties": { + "manufactureDate": { + "type": "string", + "format": "date-time", + "description": "This is a string attribute that defines the date of manufacture of this item in the fixed format \"dd/mm/yyyy\". This is an optional attribute." + }, + "powerState": { + "type": "string", + "description": "This defines the current power status of the hardware item. Values include:\n\n 0: Unknown\n 1: Not Applicable\n 2: No Power Applied\n 3: Full Power Applied\n 4: Power Save - Normal\n 5: Power Save - Degraded\n 6: Power Save - Standby\n 7: Power Save - Critical\n 8: Power Save - Low Power Mode\n 9: Power Save - Unknown\n 10: Power Cycle\n 11: Power Warning\n 12: Power Off" + }, + "serialNumber": { + "type": "string", + "description": "This is a string that represents a manufacturer-allocated number used to identify different instances of the same hardware item. The ModelNumber and PartNumber attributes are used to identify different types of hardware items. This is a REQUIRED attribute." + }, + "versionNumber": { + "type": "string", + "description": "This is a string that identifies the version of this object. This is an optional attribute." + }, + "category": { + "type": "string", + "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" + }, + "description": { + "type": "string", + "description": "free-text description of the resource" + }, + "endDate": { + "type": "string", + "format": "date-time", + "description": "A date time( DateTime). The date till the resource is effective" + }, + "href": { + "type": "string", + "description": "The URI for the object itself." + }, + "id": { + "type": "string", + "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." + }, + "lifecycleState": { + "type": "string", + "description": "The life cycle state of the resource." + }, + "name": { + "type": "string", + "description": "A string used to give a name to the resource" + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "A date time( DateTime). The date from which the resource is effective" + }, + "version": { + "type": "string", + "description": "A field that identifies the specific version of an instance of a resource." + }, + "resourceRelationship": { + "type": "array", + "items": { + "$ref": "../Resource/ResourceRelationship.schema.json#ResourceRelationship" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "../Resource/ResourceCharacteristic.schema.json#ResourceCharacteristic" + } + }, + "place": { + "$ref": "../Common/Place.schema.json#Place" + }, + "partyRole": { + "type": "array", + "items": { + "$ref": "../EngagedParty/PartyRoleRef.schema.json#PartyRoleRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Resource/RealizingResourceRef.schema.json b/Resource/RealizingResourceRef.schema.json index c29576d3..52fb73b8 100644 --- a/Resource/RealizingResourceRef.schema.json +++ b/Resource/RealizingResourceRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "RealizingResourceRef.schema.json", - "title": "RealizingResourceRef", - "definitions": { - "RealizingResourceRef": { - "$id": "#RealizingResourceRef", - "type": "object", - "description": "RealizingResource reference. RealizingResource is a link to the resource that realizes the product.", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "RealizingResourceRef.schema.json", + "title": "RealizingResourceRef", + "definitions": { + "RealizingResourceRef": { + "$id": "#RealizingResourceRef", + "type": "object", + "description": "RealizingResource reference. RealizingResource is a link to the resource that realizes the product.", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} \ No newline at end of file + } +} diff --git a/Resource/Resource.schema.json b/Resource/Resource.schema.json index 56afb134..223135c9 100644 --- a/Resource/Resource.schema.json +++ b/Resource/Resource.schema.json @@ -1,90 +1,90 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Resource.schema.json", - "title": "Resource", - "definitions": { - "Resource": { - "$id": "#Resource", - "description": "Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory.", - "type": "object", - "properties": { - "category": { - "type": "string", - "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" - }, - "description": { - "type": "string", - "description": "free-text description of the resource" - }, - "endDate": { - "type": "string", - "format": "date-time", - "description": "A date time( DateTime). The date till the resource is effective" - }, - "href": { - "type": "string", - "description": "The URI for the object itself." - }, - "id": { - "type": "string", - "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." - }, - "lifecycleState": { - "type": "string", - "description": "The life cycle state of the resource." - }, - "name": { - "type": "string", - "description": "A string used to give a name to the resource" - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "A date time( DateTime). The date from which the resource is effective" - }, - "version": { - "type": "string", - "description": "A field that identifies the specific version of an instance of a resource." - }, - "resourceRelationship": { - "type": "array", - "items": { - "$ref": "ResourceRelationship.schema.json#ResourceRelationship" - } - }, - "characteristic": { - "type": "array", - "items": { - "$ref": "ResourceCharacteristic.schema.json#ResourceCharacteristic" - } - }, - "place": { - "$ref": "../Common/Place.schema.json#Place" - }, - "partyRole": { - "type": "array", - "items": { - "$ref": "../EngagedParty/PartyRoleRef.schema.json#PartyRoleRef" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Resource.schema.json", + "title": "Resource", + "definitions": { + "Resource": { + "$id": "#Resource", + "description": "Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory.", + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" + }, + "description": { + "type": "string", + "description": "free-text description of the resource" + }, + "endDate": { + "type": "string", + "format": "date-time", + "description": "A date time( DateTime). The date till the resource is effective" + }, + "href": { + "type": "string", + "description": "The URI for the object itself." + }, + "id": { + "type": "string", + "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." + }, + "lifecycleState": { + "type": "string", + "description": "The life cycle state of the resource." + }, + "name": { + "type": "string", + "description": "A string used to give a name to the resource" + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "A date time( DateTime). The date from which the resource is effective" + }, + "version": { + "type": "string", + "description": "A field that identifies the specific version of an instance of a resource." + }, + "resourceRelationship": { + "type": "array", + "items": { + "$ref": "../Resource/ResourceRelationship.schema.json#ResourceRelationship" + } + }, + "characteristic": { + "type": "array", + "items": { + "$ref": "../Resource/ResourceCharacteristic.schema.json#ResourceCharacteristic" + } + }, + "place": { + "$ref": "../Common/Place.schema.json#Place" + }, + "partyRole": { + "type": "array", + "items": { + "$ref": "../EngagedParty/PartyRoleRef.schema.json#PartyRoleRef" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Resource/ResourceAlarmRef.schema.json b/Resource/ResourceAlarmRef.schema.json index 88cd3c38..e970d03c 100644 --- a/Resource/ResourceAlarmRef.schema.json +++ b/Resource/ResourceAlarmRef.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceAlarmRef.schema.json", - "title": "ResourceAlarmRef", - "definitions": { - "ResourceAlarmRef": { - "$id": "#ResourceAlarmRef", - "type": "object", - "description": "A set of alarm ids identifying the alarms that are underlying this problem.", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "changeRequest": { - "$ref": "../Common/ChangeRequestRef.schema.json#ChangeRequestRef" - }, - "href": { - "type": "string", - "description": "Reference of the Alarm" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Alarm" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceAlarmRef.schema.json", + "title": "ResourceAlarmRef", + "definitions": { + "ResourceAlarmRef": { + "$id": "#ResourceAlarmRef", + "type": "object", + "description": "A set of alarm ids identifying the alarms that are underlying this problem.", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "changeRequest": { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + }, + "href": { + "type": "string", + "description": "Reference of the Alarm" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Alarm" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Resource/ResourceCandidateRef.schema.json b/Resource/ResourceCandidateRef.schema.json index ccaac58c..d19be1e7 100644 --- a/Resource/ResourceCandidateRef.schema.json +++ b/Resource/ResourceCandidateRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceCandidateRef.schema.json", - "title": "ResourceCandidateRef", - "definitions": { - "ResourceCandidateRef": { - "$id": "#ResourceCandidateRef", - "description": "ResourceCandidate reference: A resource candidate is an entity that makes a ResourceSpecification available to a catalog.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the resource candidate" - }, - "id": { - "type": "string", - "description": "Unique identifier of the resource candidate" - }, - "name": { - "type": "string", - "description": "Name of the resource candidate" - }, - "version": { - "type": "string", - "description": "Version of the resource candidate" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceCandidateRef.schema.json", + "title": "ResourceCandidateRef", + "definitions": { + "ResourceCandidateRef": { + "$id": "#ResourceCandidateRef", + "description": "ResourceCandidate reference: A resource candidate is an entity that makes a ResourceSpecification available to a catalog.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the resource candidate" + }, + "id": { + "type": "string", + "description": "Unique identifier of the resource candidate" + }, + "name": { + "type": "string", + "description": "Name of the resource candidate" + }, + "version": { + "type": "string", + "description": "Version of the resource candidate" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Resource/ResourceCharacteristic.schema.json b/Resource/ResourceCharacteristic.schema.json index 5d2ecdf4..7558d455 100644 --- a/Resource/ResourceCharacteristic.schema.json +++ b/Resource/ResourceCharacteristic.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceCharacteristic.schema.json", - "title": "ResourceCharacteristic", - "definitions": { - "ResourceCharacteristic": { - "$id": "#ResourceCharacteristic", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "name of the characteristic" - }, - "value": { - "type": "string", - "description": "value of the characteristic" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceCharacteristic.schema.json", + "title": "ResourceCharacteristic", + "definitions": { + "ResourceCharacteristic": { + "$id": "#ResourceCharacteristic", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "name of the characteristic" + }, + "value": { + "type": "string", + "description": "value of the characteristic" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Resource/ResourceOrder.schema.json b/Resource/ResourceOrder.schema.json index b196bab8..05c11be4 100644 --- a/Resource/ResourceOrder.schema.json +++ b/Resource/ResourceOrder.schema.json @@ -1,93 +1,93 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceOrder.schema.json", - "title": "ResourceOrder", - "definitions": { - "ResourceOrder": { - "$id": "#ResourceOrder", - "description": "A Resource Order is a request to provision a set of Resources (logical and physical) triggered by the request to provision a Service through a Service Order", - "type": "object", - "properties": { - "category": { - "type": "string", - "description": "Used to categorize the order from a business perspective that can be useful for the OM system." - }, - "completionDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order was completed" - }, - "correlationId": { - "type": "string", - "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" - }, - "description": { - "type": "string", - "description": "free-text description of the Resource Order" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the order" - }, - "id": { - "type": "string", - "description": "Identifier of an instance of the Resource Order. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." - }, - "name": { - "type": "string", - "description": "A string used to give a name to the Resource Order" - }, - "orderDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order was created" - }, - "priority": { - "type": "integer", - "description": "A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)" - }, - "requestedCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Requested delivery date from the requestor perspective" - }, - "requestedStartDate": { - "type": "string", - "format": "date-time", - "description": "Order start date wished by the requestor" - }, - "state": { - "type": "string", - "description": "The life cycle state of the resource." - }, - "orderType": { - "type": "string", - "description": "Name of the Resource Order type" - }, - "orderRelationship": { - "type": "array", - "items": { - "$ref": "ResourceOrderRelationship.schema.json#ResourceOrderRelationship" - } - }, - "relatedParty": { - "type": "array", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "note": { - "type": "array", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceOrder.schema.json", + "title": "ResourceOrder", + "definitions": { + "ResourceOrder": { + "$id": "#ResourceOrder", + "description": "A Resource Order is a request to provision a set of Resources (logical and physical) triggered by the request to provision a Service through a Service Order", + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Used to categorize the order from a business perspective that can be useful for the OM system." + }, + "completionDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order was completed" + }, + "correlationId": { + "type": "string", + "description": "ID given by the consumer and only understandable by him (to facilitate his searches afterwards)" + }, + "description": { + "type": "string", + "description": "free-text description of the Resource Order" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the order" + }, + "id": { + "type": "string", + "description": "Identifier of an instance of the Resource Order. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." + }, + "name": { + "type": "string", + "description": "A string used to give a name to the Resource Order" + }, + "orderDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order was created" + }, + "priority": { + "type": "integer", + "description": "A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)" + }, + "requestedCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Requested delivery date from the requestor perspective" + }, + "requestedStartDate": { + "type": "string", + "format": "date-time", + "description": "Order start date wished by the requestor" + }, + "state": { + "type": "string", + "description": "The life cycle state of the resource." + }, + "orderType": { + "type": "string", + "description": "Name of the Resource Order type" + }, + "orderRelationship": { + "type": "array", + "items": { + "$ref": "../Resource/ResourceOrderRelationship.schema.json#ResourceOrderRelationship" + } + }, + "relatedParty": { + "type": "array", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "note": { + "type": "array", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Resource/ResourceOrderItem.schema.json b/Resource/ResourceOrderItem.schema.json index 10e72008..bc112b39 100644 --- a/Resource/ResourceOrderItem.schema.json +++ b/Resource/ResourceOrderItem.schema.json @@ -1,44 +1,44 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceOrderItem.schema.json", - "title": "ResourceOrderItem", - "definitions": { - "ResourceOrderItem": { - "$id": "#ResourceOrderItem", - "description": "An identified part of the order. A resource order is decomposed into one or more order items.", - "type": "object", - "properties": { - "action": { - "type": "string", - "description": "Can be \"add\" / \"modify\" / \"no_change\"/ \"delete\"" - }, - "id": { - "type": "string", - "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" - }, - "quantity": { - "type": "integer", - "description": "Quantity ordered" - }, - "state": { - "type": "string", - "description": "State of the order item : described in the state machine diagram" - }, - "resourceSpecification": { - "$ref": "ResourceSpecificationRef.schema.json#ResourceSpecificationRef" - }, - "orderItemRelationship": { - "type": "array", - "items": { - "$ref": "ResourceOrderItemRelationship.schema.json#ResourceOrderItemRelationship" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceOrderItem.schema.json", + "title": "ResourceOrderItem", + "definitions": { + "ResourceOrderItem": { + "$id": "#ResourceOrderItem", + "description": "An identified part of the order. A resource order is decomposed into one or more order items.", + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "Can be \"add\" / \"modify\" / \"no_change\"/ \"delete\"" + }, + "id": { + "type": "string", + "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" + }, + "quantity": { + "type": "integer", + "description": "Quantity ordered" + }, + "state": { + "type": "string", + "description": "State of the order item : described in the state machine diagram" + }, + "resourceSpecification": { + "$ref": "../Resource/ResourceSpecificationRef.schema.json#ResourceSpecificationRef" + }, + "orderItemRelationship": { + "type": "array", + "items": { + "$ref": "../Resource/ResourceOrderItemRelationship.schema.json#ResourceOrderItemRelationship" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Resource/ResourceOrderItemRef.schema.json b/Resource/ResourceOrderItemRef.schema.json index ea86ff21..2847ea19 100644 --- a/Resource/ResourceOrderItemRef.schema.json +++ b/Resource/ResourceOrderItemRef.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceOrderItemRef.schema.json", - "title": "ResourceOrderItemRef", - "definitions": { - "ResourceOrderItemRef": { - "$id": "#ResourceOrderItemRef", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceOrderItemRef.schema.json", + "title": "ResourceOrderItemRef", + "definitions": { + "ResourceOrderItemRef": { + "$id": "#ResourceOrderItemRef", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Resource/ResourceOrderItemRelationship.schema.json b/Resource/ResourceOrderItemRelationship.schema.json index 59b2a6fc..45087c42 100644 --- a/Resource/ResourceOrderItemRelationship.schema.json +++ b/Resource/ResourceOrderItemRelationship.schema.json @@ -1,25 +1,25 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceOrderItemRelationship.schema.json", - "title": "ResourceOrderItemRelationship", - "definitions": { - "ResourceOrderItemRelationship": { - "$id": "#ResourceOrderItemRelationship", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of the order item relationship" - }, - "orderItem": { - "$ref": "ResourceOrderItemRef.schema.json#ResourceOrderItemRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceOrderItemRelationship.schema.json", + "title": "ResourceOrderItemRelationship", + "definitions": { + "ResourceOrderItemRelationship": { + "$id": "#ResourceOrderItemRelationship", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of the order item relationship" + }, + "orderItem": { + "$ref": "../Resource/ResourceOrderItemRef.schema.json#ResourceOrderItemRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Resource/ResourceOrderRef.schema.json b/Resource/ResourceOrderRef.schema.json index 414cca0c..e15c4f4a 100644 --- a/Resource/ResourceOrderRef.schema.json +++ b/Resource/ResourceOrderRef.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceOrderRef.schema.json", - "title": "ResourceOrderRef", - "definitions": { - "ResourceOrderRef": { - "$id": "#ResourceOrderRef", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hyperlink to access the related Resource Order" - }, - "id": { - "type": "string", - "description": "The unique identifier of the related resource order" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceOrderRef.schema.json", + "title": "ResourceOrderRef", + "definitions": { + "ResourceOrderRef": { + "$id": "#ResourceOrderRef", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hyperlink to access the related Resource Order" + }, + "id": { + "type": "string", + "description": "The unique identifier of the related resource order" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Resource/ResourceOrderRelationship.schema.json b/Resource/ResourceOrderRelationship.schema.json index 7a01ed7f..b95c2ddb 100644 --- a/Resource/ResourceOrderRelationship.schema.json +++ b/Resource/ResourceOrderRelationship.schema.json @@ -1,28 +1,28 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceOrderRelationship.schema.json", - "title": "ResourceOrderRelationship", - "definitions": { - "ResourceOrderRelationship": { - "$id": "#ResourceOrderRelationship", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "The type of related order item, such as [dependency] if the order item needs to be [not started] until another order item is complete; [cross-reference] to keep track of the source order (service order)" - }, - "resourceOrder": { - "$ref": "ResourceOrderRef.schema.json#ResourceOrderRef" - }, - "serviceOrder": { - "$ref": "../Service/ServiceOrderRef.schema.json#ServiceOrderRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceOrderRelationship.schema.json", + "title": "ResourceOrderRelationship", + "definitions": { + "ResourceOrderRelationship": { + "$id": "#ResourceOrderRelationship", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of related order item, such as [dependency] if the order item needs to be [not started] until another order item is complete; [cross-reference] to keep track of the source order (service order)" + }, + "resourceOrder": { + "$ref": "../Resource/ResourceOrderRef.schema.json#ResourceOrderRef" + }, + "serviceOrder": { + "$ref": "../Service/ServiceOrderRef.schema.json#ServiceOrderRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Resource/ResourceRef.schema.json b/Resource/ResourceRef.schema.json index f273d1dd..4a2e3930 100644 --- a/Resource/ResourceRef.schema.json +++ b/Resource/ResourceRef.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceRef.schema.json", - "title": "ResourceRef", - "definitions": { - "ResourceRef": { - "$id": "#ResourceRef", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the resource" - }, - "value": { - "type": "string", - "description": "The resource value that can be used to identify a resource with a public key (e.g.: a tel nr, an msisdn)" - } - }, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceRef.schema.json", + "title": "ResourceRef", + "definitions": { + "ResourceRef": { + "$id": "#ResourceRef", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the resource" + }, + "value": { + "type": "string", + "description": "The resource value that can be used to identify a resource with a public key (e.g.: a tel nr, an msisdn)" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} \ No newline at end of file + } +} diff --git a/Resource/ResourceRelationship.schema.json b/Resource/ResourceRelationship.schema.json index e04e1e5c..31c36fb3 100644 --- a/Resource/ResourceRelationship.schema.json +++ b/Resource/ResourceRelationship.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceRelationship.schema.json", - "title": "ResourceRelationship", - "definitions": { - "ResourceRelationship": { - "$id": "#ResourceRelationship", - "description": "Describes links between resources", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "Semantic of the relationship" - }, - "resource": { - "$ref": "ResourceRef.schema.json#ResourceRef", - "description": "A reference to the resource" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceRelationship.schema.json", + "title": "ResourceRelationship", + "definitions": { + "ResourceRelationship": { + "$id": "#ResourceRelationship", + "description": "Describes links between resources", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "Semantic of the relationship" + }, + "resource": { + "$ref": "../Resource/ResourceRef.schema.json#ResourceRef", + "description": "A reference to the resource" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Resource/ResourceSpecificationRef.schema.json b/Resource/ResourceSpecificationRef.schema.json index fd6deb93..051d1389 100644 --- a/Resource/ResourceSpecificationRef.schema.json +++ b/Resource/ResourceSpecificationRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ResourceSpecificationRef.schema.json", - "title": "ResourceSpecificationRef", - "definitions": { - "ResourceSpecificationRef": { - "$id": "#ResourceSpecificationRef", - "description": "Resource Specification reference: The ResourceSpecification is required to realize a ProductSpecification.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the resource specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the resource specification" - }, - "name": { - "type": "string", - "description": "Name of the requiredResourceSpecification" - }, - "version": { - "type": "string", - "description": "Resource specification version" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ResourceSpecificationRef.schema.json", + "title": "ResourceSpecificationRef", + "definitions": { + "ResourceSpecificationRef": { + "$id": "#ResourceSpecificationRef", + "description": "Resource Specification reference: The ResourceSpecification is required to realize a ProductSpecification.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the resource specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the resource specification" + }, + "name": { + "type": "string", + "description": "Name of the requiredResourceSpecification" + }, + "version": { + "type": "string", + "description": "Resource specification version" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Resource/SupportingResource.schema.json b/Resource/SupportingResource.schema.json index 25e11577..e5c6b6c4 100644 --- a/Resource/SupportingResource.schema.json +++ b/Resource/SupportingResource.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SupportingResource.schema.json", - "title": "SupportingResource", - "definitions": { - "SupportingResource": { - "$id": "#SupportingResource", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the supporting resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of the supporting resource" - }, - "name": { - "type": "string", - "description": "Name of the resource supporting the service" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SupportingResource.schema.json", + "title": "SupportingResource", + "definitions": { + "SupportingResource": { + "$id": "#SupportingResource", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the supporting resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of the supporting resource" + }, + "name": { + "type": "string", + "description": "Name of the resource supporting the service" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/AlternateServiceProposal.schema.json b/Service/AlternateServiceProposal.schema.json index 11c4e19d..ea25ee2e 100644 --- a/Service/AlternateServiceProposal.schema.json +++ b/Service/AlternateServiceProposal.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AlternateServiceProposal.schema.json", - "title": "AlternateServiceProposal", - "definitions": { - "AlternateServiceProposal": { - "$id": "#AlternateServiceProposal", - "description": "Alternate service proposal is used when the requested service is not available with characteristic and date asked for. An alternate proposal could be a distinct serviceSpecification close to requested one or same as requested but with a different activation date", - "type": "object", - "properties": { - "id": { - "description": "Identifier of a alternate service proposal", - "type": "string" - }, - "alternateServiceAvailabilityDate": { - "description": "Alternate availability date in case seller is not able to meet requested expected availability date for the service", - "type": "string", - "format": "date-time" - }, - "alternateService": { - "$ref": "ServiceRestriction.schema.json#/definitions/ServiceRestriction" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AlternateServiceProposal.schema.json", + "title": "AlternateServiceProposal", + "definitions": { + "AlternateServiceProposal": { + "$id": "#AlternateServiceProposal", + "description": "Alternate service proposal is used when the requested service is not available with characteristic and date asked for. An alternate proposal could be a distinct serviceSpecification close to requested one or same as requested but with a different activation date", + "type": "object", + "properties": { + "id": { + "description": "Identifier of a alternate service proposal", + "type": "string" + }, + "alternateServiceAvailabilityDate": { + "description": "Alternate availability date in case seller is not able to meet requested expected availability date for the service", + "type": "string", + "format": "date-time" + }, + "alternateService": { + "$ref": "ServiceRestriction.schema.json#/definitions/ServiceRestriction" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/AppliedConsequence.schema.json b/Service/AppliedConsequence.schema.json index 3e48b5fb..1a92b133 100644 --- a/Service/AppliedConsequence.schema.json +++ b/Service/AppliedConsequence.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "AppliedConsequence.schema.json", - "title": "AppliedConsequence", - "definitions": { - "AppliedConsequence": { - "$id": "#AppliedConsequence", - "type": "object", - "description": "An Applied Consequence defines the action (prescribed action or notification) to take when a \nMeasureThresholdRuleViolation occurs.", - "properties": { - "appliedAction": { - "type": "string", - "description": "The action for a violated threshold. This could be a hyperlink to \nthe action." - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the consequence is." - }, - "name": { - "type": "string", - "description": "A word, term, or phrase by which Consequence is known and \ndistinguished from other MetricDefMeasureConsequences." - }, - "repeatAction": { - "type": "boolean", - "description": "An indicator used to specify that a consequence should cease \nbeing applied if a value is in the same range as the previous value or continue being applied if a value is in the same range as the previous value. \nIf the repeatAction is True, if the consequence is always applied as soon as the MetricMeasure value is in the range of values and if the repeatAction is False, the consequence is applied only if the previous MetricMeasure value was not in the same range." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "AppliedConsequence.schema.json", + "title": "AppliedConsequence", + "definitions": { + "AppliedConsequence": { + "$id": "#AppliedConsequence", + "type": "object", + "description": "An Applied Consequence defines the action (prescribed action or notification) to take when a \nMeasureThresholdRuleViolation occurs.", + "properties": { + "appliedAction": { + "type": "string", + "description": "The action for a violated threshold. This could be a hyperlink to \nthe action." + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the consequence is." + }, + "name": { + "type": "string", + "description": "A word, term, or phrase by which Consequence is known and \ndistinguished from other MetricDefMeasureConsequences." + }, + "repeatAction": { + "type": "boolean", + "description": "An indicator used to specify that a consequence should cease \nbeing applied if a value is in the same range as the previous value or continue being applied if a value is in the same range as the previous value. \nIf the repeatAction is True, if the consequence is always applied as soon as the MetricMeasure value is in the range of values and if the repeatAction is False, the consequence is applied only if the previous MetricMeasure value was not in the same range." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/BaseService.schema.json b/Service/BaseService.schema.json index c6dd231d..e787ad8d 100644 --- a/Service/BaseService.schema.json +++ b/Service/BaseService.schema.json @@ -1,89 +1,89 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "BaseService.schema.json", - "title": "BaseService", - "definitions": { - "BaseService": { - "$id": "#BaseService", - "description": "In the context of a service order and depending on the action requested (add/modify/delete/noChange) this data structure captures the configuration to apply to an existing subscribed service or to a new one", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the service", - "type": "string" - }, - "href": { - "description": "Reference of the service", - "type": "string" - }, - "serviceType": { - "description": "Business type of the service", - "type": "string" - }, - "name": { - "description": "Name of the service", - "type": "string" - }, - "state": { - "description": "The life cycle state of the service, such as: [feasibilityChecked], [designed]", - "$ref": "ServiceStateType.schema.json#ServiceStateType" - }, - "category": { - "type": "string", - "description": "Is it a customer facing or resource facing service" - }, - "serviceSpecification": { - "description": "The specification from which this service was instantiated", - "$ref": "ServiceSpecificationRef.schema.json#ServiceSpecificationRef" - }, - "serviceCharacteristic": { - "type": "array", - "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*]) ", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - } - }, - "serviceRelationship": { - "type": "array", - "description": "A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).", - "items": { - "$ref": "ServiceRelationship.schema.json#ServiceRelationship" - } - }, - "supportingService": { - "type": "array", - "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)", - "items": { - "$ref": "ServiceRef.schema.json#ServiceRef" - } - }, - "supportingResource": { - "type": "array", - "description": "A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources", - "items": { - "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" - } - }, - "relatedParty": { - "type": "array", - "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "place": { - "type": "array", - "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a delivery geographical place)", - "items": { - "$ref": "../Common/Place.schema.json#Place" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "BaseService.schema.json", + "title": "BaseService", + "definitions": { + "BaseService": { + "$id": "#BaseService", + "description": "In the context of a service order and depending on the action requested (add/modify/delete/noChange) this data structure captures the configuration to apply to an existing subscribed service or to a new one", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service", + "type": "string" + }, + "href": { + "description": "Reference of the service", + "type": "string" + }, + "serviceType": { + "description": "Business type of the service", + "type": "string" + }, + "name": { + "description": "Name of the service", + "type": "string" + }, + "state": { + "description": "The life cycle state of the service, such as: [feasibilityChecked], [designed]", + "$ref": "../Service/ServiceStateType.schema.json#ServiceStateType" + }, + "category": { + "type": "string", + "description": "Is it a customer facing or resource facing service" + }, + "serviceSpecification": { + "description": "The specification from which this service was instantiated", + "$ref": "../Service/ServiceSpecificationRef.schema.json#ServiceSpecificationRef" + }, + "serviceCharacteristic": { + "type": "array", + "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*]) ", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "serviceRelationship": { + "type": "array", + "description": "A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).", + "items": { + "$ref": "../Service/ServiceRelationship.schema.json#ServiceRelationship" + } + }, + "supportingService": { + "type": "array", + "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)", + "items": { + "$ref": "../Service/ServiceRef.schema.json#ServiceRef" + } + }, + "supportingResource": { + "type": "array", + "description": "A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources", + "items": { + "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" + } + }, + "relatedParty": { + "type": "array", + "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "place": { + "type": "array", + "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a delivery geographical place)", + "items": { + "$ref": "../Common/Place.schema.json#Place" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/FirstAlert.schema.json b/Service/FirstAlert.schema.json index 0666bb5f..4409b491 100644 --- a/Service/FirstAlert.schema.json +++ b/Service/FirstAlert.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "FirstAlert.schema.json", - "title": "FirstAlert", - "definitions": { - "FirstAlert": { - "$id": "#FirstAlert", - "type": "object", - "description": "Indicates what first alerted the system to the problem. It is not the root cause of the Service Problem. Examples: Threshold crossing alert", - "properties": { - "href": { - "type": "string", - "description": "Reference of the object" - }, - "id": { - "type": "string", - "description": "Unique identifier of the object" - }, - "alertType": { - "type": "string", - "description": "Type of the object" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "FirstAlert.schema.json", + "title": "FirstAlert", + "definitions": { + "FirstAlert": { + "$id": "#FirstAlert", + "type": "object", + "description": "Indicates what first alerted the system to the problem. It is not the root cause of the Service Problem. Examples: Threshold crossing alert", + "properties": { + "href": { + "type": "string", + "description": "Reference of the object" + }, + "id": { + "type": "string", + "description": "Unique identifier of the object" + }, + "alertType": { + "type": "string", + "description": "Type of the object" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ImpactPattern.schema.json b/Service/ImpactPattern.schema.json index 215ad29c..bc67281e 100644 --- a/Service/ImpactPattern.schema.json +++ b/Service/ImpactPattern.schema.json @@ -1,30 +1,30 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ImpactPattern.schema.json", - "title": "ImpactPattern", - "definitions": { - "ImpactPattern": { - "$id": "#ImpactPattern", - "type": "object", - "description": "Define the patterns of impact (optional), such as other service characteristics- Used when defining impact through another pattern than the pre-defined attributes", - "properties": { - "description": { - "type": "string", - "description": "Basic description of the impact pattern" - }, - "extensionInfo": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - }, - "description": "A generic list of any type of elements. Used for extensions or loose element encapsulation from other namespaces" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ImpactPattern.schema.json", + "title": "ImpactPattern", + "definitions": { + "ImpactPattern": { + "$id": "#ImpactPattern", + "type": "object", + "description": "Define the patterns of impact (optional), such as other service characteristics- Used when defining impact through another pattern than the pre-defined attributes", + "properties": { + "description": { + "type": "string", + "description": "Basic description of the impact pattern" + }, + "extensionInfo": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + }, + "description": "A generic list of any type of elements. Used for extensions or loose element encapsulation from other namespaces" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/MeasureThresholdRuleViolation.schema.json b/Service/MeasureThresholdRuleViolation.schema.json index 98325ea3..e8a0df27 100644 --- a/Service/MeasureThresholdRuleViolation.schema.json +++ b/Service/MeasureThresholdRuleViolation.schema.json @@ -1,62 +1,62 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "MeasureThresholdRuleViolation.schema.json", - "title": "MeasureThresholdRuleViolation", - "definitions": { - "MeasureThresholdRuleViolation": { - "$id": "#MeasureThresholdRuleViolation", - "description": "A measureThresholdRuleViolation is a violation of a rule that defines the in the \nMericDefMeasureThresholdRule.", - "type": "object", - "properties": { - "conformanceComparatorLower": { - "type": "string", - "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetLower." - }, - "conformanceComparatorUpper": { - "type": "string", - "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetUpper." - }, - "conformanceTargetLower": { - "type": "string", - "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the lower limit. The value should be less than the conformanceTargetUpper. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." - }, - "conformanceTargetUpper": { - "type": "string", - "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the Upper limit. The value should be greater than the conformanceTargetLower. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." - }, - "description": { - "type": "string", - "description": "Description for the MetricDefMeasureThresholdRule ." - }, - "name": { - "type": "string", - "description": "Name for the MetricDefMeasureThresholdRule ." - }, - "numberOfAllowedCrossing": { - "type": "integer", - "description": "The number of allowed crossing occurrences in reference to the \ntolerancePeriod without a consequence being initiated." - }, - "thresholdRuleSeverity": { - "type": "string", - "description": "A threshold can be generated in different severity levels. A \ncrossing for each level may require a different condition and possibly trigger a different consequence." - }, - "tolerancePeriod": { - "description": "An interval of time of allowed crossing occurrences before a \nconsequence being initiated.", - "$ref": "../Common/Duration.schema.json#Duration" - }, - "appliedConsequence": { - "type": "array", - "description": "An Applied Consequence defines the action (prescribed action or notification) to take when a MeasureThresholdRuleViolation occurs.", - "items": { - "$ref": "AppliedConsequence.schema.json#AppliedConsequence" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "MeasureThresholdRuleViolation.schema.json", + "title": "MeasureThresholdRuleViolation", + "definitions": { + "MeasureThresholdRuleViolation": { + "$id": "#MeasureThresholdRuleViolation", + "description": "A measureThresholdRuleViolation is a violation of a rule that defines the in the \nMericDefMeasureThresholdRule.", + "type": "object", + "properties": { + "conformanceComparatorLower": { + "type": "string", + "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetLower." + }, + "conformanceComparatorUpper": { + "type": "string", + "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetUpper." + }, + "conformanceTargetLower": { + "type": "string", + "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the lower limit. The value should be less than the conformanceTargetUpper. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." + }, + "conformanceTargetUpper": { + "type": "string", + "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the Upper limit. The value should be greater than the conformanceTargetLower. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." + }, + "description": { + "type": "string", + "description": "Description for the MetricDefMeasureThresholdRule ." + }, + "name": { + "type": "string", + "description": "Name for the MetricDefMeasureThresholdRule ." + }, + "numberOfAllowedCrossing": { + "type": "integer", + "description": "The number of allowed crossing occurrences in reference to the \ntolerancePeriod without a consequence being initiated." + }, + "thresholdRuleSeverity": { + "type": "string", + "description": "A threshold can be generated in different severity levels. A \ncrossing for each level may require a different condition and possibly trigger a different consequence." + }, + "tolerancePeriod": { + "description": "An interval of time of allowed crossing occurrences before a \nconsequence being initiated.", + "$ref": "../Common/Duration.schema.json#Duration" + }, + "appliedConsequence": { + "type": "array", + "description": "An Applied Consequence defines the action (prescribed action or notification) to take when a MeasureThresholdRuleViolation occurs.", + "items": { + "$ref": "../Service/AppliedConsequence.schema.json#AppliedConsequence" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/MetricDefMeasureConsequence.schema.json b/Service/MetricDefMeasureConsequence.schema.json index d4368d21..41e43b32 100644 --- a/Service/MetricDefMeasureConsequence.schema.json +++ b/Service/MetricDefMeasureConsequence.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "MetricDefMeasureConsequence.schema.json", - "title": "MetricDefMeasureConsequence", - "definitions": { - "MetricDefMeasureConsequence": { - "$id": "#MetricDefMeasureConsequence", - "description": "A MetricDefMeasureConsequence defines the action (prescribed action or notification) to take when a \nMetricDefMeasureThresholdRule is crossed.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A narrative that explains in detail what the consequence is." - }, - "name": { - "type": "string", - "description": "A word, term, or phrase by which a \nMetricDefMeasureConsequence is known and distinguished from other MetricDefMeasureConsequences." - }, - "prescribeAction": { - "type": "string", - "description": "Recommended remedy for a violated threshold. This could be \nthe hyperlink to the action." - }, - "repeatAction": { - "type": "boolean", - "description": "An indicator used to specify that a consequence should cease \nbeing applied if a value is in the same range as the previous value or continue being applied if a value is in the same range as the previous value. \nIf the repeatAction is True, if the consequence is always applied as soon as the MetricMeasure value is in the range of values and if the repeatAction is False, the consequence is applied only if the previous MetricMeasure value was not in the same range." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "A valid duration of a thing." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "MetricDefMeasureConsequence.schema.json", + "title": "MetricDefMeasureConsequence", + "definitions": { + "MetricDefMeasureConsequence": { + "$id": "#MetricDefMeasureConsequence", + "description": "A MetricDefMeasureConsequence defines the action (prescribed action or notification) to take when a \nMetricDefMeasureThresholdRule is crossed.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A narrative that explains in detail what the consequence is." + }, + "name": { + "type": "string", + "description": "A word, term, or phrase by which a \nMetricDefMeasureConsequence is known and distinguished from other MetricDefMeasureConsequences." + }, + "prescribeAction": { + "type": "string", + "description": "Recommended remedy for a violated threshold. This could be \nthe hyperlink to the action." + }, + "repeatAction": { + "type": "boolean", + "description": "An indicator used to specify that a consequence should cease \nbeing applied if a value is in the same range as the previous value or continue being applied if a value is in the same range as the previous value. \nIf the repeatAction is True, if the consequence is always applied as soon as the MetricMeasure value is in the range of values and if the repeatAction is False, the consequence is applied only if the previous MetricMeasure value was not in the same range." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "A valid duration of a thing." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/MetricDefMeasureThresholdRule.schema.json b/Service/MetricDefMeasureThresholdRule.schema.json index 7e3c3963..2c6e33cb 100644 --- a/Service/MetricDefMeasureThresholdRule.schema.json +++ b/Service/MetricDefMeasureThresholdRule.schema.json @@ -1,62 +1,62 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "MetricDefMeasureThresholdRule.schema.json", - "title": "MetricDefMeasureThresholdRule", - "definitions": { - "MetricDefMeasureThresholdRule": { - "$id": "#MetricDefMeasureThresholdRule", - "description": "A MetricDefMeasureThresholdRule is a rule that defines the condition (raise or clear) to achieve to apply \nconsequences when a threshold is crossed or ceased to be crossed. It also defines the severity of the \nraise or clear of the threshold.", - "type": "object", - "properties": { - "conformanceComparatorLower": { - "type": "string", - "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to Service Test Management API REST Specification compare with the conformanceTargetLower." - }, - "conformanceComparatorUpper": { - "type": "string", - "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetUpper." - }, - "conformanceTargetLower": { - "type": "string", - "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the lower limit. The value should be less than the conformanceTargetUpper. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." - }, - "conformanceTargetUpper": { - "type": "string", - "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the Upper limit. The value should be greater than the conformanceTargetLower. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." - }, - "consequence": { - "type": "array", - "description": "A list of consequences (actions, notifications) that will arise if the threshold is crossed", - "items": { - "$ref": "MetricDefMeasureConsequence.schema.json#MetricDefMeasureConsequence" - } - }, - "description": { - "type": "string", - "description": "Description for the MetricDefMeasureThresholdRule ." - }, - "name": { - "type": "string", - "description": "Name for the MetricDefMeasureThresholdRule ." - }, - "numberOfAllowedCrossing": { - "type": "integer", - "description": "The number of allowed crossing occurrences in reference to the \ntolerancePeriod without a consequence being initiated." - }, - "thresholdRuleSeverity": { - "type": "string", - "description": "A threshold can be generated in different severity levels. A \ncrossing for each level may require a different condition and possibly trigger a different consequence." - }, - "tolerancePeriod": { - "description": "An interval of time of allowed crossing occurrences before a consequence being initiated.", - "$ref": "../Common/Duration.schema.json#Duration" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "MetricDefMeasureThresholdRule.schema.json", + "title": "MetricDefMeasureThresholdRule", + "definitions": { + "MetricDefMeasureThresholdRule": { + "$id": "#MetricDefMeasureThresholdRule", + "description": "A MetricDefMeasureThresholdRule is a rule that defines the condition (raise or clear) to achieve to apply \nconsequences when a threshold is crossed or ceased to be crossed. It also defines the severity of the \nraise or clear of the threshold.", + "type": "object", + "properties": { + "conformanceComparatorLower": { + "type": "string", + "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to Service Test Management API REST Specification compare with the conformanceTargetLower." + }, + "conformanceComparatorUpper": { + "type": "string", + "description": "An operator that when applied on a value specifies whether a \nthreshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetUpper." + }, + "conformanceTargetLower": { + "type": "string", + "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the lower limit. The value should be less than the conformanceTargetUpper. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." + }, + "conformanceTargetUpper": { + "type": "string", + "description": "A value used to determine if the threshold is crossed or ceases \nto be crossed. It represents the Upper limit. The value should be greater than the conformanceTargetLower. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." + }, + "consequence": { + "type": "array", + "description": "A list of consequences (actions, notifications) that will arise if the threshold is crossed", + "items": { + "$ref": "../Service/MetricDefMeasureConsequence.schema.json#MetricDefMeasureConsequence" + } + }, + "description": { + "type": "string", + "description": "Description for the MetricDefMeasureThresholdRule ." + }, + "name": { + "type": "string", + "description": "Name for the MetricDefMeasureThresholdRule ." + }, + "numberOfAllowedCrossing": { + "type": "integer", + "description": "The number of allowed crossing occurrences in reference to the \ntolerancePeriod without a consequence being initiated." + }, + "thresholdRuleSeverity": { + "type": "string", + "description": "A threshold can be generated in different severity levels. A \ncrossing for each level may require a different condition and possibly trigger a different consequence." + }, + "tolerancePeriod": { + "description": "An interval of time of allowed crossing occurrences before a consequence being initiated.", + "$ref": "../Common/Duration.schema.json#Duration" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ProblemAcknowledgement.schema.json b/Service/ProblemAcknowledgement.schema.json index 291dfc8c..7d73e190 100644 --- a/Service/ProblemAcknowledgement.schema.json +++ b/Service/ProblemAcknowledgement.schema.json @@ -1,45 +1,45 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProblemAcknowledgement.schema.json", - "title": "ProblemAcknowledgement", - "definitions": { - "ProblemAcknowledgement": { - "$id": "#ProblemAcknowledgement", - "type": "object", - "description": "Task resource that requests acknowledgement of problems by the problem handler.", - "properties": { - "href": { - "type": "string", - "description": "Reference to this task resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of this task resource" - }, - "problem": { - "description": "The problems to be acknowledged, relevant in the input to this task", - "type": "array", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "ackProblem": { - "description": "The problems that were acknowledged, populated in the output to this task", - "type": "array", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "trackingRecord": { - "description": "A record of the action taken in this acknowledgement", - "$ref": "TrackingRecord.schema.json#TrackingRecord" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProblemAcknowledgement.schema.json", + "title": "ProblemAcknowledgement", + "definitions": { + "ProblemAcknowledgement": { + "$id": "#ProblemAcknowledgement", + "type": "object", + "description": "Task resource that requests acknowledgement of problems by the problem handler.", + "properties": { + "href": { + "type": "string", + "description": "Reference to this task resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of this task resource" + }, + "problem": { + "description": "The problems to be acknowledged, relevant in the input to this task", + "type": "array", + "items": { + "$ref": "../Service/ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "ackProblem": { + "description": "The problems that were acknowledged, populated in the output to this task", + "type": "array", + "items": { + "$ref": "../Service/ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "trackingRecord": { + "description": "A record of the action taken in this acknowledgement", + "$ref": "../Service/TrackingRecord.schema.json#TrackingRecord" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ProblemGroup.schema.json b/Service/ProblemGroup.schema.json index 4b117472..7ab07f7e 100644 --- a/Service/ProblemGroup.schema.json +++ b/Service/ProblemGroup.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProblemGroup.schema.json", - "title": "ProblemGroup", - "definitions": { - "ProblemGroup": { - "$id": "#ProblemGroup", - "description": "Task resource that requests Service Problems to be grouped together into a parent and set of children", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference to this task resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of this task resource" - }, - "childProblem": { - "type": "array", - "description": "List of problems to be grouped under a parent problem", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "parentProblem": { - "description": "The parent problem to which the problems are to be grouped", - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProblemGroup.schema.json", + "title": "ProblemGroup", + "definitions": { + "ProblemGroup": { + "$id": "#ProblemGroup", + "description": "Task resource that requests Service Problems to be grouped together into a parent and set of children", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference to this task resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of this task resource" + }, + "childProblem": { + "type": "array", + "description": "List of problems to be grouped under a parent problem", + "items": { + "$ref": "../Service/ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "parentProblem": { + "description": "The parent problem to which the problems are to be grouped", + "$ref": "../Service/ServiceProblemRef.schema.json#ServiceProblemRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ProblemUnacknowledgement.schema.json b/Service/ProblemUnacknowledgement.schema.json index 6a8caaef..56404b8f 100644 --- a/Service/ProblemUnacknowledgement.schema.json +++ b/Service/ProblemUnacknowledgement.schema.json @@ -1,45 +1,45 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProblemUnacknowledgement.schema.json", - "title": "ProblemUnacknowledgement", - "definitions": { - "ProblemUnacknowledgement": { - "$id": "#ProblemUnacknowledgement", - "type": "object", - "description": "Task resource that requests unacknowledgement of problems, rolling back the status of the problems from Acknowledged to Submitted.", - "properties": { - "href": { - "type": "string", - "description": "Reference to this task resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of this task resource" - }, - "problem": { - "description": "The problems to be unacknowledged, relevant in the input to this task", - "type": "array", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "unackProblem": { - "description": "The problems that were unacknowledged, populated in the output to this task", - "type": "array", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "trackingRecord": { - "description": "A record of the action taken in this acknowledgement", - "$ref": "TrackingRecord.schema.json#TrackingRecord" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProblemUnacknowledgement.schema.json", + "title": "ProblemUnacknowledgement", + "definitions": { + "ProblemUnacknowledgement": { + "$id": "#ProblemUnacknowledgement", + "type": "object", + "description": "Task resource that requests unacknowledgement of problems, rolling back the status of the problems from Acknowledged to Submitted.", + "properties": { + "href": { + "type": "string", + "description": "Reference to this task resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of this task resource" + }, + "problem": { + "description": "The problems to be unacknowledged, relevant in the input to this task", + "type": "array", + "items": { + "$ref": "../Service/ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "unackProblem": { + "description": "The problems that were unacknowledged, populated in the output to this task", + "type": "array", + "items": { + "$ref": "../Service/ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "trackingRecord": { + "description": "A record of the action taken in this acknowledgement", + "$ref": "../Service/TrackingRecord.schema.json#TrackingRecord" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ProblemUngroup.schema.json b/Service/ProblemUngroup.schema.json index e80a7f82..294057a4 100644 --- a/Service/ProblemUngroup.schema.json +++ b/Service/ProblemUngroup.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ProblemUngroup.schema.json", - "title": "ProblemUngroup", - "definitions": { - "ProblemUngroup": { - "$id": "#ProblemUngroup", - "description": "Task resource that requests Service Problems to be ungrouped from a parent", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference to this task resource" - }, - "id": { - "type": "string", - "description": "Unique identifier of this task resource" - }, - "childProblem": { - "type": "array", - "description": "List of problems to be ungrouped from a parent problem", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "parentProblem": { - "description": "The parent problem from which the problems are to be ungrouped", - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ProblemUngroup.schema.json", + "title": "ProblemUngroup", + "definitions": { + "ProblemUngroup": { + "$id": "#ProblemUngroup", + "description": "Task resource that requests Service Problems to be ungrouped from a parent", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference to this task resource" + }, + "id": { + "type": "string", + "description": "Unique identifier of this task resource" + }, + "childProblem": { + "type": "array", + "description": "List of problems to be ungrouped from a parent problem", + "items": { + "$ref": "../Service/ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "parentProblem": { + "description": "The parent problem from which the problems are to be ungrouped", + "$ref": "../Service/ServiceProblemRef.schema.json#ServiceProblemRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/Service.schema.json b/Service/Service.schema.json index 6995cfc2..b96de467 100644 --- a/Service/Service.schema.json +++ b/Service/Service.schema.json @@ -1,67 +1,67 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "Service.schema.json", - "title": "Service", - "definitions": { - "Service": { - "$id": "#Service", - "description": "Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.", - "type": "object", - "properties": { - "description": { - "description": "Free-text description of the service", - "type": "string" - }, - "isServiceEnabled": { - "type": "boolean", - "description": "If FALSE, this particular Service has NOT been enabled for use" - }, - "hasStarted": { - "type": "boolean", - "description": "If TRUE, this Service has already been started" - }, - "startMode": { - "type": "string", - "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above" - }, - "isStateful": { - "type": "boolean", - "description": "If TRUE, this Service can be changed without affecting any other services" - }, - "serviceDate": { - "description": "Date when the service was created (whatever its status).", - "type": "string" - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "Date when the service starts" - }, - "endDate": { - "type": "string", - "format": "date-time", - "description": "Date when the service ends" - }, - "serviceOrder": { - "type": "array", - "description": "A list of service orders related to this service", - "items": { - "$ref": "ServiceOrderRef.schema.json#ServiceOrderRef" - } - }, - "note": { - "type": "array", - "description": "A list of notes made on this service", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - } - }, - "allOf": [ - { - "$ref": "BaseService.schema.json#BaseService" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "Service.schema.json", + "title": "Service", + "definitions": { + "Service": { + "$id": "#Service", + "description": "Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.", + "type": "object", + "properties": { + "description": { + "description": "Free-text description of the service", + "type": "string" + }, + "isServiceEnabled": { + "type": "boolean", + "description": "If FALSE, this particular Service has NOT been enabled for use" + }, + "hasStarted": { + "type": "boolean", + "description": "If TRUE, this Service has already been started" + }, + "startMode": { + "type": "string", + "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above" + }, + "isStateful": { + "type": "boolean", + "description": "If TRUE, this Service can be changed without affecting any other services" + }, + "serviceDate": { + "description": "Date when the service was created (whatever its status).", + "type": "string" + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "Date when the service starts" + }, + "endDate": { + "type": "string", + "format": "date-time", + "description": "Date when the service ends" + }, + "serviceOrder": { + "type": "array", + "description": "A list of service orders related to this service", + "items": { + "$ref": "../Service/ServiceOrderRef.schema.json#ServiceOrderRef" + } + }, + "note": { + "type": "array", + "description": "A list of notes made on this service", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } } + }, + "allOf": [ + { + "$ref": "../Service/BaseService.schema.json#BaseService" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceCandidate.schema.json b/Service/ServiceCandidate.schema.json index 60b467ab..7382deb8 100644 --- a/Service/ServiceCandidate.schema.json +++ b/Service/ServiceCandidate.schema.json @@ -1,63 +1,63 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceCandidate.schema.json", - "title": "ServiceCandidate", - "definitions": { - "ServiceCandidate": { - "$id": "#ServiceCandidate", - "description": "ServiceCandidate is an entity that makes a service specification available to a catalog. A\nServiceCandidate and its associated service specification may be published - made visible - in any number of service catalogs, or in none. One service specification can be composed of other service specifications.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of this REST resource" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to this REST resource" - }, - "name": { - "type": "string", - "description": "Name given to this REST resource" - }, - "description": { - "type": "string", - "description": "Description of this REST resource" - }, - "version": { - "type": "string", - "description": "the version of service candidate" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which this REST resource is valid" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update of this REST resource" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status of the service candidate." - }, - "category": { - "type": "array", - "description": "List of categories for this candidate", - "items": { - "$ref": "ServiceCategoryRef.schema.json#ServiceCategoryRef" - } - }, - "serviceSpecification": { - "description": "The service specification implied by this candidate", - "$ref": "ServiceSpecificationRef.schema.json#ServiceSpecificationRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceCandidate.schema.json", + "title": "ServiceCandidate", + "definitions": { + "ServiceCandidate": { + "$id": "#ServiceCandidate", + "description": "ServiceCandidate is an entity that makes a service specification available to a catalog. A\nServiceCandidate and its associated service specification may be published - made visible - in any number of service catalogs, or in none. One service specification can be composed of other service specifications.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of this REST resource" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to this REST resource" + }, + "name": { + "type": "string", + "description": "Name given to this REST resource" + }, + "description": { + "type": "string", + "description": "Description of this REST resource" + }, + "version": { + "type": "string", + "description": "the version of service candidate" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which this REST resource is valid" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update of this REST resource" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status of the service candidate." + }, + "category": { + "type": "array", + "description": "List of categories for this candidate", + "items": { + "$ref": "../Service/ServiceCategoryRef.schema.json#ServiceCategoryRef" + } + }, + "serviceSpecification": { + "description": "The service specification implied by this candidate", + "$ref": "../Service/ServiceSpecificationRef.schema.json#ServiceSpecificationRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceCandidateRef.schema.json b/Service/ServiceCandidateRef.schema.json index 33e41567..19e1591b 100644 --- a/Service/ServiceCandidateRef.schema.json +++ b/Service/ServiceCandidateRef.schema.json @@ -1,39 +1,39 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceCandidateRef.schema.json", - "title": "ServiceCandidateRef", - "definitions": { - "ServiceCandidateRef": { - "$id": "#ServiceCandidateRef", - "description": "ServiceCandidate reference. ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Unique reference of the service candidate" - }, - "id": { - "type": "string", - "description": "Unique identifier of the service candidate" - }, - "name": { - "type": "string", - "description": "Name of the service candidate" - }, - "version": { - "type": "string", - "description": "Version of the service candidate" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceCandidateRef.schema.json", + "title": "ServiceCandidateRef", + "definitions": { + "ServiceCandidateRef": { + "$id": "#ServiceCandidateRef", + "description": "ServiceCandidate reference. ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Unique reference of the service candidate" + }, + "id": { + "type": "string", + "description": "Unique identifier of the service candidate" + }, + "name": { + "type": "string", + "description": "Name of the service candidate" + }, + "version": { + "type": "string", + "description": "Version of the service candidate" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceCatalog.schema.json b/Service/ServiceCatalog.schema.json index 94dfe37d..7878dca8 100644 --- a/Service/ServiceCatalog.schema.json +++ b/Service/ServiceCatalog.schema.json @@ -1,66 +1,66 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceCatalog.schema.json", - "title": "ServiceCatalog", - "definitions": { - "ServiceCatalog": { - "$id": "#ServiceCatalog", - "description": "The root entity for service catalog management.\nA service catalog is a group of service specifications made available through service candidates that an organization provides to the consumers (internal consumers like its employees or B2B customers or B2C customers). \nA service catalog typically includes name, description and time period that is valid for. It will have a list of ServiceCandidate catalog items. A ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog.\nA ServiceCandidate and its associated ServiceSpecification may be \"published\" - made visible -in any number of ServiceCatalogs, or in none.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the ServiceCatalog" - }, - "href": { - "type": "string", - "description": "Unique reference of the service catalog" - }, - "name": { - "type": "string", - "description": "Name of the service catalog" - }, - "description": { - "type": "string", - "description": "Description of this catalog" - }, - "version": { - "type": "string", - "description": "ServiceCatalog version" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the service catalog is valid" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "category": { - "type": "array", - "description": "List of service categories associated with this catalog", - "items": { - "$ref": "ServiceCategoryRef.schema.json#ServiceCategoryRef" - } - }, - "relatedParty": { - "type": "array", - "description": "List of parties or party roles related to this category", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceCatalog.schema.json", + "title": "ServiceCatalog", + "definitions": { + "ServiceCatalog": { + "$id": "#ServiceCatalog", + "description": "The root entity for service catalog management.\nA service catalog is a group of service specifications made available through service candidates that an organization provides to the consumers (internal consumers like its employees or B2B customers or B2C customers). \nA service catalog typically includes name, description and time period that is valid for. It will have a list of ServiceCandidate catalog items. A ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog.\nA ServiceCandidate and its associated ServiceSpecification may be \"published\" - made visible -in any number of ServiceCatalogs, or in none.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the ServiceCatalog" + }, + "href": { + "type": "string", + "description": "Unique reference of the service catalog" + }, + "name": { + "type": "string", + "description": "Name of the service catalog" + }, + "description": { + "type": "string", + "description": "Description of this catalog" + }, + "version": { + "type": "string", + "description": "ServiceCatalog version" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the service catalog is valid" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "category": { + "type": "array", + "description": "List of service categories associated with this catalog", + "items": { + "$ref": "../Service/ServiceCategoryRef.schema.json#ServiceCategoryRef" + } + }, + "relatedParty": { + "type": "array", + "description": "List of parties or party roles related to this category", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceCategory.schema.json b/Service/ServiceCategory.schema.json index 17b94dec..d5eb7a1f 100644 --- a/Service/ServiceCategory.schema.json +++ b/Service/ServiceCategory.schema.json @@ -1,74 +1,74 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceCategory.schema.json", - "title": "ServiceCategory", - "definitions": { - "ServiceCategory": { - "$id": "#ServiceCategory", - "description": "The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the category" - }, - "href": { - "type": "string", - "description": "Reference of the category" - }, - "name": { - "type": "string", - "description": "Name of the category" - }, - "description": { - "type": "string", - "description": "Description of the category" - }, - "version": { - "type": "string", - "description": "ServiceCategory version" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the category is valid" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update" - }, - "parentId": { - "type": "string", - "description": "Unique identifier of the parent category" - }, - "isRoot": { - "type": "boolean", - "description": "If true, this Boolean indicates that the category is a root of categories" - }, - "serviceCandidate": { - "type": "array", - "description": "List of service candidates associated with this category", - "items": { - "$ref": "ServiceCandidateRef.schema.json#ServiceCandidateRef" - } - }, - "category": { - "type": "array", - "description": "List of child categories in the tree for in this category", - "items": { - "$ref": "ServiceCategoryRef.schema.json#ServiceCategoryRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceCategory.schema.json", + "title": "ServiceCategory", + "definitions": { + "ServiceCategory": { + "$id": "#ServiceCategory", + "description": "The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the category" + }, + "href": { + "type": "string", + "description": "Reference of the category" + }, + "name": { + "type": "string", + "description": "Name of the category" + }, + "description": { + "type": "string", + "description": "Description of the category" + }, + "version": { + "type": "string", + "description": "ServiceCategory version" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the category is valid" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update" + }, + "parentId": { + "type": "string", + "description": "Unique identifier of the parent category" + }, + "isRoot": { + "type": "boolean", + "description": "If true, this Boolean indicates that the category is a root of categories" + }, + "serviceCandidate": { + "type": "array", + "description": "List of service candidates associated with this category", + "items": { + "$ref": "../Service/ServiceCandidateRef.schema.json#ServiceCandidateRef" + } + }, + "category": { + "type": "array", + "description": "List of child categories in the tree for in this category", + "items": { + "$ref": "../Service/ServiceCategoryRef.schema.json#ServiceCategoryRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceCategoryRef.schema.json b/Service/ServiceCategoryRef.schema.json index a65b6bf8..e2d94060 100644 --- a/Service/ServiceCategoryRef.schema.json +++ b/Service/ServiceCategoryRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceCategoryRef.schema.json", - "title": "ServiceCategoryRef", - "definitions": { - "ServiceCategoryRef": { - "$id": "#ServiceCategoryRef", - "description": "The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Hypertext Reference of the category" - }, - "id": { - "type": "string", - "description": "Unique identifier of category" - }, - "name": { - "type": "string", - "description": "Name of the category." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceCategoryRef.schema.json", + "title": "ServiceCategoryRef", + "definitions": { + "ServiceCategoryRef": { + "$id": "#ServiceCategoryRef", + "description": "The (service) category resource is used to group service candidates in logical containers. Categories can contain other categories.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Hypertext Reference of the category" + }, + "id": { + "type": "string", + "description": "Unique identifier of category" + }, + "name": { + "type": "string", + "description": "Name of the category." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceCharacteristic.schema.json b/Service/ServiceCharacteristic.schema.json index 2818577f..04d71675 100644 --- a/Service/ServiceCharacteristic.schema.json +++ b/Service/ServiceCharacteristic.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceCharacteristic.schema.json", - "title": "ServiceCharacteristic", - "definitions": { - "ServiceCharacteristic": { - "$id": "#ServiceCharacteristic", - "description": "is a list of name value pairs that define the service characteristics", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the characteristic" - }, - "valueType": { - "type": "string", - "description": "Data type of the characteristic" - }, - "value": { - "description": "Actual value of the characteristio", - "$ref": "../Common/Value.schema.json#Value" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceCharacteristic.schema.json", + "title": "ServiceCharacteristic", + "definitions": { + "ServiceCharacteristic": { + "$id": "#ServiceCharacteristic", + "description": "is a list of name value pairs that define the service characteristics", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the characteristic" + }, + "valueType": { + "type": "string", + "description": "Data type of the characteristic" + }, + "value": { + "description": "Actual value of the characteristio", + "$ref": "../Common/Value.schema.json#Value" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceEligibilityUnavailabilityReason.schema.json b/Service/ServiceEligibilityUnavailabilityReason.schema.json index 10238d22..3959f4cb 100644 --- a/Service/ServiceEligibilityUnavailabilityReason.schema.json +++ b/Service/ServiceEligibilityUnavailabilityReason.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceEligibilityUnavailabilityReason.schema.json", - "title": "ServiceEligibilityUnavailabilityReason", - "definitions": { - "ServiceEligibilityUnavailabilityReason": { - "$id": "#ServiceEligibilityUnavailabilityReason", - "description": "Reason for eligibility result if the ServiceQualification result is no (meaning the Service is not available)", - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Unavailability reason code" - }, - "label": { - "type": "string", - "description": "Unavailability reason label" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceEligibilityUnavailabilityReason.schema.json", + "title": "ServiceEligibilityUnavailabilityReason", + "definitions": { + "ServiceEligibilityUnavailabilityReason": { + "$id": "#ServiceEligibilityUnavailabilityReason", + "description": "Reason for eligibility result if the ServiceQualification result is no (meaning the Service is not available)", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Unavailability reason code" + }, + "label": { + "type": "string", + "description": "Unavailability reason label" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceLevelObjective.schema.json b/Service/ServiceLevelObjective.schema.json index d306f02f..b8e15398 100644 --- a/Service/ServiceLevelObjective.schema.json +++ b/Service/ServiceLevelObjective.schema.json @@ -1,74 +1,74 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceLevelObjective.schema.json", - "title": "ServiceLevelObjective", - "definitions": { - "ServiceLevelObjective": { - "$id": "#ServiceLevelObjective", - "description": "Service level objectives are defined in terms of parameters and metrics, thresholds, and tolerances \nassociated with the parameters.", - "type": "object", - "properties": { - "conformanceComparator": { - "type": "string", - "description": "An operator that specifies whether a Service Level Objective is \nviolated above or below the conformanceTarget." - }, - "conformancePeriod": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "An interval of time during which the Conformance Target must be measured." - }, - "conformanceTarget": { - "type": "string", - "description": "A value used to determine if Service Level Objective is met. \nThe data type should be adjusted case by case." - }, - "graceTimes": { - "type": "string", - "description": "The number of times an objective can remain un-updated without \na violation of a Service Level Agreement in reference to a measurement period and/or Service Level Agreement reporting period." - }, - "href": { - "type": "string", - "description": "The hyperlink to access a service level objective." - }, - "id": { - "type": "string", - "description": "The identifier of a service level objectives." - }, - "name": { - "type": "string", - "description": "The name of the service level objectives." - }, - "thresholdTarget": { - "type": "string", - "description": "A value that used to specify when a warning should be used \nthat indicates an objective is danger of not being met. Notice, the data type should be adjusted case by case." - }, - "tolerancePeriod": { - "description": "A value that specifies the allowable time variation of a conformance", - "$ref": "../Common/TimePeriod.schema.json#TimePeriod" - }, - "toleranceTarget": { - "type": "string", - "description": "A value that specifies the allowable variation of a conformance \nTarget. The data type should be adjusted case by case." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "A valid duration of a thing." - }, - "serviceLevelSpecParameter": { - "description": "A parameter for this objective", - "$ref": "ServiceLevelSpecParameter.schema.json#ServiceLevelSpecParameter" - }, - "serviceLevelSpecConsequence": { - "type": "array", - "description": "A list of consequences for this objective.", - "items": { - "$ref": "ServiceLevelSpecConsequence.schema.json#ServiceLevelSpecConsequence" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceLevelObjective.schema.json", + "title": "ServiceLevelObjective", + "definitions": { + "ServiceLevelObjective": { + "$id": "#ServiceLevelObjective", + "description": "Service level objectives are defined in terms of parameters and metrics, thresholds, and tolerances \nassociated with the parameters.", + "type": "object", + "properties": { + "conformanceComparator": { + "type": "string", + "description": "An operator that specifies whether a Service Level Objective is \nviolated above or below the conformanceTarget." + }, + "conformancePeriod": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "An interval of time during which the Conformance Target must be measured." + }, + "conformanceTarget": { + "type": "string", + "description": "A value used to determine if Service Level Objective is met. \nThe data type should be adjusted case by case." + }, + "graceTimes": { + "type": "string", + "description": "The number of times an objective can remain un-updated without \na violation of a Service Level Agreement in reference to a measurement period and/or Service Level Agreement reporting period." + }, + "href": { + "type": "string", + "description": "The hyperlink to access a service level objective." + }, + "id": { + "type": "string", + "description": "The identifier of a service level objectives." + }, + "name": { + "type": "string", + "description": "The name of the service level objectives." + }, + "thresholdTarget": { + "type": "string", + "description": "A value that used to specify when a warning should be used \nthat indicates an objective is danger of not being met. Notice, the data type should be adjusted case by case." + }, + "tolerancePeriod": { + "description": "A value that specifies the allowable time variation of a conformance", + "$ref": "../Common/TimePeriod.schema.json#TimePeriod" + }, + "toleranceTarget": { + "type": "string", + "description": "A value that specifies the allowable variation of a conformance \nTarget. The data type should be adjusted case by case." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "A valid duration of a thing." + }, + "serviceLevelSpecParameter": { + "description": "A parameter for this objective", + "$ref": "../Service/ServiceLevelSpecParameter.schema.json#ServiceLevelSpecParameter" + }, + "serviceLevelSpecConsequence": { + "type": "array", + "description": "A list of consequences for this objective.", + "items": { + "$ref": "../Service/ServiceLevelSpecConsequence.schema.json#ServiceLevelSpecConsequence" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceLevelObjectiveRef.schema.json b/Service/ServiceLevelObjectiveRef.schema.json index a58dc627..6dbd9d0d 100644 --- a/Service/ServiceLevelObjectiveRef.schema.json +++ b/Service/ServiceLevelObjectiveRef.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceLevelObjectiveRef.schema.json", - "title": "ServiceLevelObjectiveRef", - "definitions": { - "ServiceLevelObjectiveRef": { - "$id": "#ServiceLevelObjectiveRef", - "description": "A set of Service Level Objectives that are contained in the Service Level Specification.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The hyperlink to access a service level object." - }, - "id": { - "type": "string", - "description": "The identifier of a service level object." - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceLevelObjectiveRef.schema.json", + "title": "ServiceLevelObjectiveRef", + "definitions": { + "ServiceLevelObjectiveRef": { + "$id": "#ServiceLevelObjectiveRef", + "description": "A set of Service Level Objectives that are contained in the Service Level Specification.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The hyperlink to access a service level object." + }, + "id": { + "type": "string", + "description": "The identifier of a service level object." + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceLevelSpecConsequence.schema.json b/Service/ServiceLevelSpecConsequence.schema.json index 6fb476f7..94316ce9 100644 --- a/Service/ServiceLevelSpecConsequence.schema.json +++ b/Service/ServiceLevelSpecConsequence.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceLevelSpecConsequence.schema.json", - "title": "ServiceLevelSpecConsequence", - "definitions": { - "ServiceLevelSpecConsequence": { - "$id": "#ServiceLevelSpecConsequence", - "description": "Some consequences for the provider of the Service are resulted when the service level objective\ndoes not meet.", - "type": "object", - "properties": { - "prescribedAction": { - "type": "string", - "description": "Recommended remedy for a violated Service Level Objective. \nThis could be a hyperlink to the recommended action." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "A valid duration of a thing." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceLevelSpecConsequence.schema.json", + "title": "ServiceLevelSpecConsequence", + "definitions": { + "ServiceLevelSpecConsequence": { + "$id": "#ServiceLevelSpecConsequence", + "description": "Some consequences for the provider of the Service are resulted when the service level objective\ndoes not meet.", + "type": "object", + "properties": { + "prescribedAction": { + "type": "string", + "description": "Recommended remedy for a violated Service Level Objective. \nThis could be a hyperlink to the recommended action." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "A valid duration of a thing." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceLevelSpecParameter.schema.json b/Service/ServiceLevelSpecParameter.schema.json index b10b7a02..bc870f72 100644 --- a/Service/ServiceLevelSpecParameter.schema.json +++ b/Service/ServiceLevelSpecParameter.schema.json @@ -1,50 +1,50 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceLevelSpecParameter.schema.json", - "title": "ServiceLevelSpecParameter", - "definitions": { - "ServiceLevelSpecParameter": { - "$id": "#ServiceLevelSpecParameter", - "description": "Service Level Specification parameters can be one of two types. A Key Quality Indicator (KQI) \nprovides a measurement of a specific aspect of the performance of a Product (i.e., Product \nSpecification, Product Offering, or Product) or a Service (i.e., Service Specification or Service).", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the parameter" - }, - "serviceParmCategory": { - "type": "string", - "description": "A string that specifies whether the Service Level Specification Parameter is technology specific, service specific, or technology/service independent" - }, - "serviceParmPerspective": { - "type": "string", - "description": "A string that specifies whether the Service Level Specification Parameter represents a single user instance parameter or a parameter that represents an aggregation" - }, - "transformationAlgorithmOfKQI": { - "type": "string", - "description": "The description of a logical step-by-step procedure used to calculate the value of a KQI" - }, - "parameterType": { - "type": "string", - "description": "Types of Service Level Specification parameters are KQI or KPI" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "A valid duration of a thing" - }, - "relatedEntity": { - "type": "array", - "description": "A list of entities related to this parameter", - "items": { - "$ref": "../Common/RelatedEntityRef.schema.json#RelatedEntityRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceLevelSpecParameter.schema.json", + "title": "ServiceLevelSpecParameter", + "definitions": { + "ServiceLevelSpecParameter": { + "$id": "#ServiceLevelSpecParameter", + "description": "Service Level Specification parameters can be one of two types. A Key Quality Indicator (KQI) \nprovides a measurement of a specific aspect of the performance of a Product (i.e., Product \nSpecification, Product Offering, or Product) or a Service (i.e., Service Specification or Service).", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the parameter" + }, + "serviceParmCategory": { + "type": "string", + "description": "A string that specifies whether the Service Level Specification Parameter is technology specific, service specific, or technology/service independent" + }, + "serviceParmPerspective": { + "type": "string", + "description": "A string that specifies whether the Service Level Specification Parameter represents a single user instance parameter or a parameter that represents an aggregation" + }, + "transformationAlgorithmOfKQI": { + "type": "string", + "description": "The description of a logical step-by-step procedure used to calculate the value of a KQI" + }, + "parameterType": { + "type": "string", + "description": "Types of Service Level Specification parameters are KQI or KPI" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "A valid duration of a thing" + }, + "relatedEntity": { + "type": "array", + "description": "A list of entities related to this parameter", + "items": { + "$ref": "../Common/RelatedEntityRef.schema.json#RelatedEntityRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceLevelSpecification.schema.json b/Service/ServiceLevelSpecification.schema.json index f65e434e..8891da7d 100644 --- a/Service/ServiceLevelSpecification.schema.json +++ b/Service/ServiceLevelSpecification.schema.json @@ -1,46 +1,46 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceLevelSpecification.schema.json", - "title": "ServiceLevelSpecification", - "definitions": { - "ServiceLevelSpecification": { - "$id": "#ServiceLevelSpecification", - "description": "A Service Level Specification represents a pre-defined or negotiated set of Service Level \nObjectives. In addition, certain consequences are associated with not meeting the Service Level \nObjectives. Service Level Agreements are expressed in terms of Service Level Specifications.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "A brief introduction of a service level specification." - }, - "href": { - "type": "string", - "description": "The hyperlink to access a service level specification." - }, - "id": { - "type": "string", - "description": "The identifier to a service level specification." - }, - "name": { - "type": "string", - "description": "The name of Service Level Specification" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "A valid duration of a thing." - }, - "relatedServiceLevelObjective": { - "type": "array", - "description": "A list of objectives related to this service level specification", - "items": { - "$ref": "ServiceLevelObjectiveRef.schema.json#ServiceLevelObjectiveRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceLevelSpecification.schema.json", + "title": "ServiceLevelSpecification", + "definitions": { + "ServiceLevelSpecification": { + "$id": "#ServiceLevelSpecification", + "description": "A Service Level Specification represents a pre-defined or negotiated set of Service Level \nObjectives. In addition, certain consequences are associated with not meeting the Service Level \nObjectives. Service Level Agreements are expressed in terms of Service Level Specifications.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A brief introduction of a service level specification." + }, + "href": { + "type": "string", + "description": "The hyperlink to access a service level specification." + }, + "id": { + "type": "string", + "description": "The identifier to a service level specification." + }, + "name": { + "type": "string", + "description": "The name of Service Level Specification" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "A valid duration of a thing." + }, + "relatedServiceLevelObjective": { + "type": "array", + "description": "A list of objectives related to this service level specification", + "items": { + "$ref": "../Service/ServiceLevelObjectiveRef.schema.json#ServiceLevelObjectiveRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceLevelSpecificationRef.schema.json b/Service/ServiceLevelSpecificationRef.schema.json index 3e139193..bcfbd1c2 100755 --- a/Service/ServiceLevelSpecificationRef.schema.json +++ b/Service/ServiceLevelSpecificationRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceLevelSpecificationRef.schema.json", - "title": "ServiceLevelSpecificationRef", - "definitions": { - "ServiceLevelSpecificationRef": { - "$id": "#ServiceLevelSpecificationRef", - "description": "A Service Level Specification represents a pre-defined or negotiated set of Service Level \nObjectives. In addition, certain consequences are associated with not meeting the Service Level \nObjectives. Service Level Agreements are expressed in terms of Service Level Specifications.", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The hyperlink to access a service level specification." - }, - "id": { - "type": "string", - "description": "The identifier to a service level specification." - }, - "name": { - "type": "string", - "description": "The name of Service Level Specification" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceLevelSpecificationRef.schema.json", + "title": "ServiceLevelSpecificationRef", + "definitions": { + "ServiceLevelSpecificationRef": { + "$id": "#ServiceLevelSpecificationRef", + "description": "A Service Level Specification represents a pre-defined or negotiated set of Service Level \nObjectives. In addition, certain consequences are associated with not meeting the Service Level \nObjectives. Service Level Agreements are expressed in terms of Service Level Specifications.", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The hyperlink to access a service level specification." + }, + "id": { + "type": "string", + "description": "The identifier to a service level specification." + }, + "name": { + "type": "string", + "description": "The name of Service Level Specification" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceOfferingQualificationRef.schema.json b/Service/ServiceOfferingQualificationRef.schema.json index 768bd079..e6c569ce 100644 --- a/Service/ServiceOfferingQualificationRef.schema.json +++ b/Service/ServiceOfferingQualificationRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOfferingQualificationRef.schema.json", - "title": "ServiceOfferingQualificationRef", - "definitions": { - "ServiceOfferingQualificationRef": { - "$id": "#ServiceOfferingQualificationRef", - "description": "It could be a serviceQualification or a productOfferingQualification that has been executed previously and captured in the productOrder to provide eligibility information", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "href of the qualification" - }, - "id": { - "type": "string", - "description": "Identifier of a pre-existing qualification" - }, - "qualificationItemId": { - "type": "string", - "description": "Id of an item of a qualification" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation" - } - }, - "allOf": [ - { - "$ref": "../Common/QualificationRef.schema.json#QualificationRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOfferingQualificationRef.schema.json", + "title": "ServiceOfferingQualificationRef", + "definitions": { + "ServiceOfferingQualificationRef": { + "$id": "#ServiceOfferingQualificationRef", + "description": "It could be a serviceQualification or a productOfferingQualification that has been executed previously and captured in the productOrder to provide eligibility information", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "href of the qualification" + }, + "id": { + "type": "string", + "description": "Identifier of a pre-existing qualification" + }, + "qualificationItemId": { + "type": "string", + "description": "Id of an item of a qualification" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation" } + }, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceOrder.schema.json b/Service/ServiceOrder.schema.json index 3ab0e119..2b84026d 100644 --- a/Service/ServiceOrder.schema.json +++ b/Service/ServiceOrder.schema.json @@ -1,108 +1,108 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrder.schema.json", - "title": "ServiceOrder", - "definitions": { - "ServiceOrder": { - "$id": "#ServiceOrder", - "type": "object", - "properties": { - "category": { - "type": "string", - "description": "Used to categorize the order, useful for the OM system, such as: Broadband, TVOption" - }, - "completionDate": { - "type": "string", - "format": "date-time", - "description": "Effective delivery date amended by the provider" - }, - "description": { - "type": "string", - "description": "A free-text description of the service order" - }, - "expectedCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Expected delivery date amended by the provider" - }, - "externalId": { - "type": "string", - "description": "ID given by the consumer to facilitate searches" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the order" - }, - "id": { - "type": "string", - "description": "ID created on repository side" - }, - "note": { - "type": "array", - "description": "Extra-information about the order; e.g. useful to add extra delivery information that could be useful for a human process", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "notificationContact": { - "type": "string", - "description": "Contact attached to the order to send back information regarding this order" - }, - "orderDate": { - "type": "string", - "format": "date-time" - }, - "orderItem": { - "type": "array", - "minItems": 1, - "description": "A list of service order items to be processed by this order", - "items": { - "$ref": "ServiceOrderItem.schema.json#ServiceOrderItem" - } - }, - "orderRelationship": { - "type": "array", - "description": "A list of service orders related to this order (e.g. prerequisite, dependent on)", - "items": { - "$ref": "ServiceOrderRelationship.schema.json#ServiceOrderRelationship" - } - }, - "priority": { - "type": "string", - "description": "Can be used by consumers to prioritize orders in a Service Order Management system" - }, - "relatedParty": { - "type": "array", - "description": "A list of parties which are involved in this order and the role they are playing", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "requestedCompletionDate": { - "type": "string", - "format": "date-time", - "description": "Requested delivery date from the requestors perspective" - }, - "requestedStartDate": { - "type": "string", - "format": "date-time", - "description": "Order start date wished by the requestor" - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "Date when the order was started for processing" - }, - "state": { - "description": "State of the order: described in the state-machine diagram", - "$ref": "ServiceOrderStateType.schema.json#ServiceOrderStateType" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrder.schema.json", + "title": "ServiceOrder", + "definitions": { + "ServiceOrder": { + "$id": "#ServiceOrder", + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Used to categorize the order, useful for the OM system, such as: Broadband, TVOption" + }, + "completionDate": { + "type": "string", + "format": "date-time", + "description": "Effective delivery date amended by the provider" + }, + "description": { + "type": "string", + "description": "A free-text description of the service order" + }, + "expectedCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Expected delivery date amended by the provider" + }, + "externalId": { + "type": "string", + "description": "ID given by the consumer to facilitate searches" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the order" + }, + "id": { + "type": "string", + "description": "ID created on repository side" + }, + "note": { + "type": "array", + "description": "Extra-information about the order; e.g. useful to add extra delivery information that could be useful for a human process", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "notificationContact": { + "type": "string", + "description": "Contact attached to the order to send back information regarding this order" + }, + "orderDate": { + "type": "string", + "format": "date-time" + }, + "orderItem": { + "type": "array", + "minItems": 1, + "description": "A list of service order items to be processed by this order", + "items": { + "$ref": "../Service/ServiceOrderItem.schema.json#ServiceOrderItem" + } + }, + "orderRelationship": { + "type": "array", + "description": "A list of service orders related to this order (e.g. prerequisite, dependent on)", + "items": { + "$ref": "../Service/ServiceOrderRelationship.schema.json#ServiceOrderRelationship" + } + }, + "priority": { + "type": "string", + "description": "Can be used by consumers to prioritize orders in a Service Order Management system" + }, + "relatedParty": { + "type": "array", + "description": "A list of parties which are involved in this order and the role they are playing", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "requestedCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Requested delivery date from the requestors perspective" + }, + "requestedStartDate": { + "type": "string", + "format": "date-time", + "description": "Order start date wished by the requestor" + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "Date when the order was started for processing" + }, + "state": { + "description": "State of the order: described in the state-machine diagram", + "$ref": "../Service/ServiceOrderStateType.schema.json#ServiceOrderStateType" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceOrderActionType.schema.json b/Service/ServiceOrderActionType.schema.json index eeaf91dd..7d49a693 100644 --- a/Service/ServiceOrderActionType.schema.json +++ b/Service/ServiceOrderActionType.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrderActionType.schema.json", - "title": "ServiceOrderActionType", - "definitions": { - "ServiceOrderActionType": { - "$id": "#ServiceOrderActionType", - "description": "string", - "type": "string", - "enum": [ - "add", - "modify", - "delete", - "noChange" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrderActionType.schema.json", + "title": "ServiceOrderActionType", + "definitions": { + "ServiceOrderActionType": { + "$id": "#ServiceOrderActionType", + "description": "string", + "type": "string", + "enum": [ + "add", + "modify", + "delete", + "noChange" + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceOrderItem.schema.json b/Service/ServiceOrderItem.schema.json index c22e232b..e78fcf21 100644 --- a/Service/ServiceOrderItem.schema.json +++ b/Service/ServiceOrderItem.schema.json @@ -1,49 +1,49 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrderItem.schema.json", - "title": "ServiceOrderItem", - "definitions": { - "ServiceOrderItem": { - "$id": "#ServiceOrderItem", - "type": "object", - "required": [ - "id", - "action" - ], - "properties": { - "id": { - "type": "string", - "description": "Identifier of the individual line item" - }, - "action": { - "description": "The action to be carried out on the Service. Can be: add, modify, delete, noChange", - "$ref": "ServiceOrderActionType.schema.json#ServiceOrderActionType" - }, - "state": { - "description": "State of the order item: described in the state machine diagram. This is the requested state.", - "$ref": "ServiceOrderStateType.schema.json#ServiceOrderStateType" - }, - "service": { - "description": "The Service to be acted on by the order item", - "$ref": "BaseService.schema.json#BaseService" - }, - "appointment": { - "description": "An appointment that was set up with a related party for this order item", - "$ref": "../Customer/AppointmentRef.schema.json#AppointmentRef" - }, - "serviceOrderItemRelationship": { - "type": "array", - "description": "A list of order items related to this order item", - "items": { - "$ref": "../Customer/OrderItemRelationship.schema.json#OrderItemRelationship" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrderItem.schema.json", + "title": "ServiceOrderItem", + "definitions": { + "ServiceOrderItem": { + "$id": "#ServiceOrderItem", + "type": "object", + "required": [ + "id", + "action" + ], + "properties": { + "id": { + "type": "string", + "description": "Identifier of the individual line item" + }, + "action": { + "description": "The action to be carried out on the Service. Can be: add, modify, delete, noChange", + "$ref": "../Service/ServiceOrderActionType.schema.json#ServiceOrderActionType" + }, + "state": { + "description": "State of the order item: described in the state machine diagram. This is the requested state.", + "$ref": "../Service/ServiceOrderStateType.schema.json#ServiceOrderStateType" + }, + "service": { + "description": "The Service to be acted on by the order item", + "$ref": "../Service/BaseService.schema.json#BaseService" + }, + "appointment": { + "description": "An appointment that was set up with a related party for this order item", + "$ref": "../Customer/AppointmentRef.schema.json#AppointmentRef" + }, + "serviceOrderItemRelationship": { + "type": "array", + "description": "A list of order items related to this order item", + "items": { + "$ref": "../Customer/OrderItemRelationship.schema.json#OrderItemRelationship" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceOrderItemRelationship.schema.json b/Service/ServiceOrderItemRelationship.schema.json index 8ab0447e..451b14f2 100644 --- a/Service/ServiceOrderItemRelationship.schema.json +++ b/Service/ServiceOrderItemRelationship.schema.json @@ -1,31 +1,31 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrderItemRelationship.schema.json", - "title": "ServiceOrderItemRelationship", - "definitions": { - "ServiceOrderItemRelationship": { - "$id": "#ServiceOrderItemRelationship", - "type": "object", - "description": "Linked service order item to the one containing this attribute", - "required": [ - "id", - "relationshipType" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of a service order item" - }, - "relationshipType": { - "type": "string", - "description": "The type of related order item, can be: dependency if the order item needs to be not started until another order item is complete" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrderItemRelationship.schema.json", + "title": "ServiceOrderItemRelationship", + "definitions": { + "ServiceOrderItemRelationship": { + "$id": "#ServiceOrderItemRelationship", + "type": "object", + "description": "Linked service order item to the one containing this attribute", + "required": [ + "id", + "relationshipType" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of a service order item" + }, + "relationshipType": { + "type": "string", + "description": "The type of related order item, can be: dependency if the order item needs to be not started until another order item is complete" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceOrderRef.schema.json b/Service/ServiceOrderRef.schema.json index de31add9..c69e0168 100644 --- a/Service/ServiceOrderRef.schema.json +++ b/Service/ServiceOrderRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrderRef.schema.json", - "title": "ServiceOrderRef", - "definitions": { - "ServiceOrderRef": { - "$id": "#ServiceOrderRef", - "description": "Service Order reference. Useful to understand the which was the Service order through which the service was instantiated in the service inventory", - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Reference of the Service Order" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Service Order" - }, - "serviceOrderItemId": { - "type": "string", - "description": "Unique identifier of the Service Order Item within a service order, not populated if this is a reference to a service order" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrderRef.schema.json", + "title": "ServiceOrderRef", + "definitions": { + "ServiceOrderRef": { + "$id": "#ServiceOrderRef", + "description": "Service Order reference. Useful to understand the which was the Service order through which the service was instantiated in the service inventory", + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "Reference of the Service Order" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Service Order" + }, + "serviceOrderItemId": { + "type": "string", + "description": "Unique identifier of the Service Order Item within a service order, not populated if this is a reference to a service order" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceOrderRelationship.schema.json b/Service/ServiceOrderRelationship.schema.json index 74299712..ae77e76a 100644 --- a/Service/ServiceOrderRelationship.schema.json +++ b/Service/ServiceOrderRelationship.schema.json @@ -1,38 +1,38 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrderRelationship.schema.json", - "title": "ServiceOrderRelationship", - "definitions": { - "ServiceOrderRelationship": { - "$id": "#ServiceOrderRelationship", - "type": "object", - "description": "Linked service order to the one containing this attribute", - "required": [ - "id" - ], - "properties": { - "@referredType": { - "type": "string", - "description": "The entity type of the related order" - }, - "href": { - "type": "string", - "description": "A hyperlink to the related order" - }, - "id": { - "type": "string", - "description": "The id of the related order" - }, - "relationshipType": { - "type": "string", - "description": "The type of related order, such as: [dependency] if the order needs to be [not started] until another order item is complete (a service order in this case) or [cross-ref] to keep track of the source order (a productOrder)" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrderRelationship.schema.json", + "title": "ServiceOrderRelationship", + "definitions": { + "ServiceOrderRelationship": { + "$id": "#ServiceOrderRelationship", + "type": "object", + "description": "Linked service order to the one containing this attribute", + "required": [ + "id" + ], + "properties": { + "@referredType": { + "type": "string", + "description": "The entity type of the related order" + }, + "href": { + "type": "string", + "description": "A hyperlink to the related order" + }, + "id": { + "type": "string", + "description": "The id of the related order" + }, + "relationshipType": { + "type": "string", + "description": "The type of related order, such as: [dependency] if the order needs to be [not started] until another order item is complete (a service order in this case) or [cross-ref] to keep track of the source order (a productOrder)" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceOrderStateType.schema.json b/Service/ServiceOrderStateType.schema.json index a0f4ac55..f8a06c47 100644 --- a/Service/ServiceOrderStateType.schema.json +++ b/Service/ServiceOrderStateType.schema.json @@ -1,23 +1,23 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceOrderStateType.schema.json", - "title": "ServiceOrderStateType", - "definitions": { - "ServiceOrderStateType": { - "$id": "#ServiceOrderStateType", - "type": "string", - "description": "Possible values for the state of the order", - "enum": [ - "acknowledged", - "rejected", - "pending", - "held", - "inProgress", - "cancelled", - "completed", - "failed", - "partial" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceOrderStateType.schema.json", + "title": "ServiceOrderStateType", + "definitions": { + "ServiceOrderStateType": { + "$id": "#ServiceOrderStateType", + "type": "string", + "description": "Possible values for the state of the order", + "enum": [ + "acknowledged", + "rejected", + "pending", + "held", + "inProgress", + "cancelled", + "completed", + "failed", + "partial" + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceProblem.schema.json b/Service/ServiceProblem.schema.json index 5e2c7bf8..377cf39a 100644 --- a/Service/ServiceProblem.schema.json +++ b/Service/ServiceProblem.schema.json @@ -1,219 +1,219 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceProblem.schema.json", - "title": "ServiceProblem", - "definitions": { - "ServiceProblem": { - "$id": "#ServiceProblem", - "type": "object", - "description": "The problem information for Middle B which is abstracted in the service layer from the issued event information by First B", - "properties": { - "affectedLocation": { - "type": "array", - "description": "A list of the locations affected by the problem. At least one of affectedResource, affectedService or affectedLocation should be present.", - "items": { - "$ref": "../Common/Place.schema.json#Place" - } - }, - "affectedNumberOfServices": { - "type": "integer", - "description": "Number of affected services" - }, - "affectedResource": { - "type": "array", - "description": "A list of the resources affected by the problem. At least one of affectedResource, affectedService or affectedLocation should be present.", - "items": { - "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" - } - }, - "affectedService": { - "type": "array", - "description": "List of affected services. At least one of affectedResource, affectedService or affectedLocation should be present.", - "items": { - "$ref": "ServiceRef.schema.json#ServiceRef" - } - }, - "category": { - "type": "string", - "description": "Classifier for the problem. Settable. For example, this is used for distinguish the category of problem originator in [role].[category] format. Example: serviceProvider.declarer, supplier.originated, system.originated" - }, - "comment": { - "type": "array", - "description": "A list of comments or notes made on the problem", - "items": { - "$ref": "../Common/Note.schema.json#Note" - } - }, - "correlationId": { - "type": "string", - "description": "Additional identifier coming from an external system" - }, - "description": { - "type": "string", - "description": "Free form text describing the Service Problem" - }, - "extensionInfo": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - }, - "description": "A generic list of any type of elements. Used for vendor Extensions or loose element encapsulation from other namespaces" - }, - "firstAlert": { - "description": "Indicates what first alerted the system to the problem. It is not the root cause of the Service Problem. Examples: Threshold crossing alert", - "$ref": "../Common/RelatedEntityRef.schema.json#RelatedEntityRef" - }, - "href": { - "type": "string", - "description": "Reference to the Service Problem" - }, - "id": { - "type": "string", - "description": "Identifier of the service problem" - }, - "impactImportanceFactor": { - "type": "string", - "description": "Impact Importance is characterized by an Impact Importance Factor: overall importance of the impact of all the affected services, e.g. 0 (zero impact) to 100 (worst impact). The Impact Importance is a calculated field which is set by the OSS determining the impact." - }, - "impactPatterns": { - "description": "Define the patterns of impact (optional)- e.g. other service characteristics- Used when defining impact through another pattern than the predefined attributes.", - "$ref": "ImpactPattern.schema.json#ImpactPattern" - }, - "originatingSystem": { - "type": "string", - "description": "Indicates where the problem was generated" - }, - "parentProblem": { - "type": "array", - "description": "The parent problem to which this problem is attached.", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - }, - "priority": { - "type": "integer", - "description": "An indication varying from 1 (highest) to 10 (lowest) of how important it is for the service provider to correct the Service Problem." - }, - "problemEscalation": { - "type": "string", - "description": "Indicates if this service problem has been escalated or not. Possible values are 0 to 10. A value of zero means no escalation. The meanings of values 1-10 are to be determined by the user of the interface, but they show increasing levels of escalation." - }, - "reason": { - "type": "string", - "description": "Free text or optionally structured text. It can be Unknown." - }, - "relatedEvent": { - "type": "array", - "description": "List of events associated to this problem", - "items": { - "$ref": "../Common/EventRef.schema.json#EventRef" - } - }, - "relatedObject": { - "type": "array", - "description": "List of objects associated to this problem", - "items": { - "$ref": "../Common/RelatedEntityRef.schema.json#RelatedEntityRef" - } - }, - "originatorParty": { - "description": "Individual or organization that created the problem", - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "responsibleParty": { - "description": "Individual or organization responsible for handling this problem", - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - }, - "relatedParty": { - "type": "array", - "description": "List of parties or party roles playing a role within the service problem", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "rootCauseResource": { - "type": "array", - "description": "Resource(s) that are associated to the underlying service problems that are the Root Cause of this one if any (used only if applicable).", - "items": { - "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" - } - }, - "rootCauseService": { - "type": "array", - "description": "Service(s) that are associated to the underlying service problems that are the Root Cause of this one if any (used only if applicable)", - "items": { - "$ref": "ServiceRef.schema.json#ServiceRef" - } - }, - "resolutionDate": { - "type": "string", - "format": "date-time", - "description": "Time the problem was resolved" - }, - "status": { - "type": "string", - "description": "The current status of the service problem. Possible values are Submitted, Rejected, Acknowledged, In Progress [Held, Pending], Resolved, Closed, and Cancelled." - }, - "statusChangeDate": { - "type": "string", - "format": "date-time", - "description": "Time the problem was last status changed" - }, - "statusChangeReason": { - "type": "string", - "description": "The reason of state change" - }, - "timeChanged": { - "type": "string", - "format": "date-time", - "description": "Time the problem was last changed" - }, - "timeRaised": { - "type": "string", - "format": "date-time", - "description": "Time the problem was raised" - }, - "trackingRecord": { - "type": "array", - "description": "List of tracking records that allow the tracking of modifications on the problem.The tracking records should not be embedded in the problem to allow retrieving the problem without the tracking records", - "items": { - "$ref": "TrackingRecord.schema.json#TrackingRecord" - } - }, - "underlyingAlarm": { - "type": "array", - "description": "A list of alarms underlying this problem.", - "items": { - "$ref": "../Resource/ResourceAlarmRef.schema.json#ResourceAlarmRef" - } - }, - "associatedSLAViolation": { - "type": "array", - "description": "A List of SLA violations associated with this problem.", - "items": { - "$ref": "../EngagedParty/SLAViolationRef.schema.json#SLAViolationRef" - } - }, - "associatedTroubleTicket": { - "type": "array", - "description": "A list of trouble tickets associated with this problem.", - "items": { - "$ref": "../Common/TroubleTicketRef.schema.json#TroubleTicketRef" - } - }, - "underlyingProblem": { - "type": "array", - "description": "A list of underlying problems. Relevant only if this problem is derived from other problems.", - "items": { - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceProblem.schema.json", + "title": "ServiceProblem", + "definitions": { + "ServiceProblem": { + "$id": "#ServiceProblem", + "type": "object", + "description": "The problem information for Middle B which is abstracted in the service layer from the issued event information by First B", + "properties": { + "affectedLocation": { + "type": "array", + "description": "A list of the locations affected by the problem. At least one of affectedResource, affectedService or affectedLocation should be present.", + "items": { + "$ref": "../Common/Place.schema.json#Place" + } + }, + "affectedNumberOfServices": { + "type": "integer", + "description": "Number of affected services" + }, + "affectedResource": { + "type": "array", + "description": "A list of the resources affected by the problem. At least one of affectedResource, affectedService or affectedLocation should be present.", + "items": { + "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" + } + }, + "affectedService": { + "type": "array", + "description": "List of affected services. At least one of affectedResource, affectedService or affectedLocation should be present.", + "items": { + "$ref": "../Service/ServiceRef.schema.json#ServiceRef" + } + }, + "category": { + "type": "string", + "description": "Classifier for the problem. Settable. For example, this is used for distinguish the category of problem originator in [role].[category] format. Example: serviceProvider.declarer, supplier.originated, system.originated" + }, + "comment": { + "type": "array", + "description": "A list of comments or notes made on the problem", + "items": { + "$ref": "../Common/Note.schema.json#Note" + } + }, + "correlationId": { + "type": "string", + "description": "Additional identifier coming from an external system" + }, + "description": { + "type": "string", + "description": "Free form text describing the Service Problem" + }, + "extensionInfo": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + }, + "description": "A generic list of any type of elements. Used for vendor Extensions or loose element encapsulation from other namespaces" + }, + "firstAlert": { + "description": "Indicates what first alerted the system to the problem. It is not the root cause of the Service Problem. Examples: Threshold crossing alert", + "$ref": "../Common/RelatedEntityRef.schema.json#RelatedEntityRef" + }, + "href": { + "type": "string", + "description": "Reference to the Service Problem" + }, + "id": { + "type": "string", + "description": "Identifier of the service problem" + }, + "impactImportanceFactor": { + "type": "string", + "description": "Impact Importance is characterized by an Impact Importance Factor: overall importance of the impact of all the affected services, e.g. 0 (zero impact) to 100 (worst impact). The Impact Importance is a calculated field which is set by the OSS determining the impact." + }, + "impactPatterns": { + "description": "Define the patterns of impact (optional)- e.g. other service characteristics- Used when defining impact through another pattern than the predefined attributes.", + "$ref": "../Service/ImpactPattern.schema.json#ImpactPattern" + }, + "originatingSystem": { + "type": "string", + "description": "Indicates where the problem was generated" + }, + "parentProblem": { + "type": "array", + "description": "The parent problem to which this problem is attached.", + "items": { + "$ref": "../Service/ServiceProblemRef.schema.json#ServiceProblemRef" + } + }, + "priority": { + "type": "integer", + "description": "An indication varying from 1 (highest) to 10 (lowest) of how important it is for the service provider to correct the Service Problem." + }, + "problemEscalation": { + "type": "string", + "description": "Indicates if this service problem has been escalated or not. Possible values are 0 to 10. A value of zero means no escalation. The meanings of values 1-10 are to be determined by the user of the interface, but they show increasing levels of escalation." + }, + "reason": { + "type": "string", + "description": "Free text or optionally structured text. It can be Unknown." + }, + "relatedEvent": { + "type": "array", + "description": "List of events associated to this problem", + "items": { + "$ref": "../Common/EventRef.schema.json#EventRef" + } + }, + "relatedObject": { + "type": "array", + "description": "List of objects associated to this problem", + "items": { + "$ref": "../Common/RelatedEntityRef.schema.json#RelatedEntityRef" + } + }, + "originatorParty": { + "description": "Individual or organization that created the problem", + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "responsibleParty": { + "description": "Individual or organization responsible for handling this problem", + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + }, + "relatedParty": { + "type": "array", + "description": "List of parties or party roles playing a role within the service problem", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "rootCauseResource": { + "type": "array", + "description": "Resource(s) that are associated to the underlying service problems that are the Root Cause of this one if any (used only if applicable).", + "items": { + "$ref": "../Resource/ResourceRef.schema.json#ResourceRef" + } + }, + "rootCauseService": { + "type": "array", + "description": "Service(s) that are associated to the underlying service problems that are the Root Cause of this one if any (used only if applicable)", + "items": { + "$ref": "../Service/ServiceRef.schema.json#ServiceRef" + } + }, + "resolutionDate": { + "type": "string", + "format": "date-time", + "description": "Time the problem was resolved" + }, + "status": { + "type": "string", + "description": "The current status of the service problem. Possible values are Submitted, Rejected, Acknowledged, In Progress [Held, Pending], Resolved, Closed, and Cancelled." + }, + "statusChangeDate": { + "type": "string", + "format": "date-time", + "description": "Time the problem was last status changed" + }, + "statusChangeReason": { + "type": "string", + "description": "The reason of state change" + }, + "timeChanged": { + "type": "string", + "format": "date-time", + "description": "Time the problem was last changed" + }, + "timeRaised": { + "type": "string", + "format": "date-time", + "description": "Time the problem was raised" + }, + "trackingRecord": { + "type": "array", + "description": "List of tracking records that allow the tracking of modifications on the problem.The tracking records should not be embedded in the problem to allow retrieving the problem without the tracking records", + "items": { + "$ref": "../Service/TrackingRecord.schema.json#TrackingRecord" + } + }, + "underlyingAlarm": { + "type": "array", + "description": "A list of alarms underlying this problem.", + "items": { + "$ref": "../Resource/ResourceAlarmRef.schema.json#ResourceAlarmRef" + } + }, + "associatedSLAViolation": { + "type": "array", + "description": "A List of SLA violations associated with this problem.", + "items": { + "$ref": "../EngagedParty/SLAViolationRef.schema.json#SLAViolationRef" + } + }, + "associatedTroubleTicket": { + "type": "array", + "description": "A list of trouble tickets associated with this problem.", + "items": { + "$ref": "../Common/TroubleTicketRef.schema.json#TroubleTicketRef" + } + }, + "underlyingProblem": { + "type": "array", + "description": "A list of underlying problems. Relevant only if this problem is derived from other problems.", + "items": { + "$ref": "../Service/ServiceProblemRef.schema.json#ServiceProblemRef" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceProblemEventRecord.schema.json b/Service/ServiceProblemEventRecord.schema.json index f1cb5b27..c1845fa3 100644 --- a/Service/ServiceProblemEventRecord.schema.json +++ b/Service/ServiceProblemEventRecord.schema.json @@ -1,44 +1,44 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceProblemEventRecord.schema.json", - "title": "ServiceProblemEventRecord", - "definitions": { - "ServiceProblemEventRecord": { - "$id": "#ServiceProblemEventRecord", - "type": "object", - "description": "A record of an event (related to a service problem) received from another system", - "properties": { - "eventTime": { - "description": "Time at which the event occurred", - "type": "string", - "format": "date-time" - }, - "eventType": { - "description": "Type of the recorded event", - "type": "string" - }, - "href": { - "description": "reference to this resource", - "type": "string" - }, - "id": { - "description": "Identifier of the service problem event record.", - "type": "string" - }, - "recordTime": { - "description": "Time at which the record was created", - "type": "string", - "format": "date-time" - }, - "serviceProblem": { - "description": "The service problem to which this record applies", - "$ref": "ServiceProblemRef.schema.json#ServiceProblemRef" - }, - "notification": { - "description": "A notification from the possible notifications for Service Problem (such as creation, status change, information required, change)", - "$ref": "../Common/Any.schema.json#Any" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceProblemEventRecord.schema.json", + "title": "ServiceProblemEventRecord", + "definitions": { + "ServiceProblemEventRecord": { + "$id": "#ServiceProblemEventRecord", + "type": "object", + "description": "A record of an event (related to a service problem) received from another system", + "properties": { + "eventTime": { + "description": "Time at which the event occurred", + "type": "string", + "format": "date-time" + }, + "eventType": { + "description": "Type of the recorded event", + "type": "string" + }, + "href": { + "description": "reference to this resource", + "type": "string" + }, + "id": { + "description": "Identifier of the service problem event record.", + "type": "string" + }, + "recordTime": { + "description": "Time at which the record was created", + "type": "string", + "format": "date-time" + }, + "serviceProblem": { + "description": "The service problem to which this record applies", + "$ref": "../Service/ServiceProblemRef.schema.json#ServiceProblemRef" + }, + "notification": { + "description": "A notification from the possible notifications for Service Problem (such as creation, status change, information required, change)", + "$ref": "../Common/Any.schema.json#Any" } + } } -} \ No newline at end of file + } +} diff --git a/Service/ServiceProblemRef.schema.json b/Service/ServiceProblemRef.schema.json index 82d231ca..c0f8a305 100644 --- a/Service/ServiceProblemRef.schema.json +++ b/Service/ServiceProblemRef.schema.json @@ -1,34 +1,34 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceProblemRef.schema.json", - "title": "ServiceProblemRef", - "definitions": { - "ServiceProblemRef": { - "$id": "#ServiceProblemRef", - "type": "object", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "correlationId": { - "type": "string", - "description": "Additional identifier coming from an external system" - }, - "href": { - "type": "string", - "description": "Reference of the Problem" - }, - "id": { - "type": "string", - "description": "Unique identifier of the Problem" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceProblemRef.schema.json", + "title": "ServiceProblemRef", + "definitions": { + "ServiceProblemRef": { + "$id": "#ServiceProblemRef", + "type": "object", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "correlationId": { + "type": "string", + "description": "Additional identifier coming from an external system" + }, + "href": { + "type": "string", + "description": "Reference of the Problem" + }, + "id": { + "type": "string", + "description": "Unique identifier of the Problem" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceQualification.schema.json b/Service/ServiceQualification.schema.json index c4f0b66a..83a5308a 100644 --- a/Service/ServiceQualification.schema.json +++ b/Service/ServiceQualification.schema.json @@ -1,95 +1,95 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceQualification.schema.json", - "title": "ServiceQualification", - "definitions": { - "ServiceQualification": { - "$id": "#ServiceQualification", - "type": "object", - "description": "ServiceQualification is used to perform a technical eligibility. It allows to retrieve a list of services that are technically available in the context of the interaction (place, party, service characteristics, ...).", - "properties": { - "description": { - "type": "string", - "description": "Description of the serviceQualification" - }, - "effectiveQualificationDate": { - "type": "string", - "description": "Effective date to serviceQualification completion", - "format": "date-time" - }, - "estimatedResponseDate": { - "type": "string", - "description": "Date when the requester expect to provide an answer for the qualification request.", - "format": "date-time" - }, - "expectedQualificationDate": { - "type": "string", - "description": "A date (DateTime). Deadline date when the requester expected a qualification answer.", - "format": "date-time" - }, - "expirationDate": { - "type": "string", - "description": "Date when the qualification response expires", - "format": "date-time" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the serviceQualification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the serviceQualification resource" - }, - "provideAlternative": { - "type": "boolean", - "description": "When the value is TRUE means that alternative solutions should be provided" - }, - "provideOnlyAvailable": { - "type": "boolean", - "description": "When the value is TRUE means that only available service must be listed in the response" - }, - "provideUnavailabilityReason": { - "type": "boolean", - "description": "When the value is TRUE means that unavailability reason are expected for non available service." - }, - "serviceQualificationDate": { - "type": "string", - "description": "Date when the serviceQualification was submitted", - "format": "date-time" - }, - "state": { - "type": "string", - "description": "State of the serviceQualification (acknowledged, inProgress, terminatedWithError, done)" - }, - "serviceQualificationItem": { - "type": "array", - "description": "A list of service qualification items.", - "minItems": 1, - "items": { - "$ref": "ServiceQualificationItem.schema.json#ServiceQualificationItem" - } - }, - "relatedParty": { - "type": "array", - "description": "A list of related party references, defines party or party role linked to this request.", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "externalId": { - "description": "Identifier provided by the requester", - "type": "string" - }, - "qualificationResult": { - "description": "Qualification result for this serviceQualification. It could be: qualified (all qualification item are qualified), alternate (At least one item alternate and no item with unqualified), unqualified (At least one item unqualified)", - "type": "string" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceQualification.schema.json", + "title": "ServiceQualification", + "definitions": { + "ServiceQualification": { + "$id": "#ServiceQualification", + "type": "object", + "description": "ServiceQualification is used to perform a technical eligibility. It allows to retrieve a list of services that are technically available in the context of the interaction (place, party, service characteristics, ...).", + "properties": { + "description": { + "type": "string", + "description": "Description of the serviceQualification" + }, + "effectiveQualificationDate": { + "type": "string", + "description": "Effective date to serviceQualification completion", + "format": "date-time" + }, + "estimatedResponseDate": { + "type": "string", + "description": "Date when the requester expect to provide an answer for the qualification request.", + "format": "date-time" + }, + "expectedQualificationDate": { + "type": "string", + "description": "A date (DateTime). Deadline date when the requester expected a qualification answer.", + "format": "date-time" + }, + "expirationDate": { + "type": "string", + "description": "Date when the qualification response expires", + "format": "date-time" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the serviceQualification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the serviceQualification resource" + }, + "provideAlternative": { + "type": "boolean", + "description": "When the value is TRUE means that alternative solutions should be provided" + }, + "provideOnlyAvailable": { + "type": "boolean", + "description": "When the value is TRUE means that only available service must be listed in the response" + }, + "provideUnavailabilityReason": { + "type": "boolean", + "description": "When the value is TRUE means that unavailability reason are expected for non available service." + }, + "serviceQualificationDate": { + "type": "string", + "description": "Date when the serviceQualification was submitted", + "format": "date-time" + }, + "state": { + "type": "string", + "description": "State of the serviceQualification (acknowledged, inProgress, terminatedWithError, done)" + }, + "serviceQualificationItem": { + "type": "array", + "description": "A list of service qualification items.", + "minItems": 1, + "items": { + "$ref": "../Service/ServiceQualificationItem.schema.json#ServiceQualificationItem" + } + }, + "relatedParty": { + "type": "array", + "description": "A list of related party references, defines party or party role linked to this request.", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "externalId": { + "description": "Identifier provided by the requester", + "type": "string" + }, + "qualificationResult": { + "description": "Qualification result for this serviceQualification. It could be: qualified (all qualification item are qualified), alternate (At least one item alternate and no item with unqualified), unqualified (At least one item unqualified)", + "type": "string" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceQualificationItem.schema.json b/Service/ServiceQualificationItem.schema.json index 4e52de16..461fb3cb 100644 --- a/Service/ServiceQualificationItem.schema.json +++ b/Service/ServiceQualificationItem.schema.json @@ -1,89 +1,89 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceQualificationItem.schema.json", - "title": "ServiceQualificationItem", - "definitions": { - "ServiceQualificationItem": { - "$id": "#ServiceQualificationItem", - "description": "A ServiceQualificationItem relates to a specific service being checked in a qualification operation.", - "type": "object", - "properties": { - "expectedActivationDate": { - "type": "string", - "description": "The date when the service is expected to be activated", - "format": "date-time" - }, - "id": { - "type": "string", - "description": "Id of the Service Qualification Item" - }, - "qualificationResult": { - "type": "string", - "description": "Qualification result for serviceQualification item. It could be: - qualified (request service are available), - unqualified (requested not available and not alternate available), - alternate (requested not available but proposal available)" - }, - "state": { - "type": "string", - "description": "State of the serviceQualification item (acknowledged, inProgress, terminatedWithError, done)" - }, - "service": { - "description": "Configure the service characteristics (only configurable characteristics and necessary only if a non default value is selected) and/or identify the service that needs to be modified/deleted.", - "$ref": "ServiceRestriction.schema.json#/definitions/ServiceRestriction" - }, - "qualificationRelationship": { - "type": "array", - "description": "Structure used to describe relationship between serviceQualification item from the same serviceQualification.", - "items": { - "$ref": "ServiceQualificationRelationship.schema.json#ServiceQualificationRelationship" - } - }, - "expectedServiceAvailabilityDate": { - "description": "Date when the requester looks for service availability", - "type": "string", - "format": "date-time" - }, - "expirationDate": { - "description": "Date when the qualification item response expires", - "type": "string", - "format": "date-time" - }, - "eligibilityUnavailabilityReason": { - "type": "array", - "description": "A list of eligibility unavailability reasons (EligibilityUnavailabilityReason [*]). Reason for eligibility result if the serviceQualification result is no (meaning the service is not available).", - "items": { - "$ref": "ServiceEligibilityUnavailabilityReason.schema.json#ServiceEligibilityUnavailabilityReason" - } - }, - "category": { - "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.", - "$ref": "ServiceCategoryRef.schema.json#ServiceCategoryRef" - }, - "qualificationItemRelationship": { - "type": "array", - "description": "A list of qualification item relationships used to describe relationship between serviceQualification item from the same serviceQualification.", - "items": { - "$ref": "ServiceQualificationItemRelationship.schema.json#ServiceQualificationItemRelationship" - } - }, - "terminationError": { - "type": "array", - "description": "If qualificationItem has not been done properly this lists the error(s) that caused termination of the qualification.", - "items": { - "$ref": "TerminationError.schema.json#TerminationError" - } - }, - "alternateServiceProposal": { - "type": "array", - "description": "Alternate service proposal is used when the requested service is not available with characteristic and date asked for. An alternate proposal could be a distinct service Spec close to requested one or same as requested but with a different availability date.", - "items": { - "$ref": "AlternateServiceProposal.schema.json#AlternateServiceProposal" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceQualificationItem.schema.json", + "title": "ServiceQualificationItem", + "definitions": { + "ServiceQualificationItem": { + "$id": "#ServiceQualificationItem", + "description": "A ServiceQualificationItem relates to a specific service being checked in a qualification operation.", + "type": "object", + "properties": { + "expectedActivationDate": { + "type": "string", + "description": "The date when the service is expected to be activated", + "format": "date-time" + }, + "id": { + "type": "string", + "description": "Id of the Service Qualification Item" + }, + "qualificationResult": { + "type": "string", + "description": "Qualification result for serviceQualification item. It could be: - qualified (request service are available), - unqualified (requested not available and not alternate available), - alternate (requested not available but proposal available)" + }, + "state": { + "type": "string", + "description": "State of the serviceQualification item (acknowledged, inProgress, terminatedWithError, done)" + }, + "service": { + "description": "Configure the service characteristics (only configurable characteristics and necessary only if a non default value is selected) and/or identify the service that needs to be modified/deleted.", + "$ref": "ServiceRestriction.schema.json#/definitions/ServiceRestriction" + }, + "qualificationRelationship": { + "type": "array", + "description": "Structure used to describe relationship between serviceQualification item from the same serviceQualification.", + "items": { + "$ref": "../Service/ServiceQualificationRelationship.schema.json#ServiceQualificationRelationship" + } + }, + "expectedServiceAvailabilityDate": { + "description": "Date when the requester looks for service availability", + "type": "string", + "format": "date-time" + }, + "expirationDate": { + "description": "Date when the qualification item response expires", + "type": "string", + "format": "date-time" + }, + "eligibilityUnavailabilityReason": { + "type": "array", + "description": "A list of eligibility unavailability reasons (EligibilityUnavailabilityReason [*]). Reason for eligibility result if the serviceQualification result is no (meaning the service is not available).", + "items": { + "$ref": "../Service/ServiceEligibilityUnavailabilityReason.schema.json#ServiceEligibilityUnavailabilityReason" + } + }, + "category": { + "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.", + "$ref": "../Service/ServiceCategoryRef.schema.json#ServiceCategoryRef" + }, + "qualificationItemRelationship": { + "type": "array", + "description": "A list of qualification item relationships used to describe relationship between serviceQualification item from the same serviceQualification.", + "items": { + "$ref": "../Service/ServiceQualificationItemRelationship.schema.json#ServiceQualificationItemRelationship" + } + }, + "terminationError": { + "type": "array", + "description": "If qualificationItem has not been done properly this lists the error(s) that caused termination of the qualification.", + "items": { + "$ref": "../Service/TerminationError.schema.json#TerminationError" + } + }, + "alternateServiceProposal": { + "type": "array", + "description": "Alternate service proposal is used when the requested service is not available with characteristic and date asked for. An alternate proposal could be a distinct service Spec close to requested one or same as requested but with a different availability date.", + "items": { + "$ref": "../Service/AlternateServiceProposal.schema.json#AlternateServiceProposal" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceQualificationItemRelationship.schema.json b/Service/ServiceQualificationItemRelationship.schema.json index dfa4ecd0..bb505067 100644 --- a/Service/ServiceQualificationItemRelationship.schema.json +++ b/Service/ServiceQualificationItemRelationship.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceQualificationItemRelationship.schema.json", - "title": "ServiceQualificationItemRelationship", - "definitions": { - "ServiceQualificationItemRelationship": { - "$id": "#ServiceQualificationItemRelationship", - "description": "Structure used to describe relationship between serviceQualification items from the same serviceQualification.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Id of the serviceQualificationItem (from the same serviceQualificationItem)." - }, - "relationshipType": { - "type": "string", - "description": "Type of relationship (ex: reliesOn, connectedTo, etc...)" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceQualificationItemRelationship.schema.json", + "title": "ServiceQualificationItemRelationship", + "definitions": { + "ServiceQualificationItemRelationship": { + "$id": "#ServiceQualificationItemRelationship", + "description": "Structure used to describe relationship between serviceQualification items from the same serviceQualification.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Id of the serviceQualificationItem (from the same serviceQualificationItem)." + }, + "relationshipType": { + "type": "string", + "description": "Type of relationship (ex: reliesOn, connectedTo, etc...)" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceQualificationRelationship.schema.json b/Service/ServiceQualificationRelationship.schema.json index a967b3e8..73472aec 100644 --- a/Service/ServiceQualificationRelationship.schema.json +++ b/Service/ServiceQualificationRelationship.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceQualificationRelationship.schema.json", - "title": "ServiceQualificationRelationship", - "definitions": { - "ServiceQualificationRelationship": { - "$id": "#ServiceQualificationRelationship", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The id of the target qualification pointed to by this relationship" - }, - "relationshipType": { - "type": "string", - "description": "The type of relationship" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceQualificationRelationship.schema.json", + "title": "ServiceQualificationRelationship", + "definitions": { + "ServiceQualificationRelationship": { + "$id": "#ServiceQualificationRelationship", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The id of the target qualification pointed to by this relationship" + }, + "relationshipType": { + "type": "string", + "description": "The type of relationship" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceRef.schema.json b/Service/ServiceRef.schema.json index cbbc7e6c..bfa69826 100644 --- a/Service/ServiceRef.schema.json +++ b/Service/ServiceRef.schema.json @@ -1,18 +1,18 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceRef.schema.json", - "title": "ServiceRef", - "definitions": { - "ServiceRef": { - "$id": "#ServiceRef", - "description": "Service reference, for when Service is used by other entities", - "type": "object", - "properties": {}, - "allOf": [ - { - "$ref": "../Common/EntityRef.schema.json#EntityRef" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceRef.schema.json", + "title": "ServiceRef", + "definitions": { + "ServiceRef": { + "$id": "#ServiceRef", + "description": "Service reference, for when Service is used by other entities", + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "../Common/EntityRef.schema.json#EntityRef" } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceRelationship.schema.json b/Service/ServiceRelationship.schema.json index f22b3074..3071b1dc 100644 --- a/Service/ServiceRelationship.schema.json +++ b/Service/ServiceRelationship.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceRelationship.schema.json", - "title": "ServiceRelationship", - "definitions": { - "ServiceRelationship": { - "$id": "#ServiceRelationship", - "description": "Describes links with services of the same category (useful for bundled services)", - "type": "object", - "required": [ - "relationshipType", - "service" - ], - "properties": { - "relationshipType": { - "type": "string", - "description": "The type of relationship (e.g. depends on, enables)" - }, - "service": { - "description": "The service being referred to", - "$ref": "ServiceRef.schema.json#ServiceRef" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceRelationship.schema.json", + "title": "ServiceRelationship", + "definitions": { + "ServiceRelationship": { + "$id": "#ServiceRelationship", + "description": "Describes links with services of the same category (useful for bundled services)", + "type": "object", + "required": [ + "relationshipType", + "service" + ], + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of relationship (e.g. depends on, enables)" + }, + "service": { + "description": "The service being referred to", + "$ref": "../Service/ServiceRef.schema.json#ServiceRef" } + } } -} \ No newline at end of file + } +} diff --git a/Service/ServiceSpecCharRelationship.schema.json b/Service/ServiceSpecCharRelationship.schema.json index 6d751a5d..1f35ddc8 100644 --- a/Service/ServiceSpecCharRelationship.schema.json +++ b/Service/ServiceSpecCharRelationship.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceSpecCharRelationship.schema.json", - "title": "ServiceSpecCharRelationship", - "definitions": { - "ServiceSpecCharRelationship": { - "$id": "#ServiceSpecCharRelationship", - "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among serviceSpecCharacteristics.", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" - }, - "role": { - "type": "string", - "description": "The association role for this service specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the target specification" - }, - "href": { - "type": "string", - "description": "Hyperlink reference to the target specification" - }, - "name": { - "type": "string", - "description": "Name of the target characteristic" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the serviceSpecCharRelationship is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceSpecCharRelationship.schema.json", + "title": "ServiceSpecCharRelationship", + "definitions": { + "ServiceSpecCharRelationship": { + "$id": "#ServiceSpecCharRelationship", + "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among serviceSpecCharacteristics.", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" + }, + "role": { + "type": "string", + "description": "The association role for this service specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the target specification" + }, + "href": { + "type": "string", + "description": "Hyperlink reference to the target specification" + }, + "name": { + "type": "string", + "description": "Name of the target characteristic" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the serviceSpecCharRelationship is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceSpecCharacteristic.schema.json b/Service/ServiceSpecCharacteristic.schema.json index 47f8a4f6..8af3f6c0 100644 --- a/Service/ServiceSpecCharacteristic.schema.json +++ b/Service/ServiceSpecCharacteristic.schema.json @@ -1,77 +1,77 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceSpecCharacteristic.schema.json", - "title": "ServiceSpecCharacteristic", - "definitions": { - "ServiceSpecCharacteristic": { - "$id": "#ServiceSpecCharacteristic", - "description": "This class represents the key features of this service specification. For example, bandwidth is a characteristic of many different types of services; if bandwidth is a relevant characteristic (e.g., from the point-of-view of a Customer obtaining this Service via a Product) then bandwidth would be a ServiceSpecCharacteristic for that particular Service.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications." - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the serviceSpecCharacteristic is" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" - }, - "configurable": { - "type": "boolean", - "description": "If true, the Boolean indicates that the serviceSpecCharacteristic is configurable" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the serviceSpecCharacteristic is valid" - }, - "@valueSchemaLocation": { - "type": "string", - "description": "This (optional) field provides a link to the schema describing the value type." - }, - "minCardinality": { - "type": "integer", - "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality." - }, - "maxCardinality": { - "type": "integer", - "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality." - }, - "isUnique": { - "type": "boolean", - "description": "An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"" - }, - "regex": { - "type": "string", - "description": "A rule or principle represented in regular expression used to derive the value of a characteristic value." - }, - "extensible": { - "type": "boolean", - "description": "An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for an Entity." - }, - "serviceSpecCharacteristicValue": { - "type": "array", - "description": "A list of service spec characteristic values (ServiceSpecCharacteristicValue [*]). A ServiceSpecCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ServiceSpecCharacteristic object. The values of the attributes in the ServiceSpecCharacteristicValue object describe the values of the attributes that a corresponding ServiceSpecCharacteristic object can take on.", - "items": { - "$ref": "ServiceSpecCharacteristicValue.schema.json#ServiceSpecCharacteristicValue" - } - }, - "serviceSpecCharRelationship": { - "type": "array", - "description": "A list of service spec char relationships (ServiceSpecCharRelationship [*]). An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.", - "items": { - "$ref": "ServiceSpecCharRelationship.schema.json#ServiceSpecCharRelationship" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceSpecCharacteristic.schema.json", + "title": "ServiceSpecCharacteristic", + "definitions": { + "ServiceSpecCharacteristic": { + "$id": "#ServiceSpecCharacteristic", + "description": "This class represents the key features of this service specification. For example, bandwidth is a characteristic of many different types of services; if bandwidth is a relevant characteristic (e.g., from the point-of-view of a Customer obtaining this Service via a Product) then bandwidth would be a ServiceSpecCharacteristic for that particular Service.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications." + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the serviceSpecCharacteristic is" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" + }, + "configurable": { + "type": "boolean", + "description": "If true, the Boolean indicates that the serviceSpecCharacteristic is configurable" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the serviceSpecCharacteristic is valid" + }, + "@valueSchemaLocation": { + "type": "string", + "description": "This (optional) field provides a link to the schema describing the value type." + }, + "minCardinality": { + "type": "integer", + "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality." + }, + "maxCardinality": { + "type": "integer", + "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality." + }, + "isUnique": { + "type": "boolean", + "description": "An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"" + }, + "regex": { + "type": "string", + "description": "A rule or principle represented in regular expression used to derive the value of a characteristic value." + }, + "extensible": { + "type": "boolean", + "description": "An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for an Entity." + }, + "serviceSpecCharacteristicValue": { + "type": "array", + "description": "A list of service spec characteristic values (ServiceSpecCharacteristicValue [*]). A ServiceSpecCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ServiceSpecCharacteristic object. The values of the attributes in the ServiceSpecCharacteristicValue object describe the values of the attributes that a corresponding ServiceSpecCharacteristic object can take on.", + "items": { + "$ref": "../Service/ServiceSpecCharacteristicValue.schema.json#ServiceSpecCharacteristicValue" + } + }, + "serviceSpecCharRelationship": { + "type": "array", + "description": "A list of service spec char relationships (ServiceSpecCharRelationship [*]). An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.", + "items": { + "$ref": "../Service/ServiceSpecCharRelationship.schema.json#ServiceSpecCharRelationship" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceSpecCharacteristicValue.schema.json b/Service/ServiceSpecCharacteristicValue.schema.json index f2bf3aea..20dac50c 100644 --- a/Service/ServiceSpecCharacteristicValue.schema.json +++ b/Service/ServiceSpecCharacteristicValue.schema.json @@ -1,55 +1,55 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceSpecCharacteristicValue.schema.json", - "title": "ServiceSpecCharacteristicValue", - "definitions": { - "ServiceSpecCharacteristicValue": { - "$id": "#ServiceSpecCharacteristicValue", - "description": "A ServiceSpecCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ServiceSpecCharacteristic object. The values of the attributes in the ServiceSpecCharacteristicValue object describe the values of the attributes that a corresponding ServiceSpecCharacteristic object can take on.", - "type": "object", - "properties": { - "valueType": { - "type": "string", - "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" - }, - "isDefault": { - "type": "boolean", - "description": "Indicates if the value is the default value for a characteristic" - }, - "value": { - "$ref": "../Common/Any.schema.json#Any", - "description": "A discrete value that the characteristic can take on, or the actual value of the characteristic" - }, - "unitOfMeasure": { - "type": "string", - "description": "A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period of time for which a value is applicable" - }, - "valueFrom": { - "type": "integer", - "description": "The low range value that a characteristic can take on" - }, - "valueTo": { - "type": "integer", - "description": "The upper range value that a characteristic can take on" - }, - "rangeInterval": { - "type": "string", - "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." - }, - "regex": { - "type": "string", - "description": "A regular expression constraint for given value" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceSpecCharacteristicValue.schema.json", + "title": "ServiceSpecCharacteristicValue", + "definitions": { + "ServiceSpecCharacteristicValue": { + "$id": "#ServiceSpecCharacteristicValue", + "description": "A ServiceSpecCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ServiceSpecCharacteristic object. The values of the attributes in the ServiceSpecCharacteristicValue object describe the values of the attributes that a corresponding ServiceSpecCharacteristic object can take on.", + "type": "object", + "properties": { + "valueType": { + "type": "string", + "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth" + }, + "isDefault": { + "type": "boolean", + "description": "Indicates if the value is the default value for a characteristic" + }, + "value": { + "$ref": "../Common/Any.schema.json#Any", + "description": "A discrete value that the characteristic can take on, or the actual value of the characteristic" + }, + "unitOfMeasure": { + "type": "string", + "description": "A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period of time for which a value is applicable" + }, + "valueFrom": { + "type": "integer", + "description": "The low range value that a characteristic can take on" + }, + "valueTo": { + "type": "integer", + "description": "The upper range value that a characteristic can take on" + }, + "rangeInterval": { + "type": "string", + "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." + }, + "regex": { + "type": "string", + "description": "A regular expression constraint for given value" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceSpecRelationship.schema.json b/Service/ServiceSpecRelationship.schema.json index 8300d6c2..c33c3835 100644 --- a/Service/ServiceSpecRelationship.schema.json +++ b/Service/ServiceSpecRelationship.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceSpecRelationship.schema.json", - "title": "ServiceSpecRelationship", - "definitions": { - "ServiceSpecRelationship": { - "$id": "#ServiceSpecRelationship", - "description": "A migration, substitution, dependency or exclusivity relationship between/among service specifications.", - "type": "object", - "properties": { - "relationshipType": { - "type": "string", - "description": "Type of relationship such as migration, substitution, dependency, exclusivity" - }, - "role": { - "type": "string", - "description": "The association role for this service specification" - }, - "id": { - "type": "string", - "description": "Unique identifier of the target serviceSpecification" - }, - "href": { - "type": "string", - "description": "Reference of the target serviceSpecification" - }, - "name": { - "type": "string", - "description": "The name given to the target service specification instance" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the serviceSpecRelationship is valid" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceSpecRelationship.schema.json", + "title": "ServiceSpecRelationship", + "definitions": { + "ServiceSpecRelationship": { + "$id": "#ServiceSpecRelationship", + "description": "A migration, substitution, dependency or exclusivity relationship between/among service specifications.", + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "Type of relationship such as migration, substitution, dependency, exclusivity" + }, + "role": { + "type": "string", + "description": "The association role for this service specification" + }, + "id": { + "type": "string", + "description": "Unique identifier of the target serviceSpecification" + }, + "href": { + "type": "string", + "description": "Reference of the target serviceSpecification" + }, + "name": { + "type": "string", + "description": "The name given to the target service specification instance" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the serviceSpecRelationship is valid" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceSpecification.schema.json b/Service/ServiceSpecification.schema.json index f8060c27..4d08a80d 100644 --- a/Service/ServiceSpecification.schema.json +++ b/Service/ServiceSpecification.schema.json @@ -1,102 +1,102 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceSpecification.schema.json", - "title": "ServiceSpecification", - "definitions": { - "ServiceSpecification": { - "$id": "#ServiceSpecification", - "description": "ServiceSpecification is a class that offers characteristics to describe a type of service.\nFunctionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the service specification" - }, - "href": { - "type": "string", - "description": "Reference of the service specification" - }, - "name": { - "type": "string", - "description": "Name of the service specification" - }, - "description": { - "type": "string", - "description": "A narrative that explains in detail what the service specification is" - }, - "version": { - "type": "string", - "description": "Service specification version" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period for which the service specification is valid" - }, - "lastUpdate": { - "type": "string", - "format": "date-time", - "description": "Date and time of the last update of the service specification" - }, - "lifecycleStatus": { - "type": "string", - "description": "Used to indicate the current lifecycle status of the service specification" - }, - "isBundle": { - "type": "boolean", - "description": "isBundle determines whether a ServiceSpecification represents a single ServiceSpecification (false), or a bundle of ServiceSpecification (true)." - }, - "resourceSpecification": { - "type": "array", - "description": "A list of resource specification references (ResourceSpecificationRef [*]). The ResourceSpecification is required for a service specification with type ResourceFacingServiceSpecification (RFSS).", - "items": { - "$ref": "../Resource/ResourceSpecificationRef.schema.json#ResourceSpecificationRef" - } - }, - "attachment": { - "type": "array", - "description": "A list of attachments (Attachment [*]). Complements the description of the specification through video, pictures...", - "items": { - "$ref": "../Common/AttachmentRef.schema.json#AttachmentRef" - } - }, - "serviceSpecCharacteristic": { - "type": "array", - "description": "A list of service spec characteristics (ServiceSpecCharacteristic [*]). This class represents the key features of this service specification.", - "items": { - "$ref": "ServiceSpecCharacteristic.schema.json#ServiceSpecCharacteristic" - } - }, - "relatedParty": { - "type": "array", - "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity.", - "items": { - "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" - } - }, - "serviceSpecRelationship": { - "type": "array", - "description": "A list of service specifications related to this specification, e.g. migration, substitution, dependency or exclusivity relationship", - "items": { - "$ref": "ServiceSpecRelationship.schema.json#ServiceSpecRelationship" - } - }, - "serviceLevelSpecification": { - "type": "array", - "description": "A list of service level specifications related to this service specification, and which will need to be satisifiable for corresponding service instances; e.g. Gold, Platinum", - "items": { - "$ref": "ServiceLevelSpecificationRef.schema.json#ServiceLevelSpecificationRef" - } - }, - "targetServiceSchema": { - "description": "A target service schema reference (TargetServiceSchemaRef). The reference object to the schema and type of target service which is described by service specification.", - "$ref": "TargetServiceSchema.schema.json#TargetServiceSchema" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceSpecification.schema.json", + "title": "ServiceSpecification", + "definitions": { + "ServiceSpecification": { + "$id": "#ServiceSpecification", + "description": "ServiceSpecification is a class that offers characteristics to describe a type of service.\nFunctionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the service specification" + }, + "href": { + "type": "string", + "description": "Reference of the service specification" + }, + "name": { + "type": "string", + "description": "Name of the service specification" + }, + "description": { + "type": "string", + "description": "A narrative that explains in detail what the service specification is" + }, + "version": { + "type": "string", + "description": "Service specification version" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period for which the service specification is valid" + }, + "lastUpdate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the last update of the service specification" + }, + "lifecycleStatus": { + "type": "string", + "description": "Used to indicate the current lifecycle status of the service specification" + }, + "isBundle": { + "type": "boolean", + "description": "isBundle determines whether a ServiceSpecification represents a single ServiceSpecification (false), or a bundle of ServiceSpecification (true)." + }, + "resourceSpecification": { + "type": "array", + "description": "A list of resource specification references (ResourceSpecificationRef [*]). The ResourceSpecification is required for a service specification with type ResourceFacingServiceSpecification (RFSS).", + "items": { + "$ref": "../Resource/ResourceSpecificationRef.schema.json#ResourceSpecificationRef" + } + }, + "attachment": { + "type": "array", + "description": "A list of attachments (Attachment [*]). Complements the description of the specification through video, pictures...", + "items": { + "$ref": "../Common/AttachmentRef.schema.json#AttachmentRef" + } + }, + "serviceSpecCharacteristic": { + "type": "array", + "description": "A list of service spec characteristics (ServiceSpecCharacteristic [*]). This class represents the key features of this service specification.", + "items": { + "$ref": "../Service/ServiceSpecCharacteristic.schema.json#ServiceSpecCharacteristic" + } + }, + "relatedParty": { + "type": "array", + "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity.", + "items": { + "$ref": "../EngagedParty/RelatedParty.schema.json#RelatedParty" + } + }, + "serviceSpecRelationship": { + "type": "array", + "description": "A list of service specifications related to this specification, e.g. migration, substitution, dependency or exclusivity relationship", + "items": { + "$ref": "../Service/ServiceSpecRelationship.schema.json#ServiceSpecRelationship" + } + }, + "serviceLevelSpecification": { + "type": "array", + "description": "A list of service level specifications related to this service specification, and which will need to be satisifiable for corresponding service instances; e.g. Gold, Platinum", + "items": { + "$ref": "../Service/ServiceLevelSpecificationRef.schema.json#ServiceLevelSpecificationRef" + } + }, + "targetServiceSchema": { + "description": "A target service schema reference (TargetServiceSchemaRef). The reference object to the schema and type of target service which is described by service specification.", + "$ref": "../Service/TargetServiceSchema.schema.json#TargetServiceSchema" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceSpecificationRef.schema.json b/Service/ServiceSpecificationRef.schema.json index 87871da4..0c809138 100644 --- a/Service/ServiceSpecificationRef.schema.json +++ b/Service/ServiceSpecificationRef.schema.json @@ -1,43 +1,43 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceSpecificationRef.schema.json", - "title": "ServiceSpecificationRef", - "definitions": { - "ServiceSpecificationRef": { - "$id": "#ServiceSpecificationRef", - "description": "Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the service specification" - }, - "href": { - "type": "string", - "description": "Reference of the serviceSpecification" - }, - "name": { - "type": "string", - "description": "Name of the requiredServiceSpecification" - }, - "version": { - "type": "string", - "description": "Service specification version" - }, - "targetServiceSchema": { - "description": "A target service schema reference (TargetServiceSchemaRef). The reference object to the schema and type of target service which is described by service specification.", - "$ref": "TargetServiceSchema.schema.json#TargetServiceSchema" - }, - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceSpecificationRef.schema.json", + "title": "ServiceSpecificationRef", + "definitions": { + "ServiceSpecificationRef": { + "$id": "#ServiceSpecificationRef", + "description": "Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the service specification" + }, + "href": { + "type": "string", + "description": "Reference of the serviceSpecification" + }, + "name": { + "type": "string", + "description": "Name of the requiredServiceSpecification" + }, + "version": { + "type": "string", + "description": "Service specification version" + }, + "targetServiceSchema": { + "description": "A target service schema reference (TargetServiceSchemaRef). The reference object to the schema and type of target service which is described by service specification.", + "$ref": "../Service/TargetServiceSchema.schema.json#TargetServiceSchema" + }, + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceStateType.schema.json b/Service/ServiceStateType.schema.json index 054e418e..6bf031f8 100644 --- a/Service/ServiceStateType.schema.json +++ b/Service/ServiceStateType.schema.json @@ -1,20 +1,20 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceStateType.schema.json", - "title": "ServiceStateType", - "definitions": { - "ServiceStateType": { - "$id": "#ServiceStateType", - "type": "string", - "description": "Valid values for the lifecycle state of the service", - "enum": [ - "feasibilityChecked", - "designed", - "reserved", - "inactive", - "active", - "terminated" - ] - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceStateType.schema.json", + "title": "ServiceStateType", + "definitions": { + "ServiceStateType": { + "$id": "#ServiceStateType", + "type": "string", + "description": "Valid values for the lifecycle state of the service", + "enum": [ + "feasibilityChecked", + "designed", + "reserved", + "inactive", + "active", + "terminated" + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceTest.schema.json b/Service/ServiceTest.schema.json index 0f393cba..6a5dc513 100644 --- a/Service/ServiceTest.schema.json +++ b/Service/ServiceTest.schema.json @@ -1,75 +1,75 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceTest.schema.json", - "title": "ServiceTest", - "definitions": { - "ServiceTest": { - "$id": "#ServiceTest", - "description": "A service test is an entity that exists for a controlled test invocation on a service. The service \ntest is executed according to a schedule and contains service test configuration parameters that are to be \napplied at execution time, and service test measures that result.", - "type": "object", - "properties": { - "characteristic": { - "type": "array", - "description": "List of characteristics with values that define the test run", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - } - }, - "description": { - "type": "string", - "description": "Description of the service test" - }, - "endDateTime": { - "type": "string", - "format": "date-time", - "description": "The end date and time of the service test" - }, - "href": { - "type": "string", - "description": "Hyperlink to access the service test" - }, - "id": { - "type": "string", - "description": "The identifier of the service test" - }, - "mode": { - "type": "string", - "description": "An indication of whether the service test is running in \n\"PROACTIVE\" or \"ONDEMAND\" mode" - }, - "name": { - "type": "string", - "description": "The name of the service test" - }, - "relatedService": { - "description": "The actual service being tested", - "$ref": "ServiceRef.schema.json#ServiceRef" - }, - "startDateTime": { - "type": "string", - "format": "date-time", - "description": "The start date and time of the service test." - }, - "state": { - "type": "string", - "description": "The actual state the service test is in" - }, - "testMeasure": { - "type": "array", - "description": "The results of the test in terms of the measured metrics", - "items": { - "$ref": "TestMeasure.schema.json#TestMeasure" - } - }, - "testSpecification": { - "description": "The specification for this test", - "$ref": "ServiceTestSpecificationRef.schema.json#ServiceTestSpecificationRef" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceTest.schema.json", + "title": "ServiceTest", + "definitions": { + "ServiceTest": { + "$id": "#ServiceTest", + "description": "A service test is an entity that exists for a controlled test invocation on a service. The service \ntest is executed according to a schedule and contains service test configuration parameters that are to be \napplied at execution time, and service test measures that result.", + "type": "object", + "properties": { + "characteristic": { + "type": "array", + "description": "List of characteristics with values that define the test run", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + } + }, + "description": { + "type": "string", + "description": "Description of the service test" + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "The end date and time of the service test" + }, + "href": { + "type": "string", + "description": "Hyperlink to access the service test" + }, + "id": { + "type": "string", + "description": "The identifier of the service test" + }, + "mode": { + "type": "string", + "description": "An indication of whether the service test is running in \n\"PROACTIVE\" or \"ONDEMAND\" mode" + }, + "name": { + "type": "string", + "description": "The name of the service test" + }, + "relatedService": { + "description": "The actual service being tested", + "$ref": "../Service/ServiceRef.schema.json#ServiceRef" + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "The start date and time of the service test." + }, + "state": { + "type": "string", + "description": "The actual state the service test is in" + }, + "testMeasure": { + "type": "array", + "description": "The results of the test in terms of the measured metrics", + "items": { + "$ref": "../Service/TestMeasure.schema.json#TestMeasure" + } + }, + "testSpecification": { + "description": "The specification for this test", + "$ref": "../Service/ServiceTestSpecificationRef.schema.json#ServiceTestSpecificationRef" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceTestCharacteristic.schema.json b/Service/ServiceTestCharacteristic.schema.json index 24d8ee3d..61c0ec4d 100644 --- a/Service/ServiceTestCharacteristic.schema.json +++ b/Service/ServiceTestCharacteristic.schema.json @@ -1,27 +1,27 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceTestCharacteristic.schema.json", - "title": "ServiceTestCharacteristic", - "definitions": { - "ServiceTestCharacteristic": { - "$id": "#ServiceTestCharacteristic", - "description": "The configuration of the service test is set by the service test characteristic.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the characteristic." - }, - "value": { - "type": "string", - "description": "The value of characteristic." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceTestCharacteristic.schema.json", + "title": "ServiceTestCharacteristic", + "definitions": { + "ServiceTestCharacteristic": { + "$id": "#ServiceTestCharacteristic", + "description": "The configuration of the service test is set by the service test characteristic.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the characteristic." + }, + "value": { + "type": "string", + "description": "The value of characteristic." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceTestSpecification.schema.json b/Service/ServiceTestSpecification.schema.json index 8c3c392d..f65f25d0 100644 --- a/Service/ServiceTestSpecification.schema.json +++ b/Service/ServiceTestSpecification.schema.json @@ -1,54 +1,54 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceTestSpecification.schema.json", - "title": "ServiceTestSpecification", - "definitions": { - "ServiceTestSpecification": { - "$id": "#ServiceTestSpecification", - "description": "The service test specification describes the service test in terms of parameters to be configured and \nmeasures to be taken.", - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of a service test specification." - }, - "href": { - "type": "string", - "description": "Hyperlink to access a service test specification." - }, - "id": { - "type": "string", - "description": "Identifier of a service test specification." - }, - "version": { - "type": "string", - "description": "Version of a service test specification " - }, - "name": { - "type": "string", - "description": "Name of a service test specification." - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The period of time for which this specification is valid" - }, - "testMeasureDefinition": { - "type": "array", - "description": "A list of definitions for the measurements for the test defined by this specification", - "items": { - "$ref": "TestMeasureDefinition.schema.json#TestMeasureDefinition" - } - }, - "relatedServiceSpecification": { - "$ref": "ServiceSpecificationRef.schema.json#ServiceSpecificationRef", - "description": "The related service specification." - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceTestSpecification.schema.json", + "title": "ServiceTestSpecification", + "definitions": { + "ServiceTestSpecification": { + "$id": "#ServiceTestSpecification", + "description": "The service test specification describes the service test in terms of parameters to be configured and \nmeasures to be taken.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of a service test specification." + }, + "href": { + "type": "string", + "description": "Hyperlink to access a service test specification." + }, + "id": { + "type": "string", + "description": "Identifier of a service test specification." + }, + "version": { + "type": "string", + "description": "Version of a service test specification " + }, + "name": { + "type": "string", + "description": "Name of a service test specification." + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The period of time for which this specification is valid" + }, + "testMeasureDefinition": { + "type": "array", + "description": "A list of definitions for the measurements for the test defined by this specification", + "items": { + "$ref": "../Service/TestMeasureDefinition.schema.json#TestMeasureDefinition" + } + }, + "relatedServiceSpecification": { + "$ref": "../Service/ServiceSpecificationRef.schema.json#ServiceSpecificationRef", + "description": "The related service specification." } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/ServiceTestSpecificationRef.schema.json b/Service/ServiceTestSpecificationRef.schema.json index 98b2eceb..61a61cfb 100644 --- a/Service/ServiceTestSpecificationRef.schema.json +++ b/Service/ServiceTestSpecificationRef.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "ServiceTestSpecificationRef.schema.json", - "title": "ServiceTestSpecificationRef", - "definitions": { - "ServiceTestSpecificationRef": { - "$id": "#ServiceTestSpecificationRef", - "type": "object", - "description": "The service test specification used by the service test.", - "properties": { - "@referredType": { - "type": "string", - "description": "The actual type of the target instance when needed for disambiguation." - }, - "href": { - "type": "string", - "description": "Hyperlink to access a service test specification." - }, - "id": { - "type": "string", - "description": "Identifier of a service test specification." - }, - "version": { - "type": "string", - "description": "Version of a service test specification " - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "ServiceTestSpecificationRef.schema.json", + "title": "ServiceTestSpecificationRef", + "definitions": { + "ServiceTestSpecificationRef": { + "$id": "#ServiceTestSpecificationRef", + "type": "object", + "description": "The service test specification used by the service test.", + "properties": { + "@referredType": { + "type": "string", + "description": "The actual type of the target instance when needed for disambiguation." + }, + "href": { + "type": "string", + "description": "Hyperlink to access a service test specification." + }, + "id": { + "type": "string", + "description": "Identifier of a service test specification." + }, + "version": { + "type": "string", + "description": "Version of a service test specification " } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/SupportingService.schema.json b/Service/SupportingService.schema.json index 275d0aff..1711b5b7 100644 --- a/Service/SupportingService.schema.json +++ b/Service/SupportingService.schema.json @@ -1,35 +1,35 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "SupportingService.schema.json", - "title": "SupportingService", - "definitions": { - "SupportingService": { - "$id": "#SupportingService", - "description": "A collection of services that support this service (links between CFS -> RFS)", - "type": "object", - "properties": { - "category": { - "type": "string", - "description": "Category of the supporting service" - }, - "href": { - "type": "string", - "description": "Reference of the supporting service" - }, - "id": { - "type": "string", - "description": "Unique identifier of the supporting service" - }, - "name": { - "type": "string", - "description": "Name of the supporting service" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "SupportingService.schema.json", + "title": "SupportingService", + "definitions": { + "SupportingService": { + "$id": "#SupportingService", + "description": "A collection of services that support this service (links between CFS -> RFS)", + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Category of the supporting service" + }, + "href": { + "type": "string", + "description": "Reference of the supporting service" + }, + "id": { + "type": "string", + "description": "Unique identifier of the supporting service" + }, + "name": { + "type": "string", + "description": "Name of the supporting service" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/TargetServiceSchema.schema.json b/Service/TargetServiceSchema.schema.json index 30d0595f..a89ba6ed 100644 --- a/Service/TargetServiceSchema.schema.json +++ b/Service/TargetServiceSchema.schema.json @@ -1,26 +1,26 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TargetServiceSchema.schema.json", - "title": "TargetServiceSchema", - "definitions": { - "TargetServiceSchema": { - "$id": "#TargetServiceSchema", - "type": "object", - "description": "The reference object to the schema and type of target service which is described by service specification", - "properties": { - "@type": { - "type": "string", - "description": "Class type of the target service" - }, - "@schemaLocation": { - "type": "string", - "description": "This field provides a link to the schema describing the target service" - } - }, - "required": [ - "@type", - "@schemaLocation" - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TargetServiceSchema.schema.json", + "title": "TargetServiceSchema", + "definitions": { + "TargetServiceSchema": { + "$id": "#TargetServiceSchema", + "type": "object", + "description": "The reference object to the schema and type of target service which is described by service specification", + "properties": { + "@type": { + "type": "string", + "description": "Class type of the target service" + }, + "@schemaLocation": { + "type": "string", + "description": "This field provides a link to the schema describing the target service" } + }, + "required": [ + "@type", + "@schemaLocation" + ] } -} \ No newline at end of file + } +} diff --git a/Service/TerminationError.schema.json b/Service/TerminationError.schema.json index 238d7278..5c5c0914 100644 --- a/Service/TerminationError.schema.json +++ b/Service/TerminationError.schema.json @@ -1,22 +1,22 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TerminationError.schema.json", - "title": "TerminationError", - "definitions": { - "TerminationError": { - "$id": "#TerminationError", - "description": "This indicates an error that caused a qualificationItem to be terminated.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier of the termination error" - }, - "value": { - "type": "string", - "description": "Text to describe the termination error - for example: Unable to proceed to qualification because incomplete information provided" - } - } + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TerminationError.schema.json", + "title": "TerminationError", + "definitions": { + "TerminationError": { + "$id": "#TerminationError", + "description": "This indicates an error that caused a qualificationItem to be terminated.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the termination error" + }, + "value": { + "type": "string", + "description": "Text to describe the termination error - for example: Unable to proceed to qualification because incomplete information provided" } + } } -} \ No newline at end of file + } +} diff --git a/Service/TestMeasure.schema.json b/Service/TestMeasure.schema.json index 860a643a..9a93247a 100644 --- a/Service/TestMeasure.schema.json +++ b/Service/TestMeasure.schema.json @@ -1,60 +1,60 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TestMeasure.schema.json", - "title": "TestMeasure", - "definitions": { - "TestMeasure": { - "$id": "#TestMeasure", - "description": "A TestMeasure specifies a measure of a specific aspect of a product, service, or resource test, such as lost packets or connectivity status", - "type": "object", - "properties": { - "accuracy": { - "type": "number", - "format": "float", - "description": "The number of digits of accuracy captured for associated Metrics" - }, - "captureDateTime": { - "type": "string", - "format": "date-time", - "description": "The date and time that the metric was captured" - }, - "captureMethod": { - "type": "string", - "description": "The method used to capture the Metrics (This may be replaced by a set of entities similar to the Performance Monitoring Ref)" - }, - "metricDescription": { - "type": "string", - "description": "Brief description of the metric" - }, - "metricHref": { - "type": "string", - "description": "Hyperlink to access a metric for detail information" - }, - "metricName": { - "type": "string", - "description": "The name of the metric" - }, - "ruleViolation": { - "type": "array", - "description": "A list of rules that were violated in this test measure", - "items": { - "$ref": "MeasureThresholdRuleViolation.schema.json#MeasureThresholdRuleViolation" - } - }, - "unitOfMeasure": { - "type": "string", - "description": "The unit of measure for the metric values, such as meters, cubic yards, kilograms [ISO 1000]." - }, - "value": { - "description": "The value of Metric in the test. This also could be a document to record all values captured during the service test", - "$ref": "../Common/Characteristic.schema.json#Characteristic" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TestMeasure.schema.json", + "title": "TestMeasure", + "definitions": { + "TestMeasure": { + "$id": "#TestMeasure", + "description": "A TestMeasure specifies a measure of a specific aspect of a product, service, or resource test, such as lost packets or connectivity status", + "type": "object", + "properties": { + "accuracy": { + "type": "number", + "format": "float", + "description": "The number of digits of accuracy captured for associated Metrics" + }, + "captureDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time that the metric was captured" + }, + "captureMethod": { + "type": "string", + "description": "The method used to capture the Metrics (This may be replaced by a set of entities similar to the Performance Monitoring Ref)" + }, + "metricDescription": { + "type": "string", + "description": "Brief description of the metric" + }, + "metricHref": { + "type": "string", + "description": "Hyperlink to access a metric for detail information" + }, + "metricName": { + "type": "string", + "description": "The name of the metric" + }, + "ruleViolation": { + "type": "array", + "description": "A list of rules that were violated in this test measure", + "items": { + "$ref": "../Service/MeasureThresholdRuleViolation.schema.json#MeasureThresholdRuleViolation" + } + }, + "unitOfMeasure": { + "type": "string", + "description": "The unit of measure for the metric values, such as meters, cubic yards, kilograms [ISO 1000]." + }, + "value": { + "description": "The value of Metric in the test. This also could be a document to record all values captured during the service test", + "$ref": "../Common/Characteristic.schema.json#Characteristic" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/TestMeasureDefinition.schema.json b/Service/TestMeasureDefinition.schema.json index 76777c34..c09d8426 100644 --- a/Service/TestMeasureDefinition.schema.json +++ b/Service/TestMeasureDefinition.schema.json @@ -1,66 +1,66 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TestMeasureDefinition.schema.json", - "title": "TestMeasureDefinition", - "definitions": { - "TestMeasureDefinition": { - "$id": "#TestMeasureDefinition", - "description": "A TestMeasureDefinition specifies a measure of a specific aspect of a product, service, or resource test, such as lost packets or connectivity status", - "type": "object", - "properties": { - "captureFrequency": { - "type": "string", - "description": "The frequency of capture for the metric. Note: This may be replaced by a set of entities similar to the Performance Monitoring" - }, - "captureMethod": { - "type": "string", - "description": "The method used to capture the Metric. Note: This may be replaced by a set of entities similar to the Performance Monitoring" - }, - "capturePeriod": { - "$ref": "../Common/Duration.schema.json#Duration", - "description": "A period of the capture" - }, - "metricDescription": { - "type": "string", - "description": "Brief description of the metric" - }, - "metricHref": { - "type": "string", - "description": "Hyperlink to access a metric for detail information" - }, - "metricName": { - "type": "string", - "description": "The name of a metric that in the test measure" - }, - "name": { - "type": "string", - "description": "The name of the TestMeasureDefinition" - }, - "unitOfMeasure": { - "type": "string", - "description": "Name of a service test specification" - }, - "validFor": { - "$ref": "../Common/TimePeriod.schema.json#TimePeriod", - "description": "The time period for which this definition is valid" - }, - "valueType": { - "type": "string", - "description": "A kind of value that the Metric value can take on, such as numeric, text, and so forth" - }, - "thresholdRule": { - "type": "array", - "description": "The rule(s) associated with the measure threshold", - "items": { - "$ref": "MetricDefMeasureThresholdRule.schema.json#MetricDefMeasureThresholdRule" - } - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TestMeasureDefinition.schema.json", + "title": "TestMeasureDefinition", + "definitions": { + "TestMeasureDefinition": { + "$id": "#TestMeasureDefinition", + "description": "A TestMeasureDefinition specifies a measure of a specific aspect of a product, service, or resource test, such as lost packets or connectivity status", + "type": "object", + "properties": { + "captureFrequency": { + "type": "string", + "description": "The frequency of capture for the metric. Note: This may be replaced by a set of entities similar to the Performance Monitoring" + }, + "captureMethod": { + "type": "string", + "description": "The method used to capture the Metric. Note: This may be replaced by a set of entities similar to the Performance Monitoring" + }, + "capturePeriod": { + "$ref": "../Common/Duration.schema.json#Duration", + "description": "A period of the capture" + }, + "metricDescription": { + "type": "string", + "description": "Brief description of the metric" + }, + "metricHref": { + "type": "string", + "description": "Hyperlink to access a metric for detail information" + }, + "metricName": { + "type": "string", + "description": "The name of a metric that in the test measure" + }, + "name": { + "type": "string", + "description": "The name of the TestMeasureDefinition" + }, + "unitOfMeasure": { + "type": "string", + "description": "Name of a service test specification" + }, + "validFor": { + "$ref": "../Common/TimePeriod.schema.json#TimePeriod", + "description": "The time period for which this definition is valid" + }, + "valueType": { + "type": "string", + "description": "A kind of value that the Metric value can take on, such as numeric, text, and so forth" + }, + "thresholdRule": { + "type": "array", + "description": "The rule(s) associated with the measure threshold", + "items": { + "$ref": "../Service/MetricDefMeasureThresholdRule.schema.json#MetricDefMeasureThresholdRule" + } } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} diff --git a/Service/TrackingRecord.schema.json b/Service/TrackingRecord.schema.json index 535bed61..4bf3a71f 100644 --- a/Service/TrackingRecord.schema.json +++ b/Service/TrackingRecord.schema.json @@ -1,47 +1,47 @@ { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "TrackingRecord.schema.json", - "title": "TrackingRecord", - "definitions": { - "TrackingRecord": { - "$id": "#TrackingRecord", - "type": "object", - "description": "Tracking records allow the tracking of modifications on the problem. The tracking records should not be embedded in the problem to allow retrieving the problem without the tracking records", - "properties": { - "description": { - "type": "string", - "description": "Describes the action being done, such as: ack, clear" - }, - "extensionInfo": { - "type": "array", - "items": { - "$ref": "../Common/Characteristic.schema.json#Characteristic" - }, - "description": "A generic list of any type of elements. Used for vendor Extensions or loose element encapsulation from other namespaces" - }, - "id": { - "type": "string", - "description": "Identifier of the TrackingRecord" - }, - "systemId": { - "type": "string", - "description": "Describes the system Id from which the action was done" - }, - "time": { - "type": "string", - "format": "date-time", - "description": "Describes the time at which the action was done" - }, - "user": { - "type": "string", - "description": "Describes the user doing the action" - } - }, - "allOf": [ - { - "$ref": "../Common/Entity.schema.json#Entity" - } - ] + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "TrackingRecord.schema.json", + "title": "TrackingRecord", + "definitions": { + "TrackingRecord": { + "$id": "#TrackingRecord", + "type": "object", + "description": "Tracking records allow the tracking of modifications on the problem. The tracking records should not be embedded in the problem to allow retrieving the problem without the tracking records", + "properties": { + "description": { + "type": "string", + "description": "Describes the action being done, such as: ack, clear" + }, + "extensionInfo": { + "type": "array", + "items": { + "$ref": "../Common/Characteristic.schema.json#Characteristic" + }, + "description": "A generic list of any type of elements. Used for vendor Extensions or loose element encapsulation from other namespaces" + }, + "id": { + "type": "string", + "description": "Identifier of the TrackingRecord" + }, + "systemId": { + "type": "string", + "description": "Describes the system Id from which the action was done" + }, + "time": { + "type": "string", + "format": "date-time", + "description": "Describes the time at which the action was done" + }, + "user": { + "type": "string", + "description": "Describes the user doing the action" } + }, + "allOf": [ + { + "$ref": "../Common/Entity.schema.json#Entity" + } + ] } -} \ No newline at end of file + } +} From 21a18a296c2796b14248689fd4f962b15dc8d67e Mon Sep 17 00:00:00 2001 From: Schema validation Bot Date: Fri, 1 Nov 2019 06:53:10 +0000 Subject: [PATCH 11/11] Validation result with ERRORS [skip ci] --- .../validation-20191101T065310Z.txt | 1091 +++++++++++++++++ 1 file changed, 1091 insertions(+) create mode 100644 .circleci/validation_results/validation-20191101T065310Z.txt diff --git a/.circleci/validation_results/validation-20191101T065310Z.txt b/.circleci/validation_results/validation-20191101T065310Z.txt new file mode 100644 index 00000000..134c8b3e --- /dev/null +++ b/.circleci/validation_results/validation-20191101T065310Z.txt @@ -0,0 +1,1091 @@ +SCHEMA VALIDATION +================= +# schemas : 503 files processed +# errors : 15 +# validate ok : 488 +# issues : 220 files / 590 issues + +total time: 4.46 seconds + + +ERROR - schemas with error(s): +... Common/AttachmentRefOrValue.schema.json +... ... isRef property defined, but not included in required + +... Common/ContentType.schema.json +... ... schema mismatch with title (Base64 content structure.) and definitions (ContentType) + +... Common/Entity.schema.json +... ... discriminator (@type) defined but not included in 'required' property + +... Common/RelatedGeographicAddressRefOrValue.schema.json +... ... discriminator (isRef) defined but not included in 'required' property + +... Common/RelatedGeographicLocationRefOrValue.schema.json +... ... discriminator (isRef) defined but not included in 'required' property + +... Customer/BalanceTopupStatus.schema.json +... ... schema mismatch with title (BalanceTopupStatus) and definitions (BalanceTopupStatusType) + +... Customer/ProductOfferingQualificationItemRef.schema.json +... ... ProductOfferingQualificationItemRef requires property "$id" +... ... de-reference check: ENOENT: no such file or directory, open 'Customer/EntityRef.schema.json' + +... EngagedParty/RelatedPartyRefOrValue.schema.json +... ... isRef property defined, but not included in required +... ... discriminator (isRef) defined but not included in 'required' property + +... Product/AlternateProduct.schema.json +... ... isRef property defined, but not included in required + +... Product/BaseProductRefOrValue.schema.json +... ... isRef property defined, but not included in required + +... Product/CancelProductOrder.schema.json +... ... de-reference check: Token "#CancelOrder" does not exist. + +... Product/LoyaltyExecutionPoint.schema.json +... ... LoyaltyAccount additionalProperty "title" exists in instance when not allowed +... ... schema mismatch with title (LoyaltyExecutionPoint) and definitions (LoyaltyAccount) + +... Service/AlternateServiceProposal.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/ServiceRestriction.schema.json' + +... Service/ServiceQualification.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/ServiceRestriction.schema.json' + +... Service/ServiceQualificationItem.schema.json +... ... de-reference check: ENOENT: no such file or directory, open 'Service/ServiceRestriction.schema.json' + + +ISSUES - schemas with issue(s): +... Common/AlternateGeographicAddress.schema.json +... ... geographicLocation :: no description value +... ... geographicSubAddress :: no description value + +... Common/AssociationRoleSpec.schema.json +... ... aggregation :: no description value +... ... defaultQuantity :: no description value +... ... entityType :: no description value +... ... isNavigable :: no description value +... ... isSource :: no description value +... ... maxQuantity :: no description value +... ... minQuantity :: no description value +... ... role :: no description value + +... Common/AssociationSpecification.schema.json +... ... constraint :: no description value +... ... associationRoleSpec :: no description value + +... Common/BusinessInteraction.schema.json +... ... interactionData :: no description value +... ... interactionDataComplete :: no description value +... ... interactionDataStatus :: no description value + +... Common/CalendarEventRef.schema.json +... ... CalendarEventRef :: no properties defined + +... Common/CalendarPeriod.schema.json +... ... timeZone :: recommend to add format +... ... hourPeriod :: no description value + +... Common/ChangeRequest.schema.json +... ... workLog :: no description value +... ... incident :: no description value +... ... changeRequestSpecification :: no description value +... ... impactEntity :: no description value +... ... changeRequestCharacteristic :: no description value +... ... targetEntity :: no description value +... ... resolution :: no description value +... ... sla :: no description value +... ... relateChangeRequest :: no description value +... ... category :: no description value +... ... note :: no description value + +... Common/ChangeRequestSpecification.schema.json +... ... validFor :: no description value + +... Common/Channel.schema.json +... ... Channel :: should be renamed as ChannelRef if this is a reference entity + +... Common/CommonComponents.schema.json +... ... Failing to check for issues: TypeError: Cannot read property 'properties' of undefined + +... Common/CommunicationMessage.schema.json +... ... logFlag :: no description value +... ... tryTimes :: recommend to add format + +... Common/Document.schema.json +... ... binaryAttachment :: no description value +... ... category :: no description value +... ... documentRelationship :: no description value +... ... relatedObject :: no description value + +... Common/DocumentCharacteristic.schema.json +... ... value :: no description value + +... Common/DocumentRelationship.schema.json +... ... documentRef :: no description value + +... Common/EntitySpecRelationship.schema.json +... ... associationSpec :: no description value + +... Common/EntitySpecification.schema.json +... ... attachment :: no description value +... ... entitySchema :: no description value +... ... specCharacteristic :: no description value +... ... relatedParty :: no description value + +... Common/ExternalReference.schema.json +... ... ExternalReference :: should be renamed as ExternalReferenceRef if this is a reference entity + +... Common/GeographicAddress.schema.json +... ... geographicLocation :: no description value +... ... geographicSubAddress :: no description value + +... Common/GeographicAddressValidation.schema.json +... ... validAddress :: no description value +... ... alternateGeographicAddress :: no description value + +... Common/GeographicLocation.schema.json +... ... accuracy :: no description value +... ... spatialRef :: no description value +... ... geometry :: no description value + +... Common/GeographicLocationRef.schema.json +... ... GeographicLocationRef :: no properties defined + +... Common/GeographicSite.schema.json +... ... relatedParty :: no description value +... ... calendar :: no description value +... ... geographicLocation :: no description value +... ... address :: no description value +... ... siteRelationship :: no description value + +... Common/Incident.schema.json +... ... Incident :: should be renamed as IncidentRef if this is a reference entity + +... Common/LocationCharacteristic.schema.json +... ... value :: no description value + +... Common/NetworkFunction.schema.json +... ... NetworkFunction :: should be renamed as NetworkFunctionRef if this is a reference entity + +... Common/Object.schema.json +... ... uri :: no description value + +... Common/Place.schema.json +... ... Place :: should be renamed as PlaceRef if this is a reference entity + +... Common/PlaceRef.schema.json +... ... PlaceRef :: no properties defined + +... Common/Receiver.schema.json +... ... party :: no description value + +... Common/RelatedPlaceRefOrValue.schema.json +... ... role :: no description value + +... Common/Resolution.schema.json +... ... task :: no description value + +... Common/RetrieveGeographicLocation.schema.json +... ... requestedAccuracy :: no description value +... ... status :: no description value +... ... time :: no description value +... ... geographicLocation :: no description value +... ... thing :: no description value + +... Common/RetrieveLocationRelation.schema.json +... ... distance :: no description value +... ... status :: no description value +... ... time :: no description value +... ... intersection :: no description value +... ... location :: no description value + +... Common/Sender.schema.json +... ... party :: no description value + +... Common/SpecCharacteristic.schema.json +... ... specCharacteristicValue :: no description value +... ... specCharRelationship :: no description value + +... Common/Street.schema.json +... ... characteristic :: no description value +... ... address :: no description value + +... Common/StreetSegment.schema.json +... ... address :: no description value + +... Common/TicketRelationship.schema.json +... ... product :: no description value + +... Common/TroubleTicketRef.schema.json +... ... TroubleTicketRef :: no properties defined + +... Common/TroubleTicketRelationship.schema.json +... ... troubleTicket :: no description value + +... Common/Value.schema.json +... ... Value :: no properties defined + +... Common/WorkLog.schema.json +... ... lastUpdateDateTime :: recommend to add format +... ... lastUpdateDateTime :: recommend to add format +... ... record :: no description value + +... Customer/AppliedBillingRate.schema.json +... ... appliedTax :: no description value +... ... bill :: no description value +... ... characteristic :: no description value + +... Customer/AppliedCustomerBillingRate.schema.json +... ... appliedTax :: no description value +... ... bill :: no description value +... ... characteristic :: no description value + +... Customer/AppliedPartyBillingRate.schema.json +... ... appliedTax :: no description value +... ... bill :: no description value +... ... characteristic :: no description value + +... Customer/Appointment.schema.json +... ... attachment :: no description value +... ... contactMedium :: no description value +... ... note :: no description value +... ... relatedEntity :: no description value +... ... relatedParty :: no description value +... ... status :: no description value +... ... validFor :: no description value + +... Customer/Authorization.schema.json +... ... approver :: no description value + +... Customer/BalanceActivity.schema.json +... ... date :: recommend to add format +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceAdjustmentBody.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceAdjustmentRequest.schema.json +... ... requestedDate :: recommend to add format + +... Customer/BalanceDeduct.schema.json +... ... relatedParty :: no description value +... ... product :: no description value +... ... balanceReserve :: no description value +... ... requestor :: no description value +... ... partyAccount :: no description value + +... Customer/BalanceDeductRollback.schema.json +... ... relatedParty :: no description value +... ... product :: no description value +... ... partyAccount :: no description value +... ... balanceDeduct :: no description value +... ... requestor :: no description value + +... Customer/BalanceReserve.schema.json +... ... requestor :: no description value +... ... product :: no description value +... ... relatedParty :: no description value +... ... partyAccount :: no description value + +... Customer/BalanceTopupBody.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceTopupRequest.schema.json +... ... confirmationDate :: recommend to add format +... ... requestedDate :: recommend to add format + +... Customer/BalanceTopupStatusTypeModify.schema.json +... ... BalanceTopupStatusTypeModify :: should be renamed as BalanceTopupStatusTypeModifyRef if this is a reference entity + +... Customer/BalanceTransferBody.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/BalanceTransferRequest.schema.json +... ... confirmationDate :: recommend to add format +... ... requestedDate :: recommend to add format + +... Customer/BalanceTransferStatusTypeModify.schema.json +... ... BalanceTransferStatusTypeModify :: should be renamed as BalanceTransferStatusTypeModifyRef if this is a reference entity +... ... status :: no description value + +... Customer/BalanceUnreserve.schema.json +... ... balanceReserve :: no description value +... ... relatedParty :: no description value +... ... requestor :: no description value +... ... product :: no description value + +... Customer/BankCardMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/Bill.schema.json +... ... billingAccount :: no description value +... ... taxItem :: no description value +... ... paymentMethod :: no description value +... ... relatedParty :: no description value +... ... financialAccount :: no description value + +... Customer/BillFormat.schema.json +... ... BillFormat :: should be renamed as BillFormatRef if this is a reference entity + +... Customer/BillFormatRefOrValue.schema.json +... ... isRef :: no description value + +... Customer/BillPresentationMedia.schema.json +... ... BillPresentationMedia :: should be renamed as BillPresentationMediaRef if this is a reference entity + +... Customer/BillPresentationMediaRefOrValue.schema.json +... ... isRef :: no description value + +... Customer/BillStructure.schema.json +... ... presentationMedia :: no description value +... ... format :: no description value +... ... cycleSpecification :: no description value + +... Customer/BillingAccount.schema.json +... ... BillingAccount :: no properties defined + +... Customer/BillingCycleSpecification.schema.json +... ... billingDateShift :: recommend to add format +... ... chargeDateOffset :: recommend to add format +... ... creditDateOffset :: recommend to add format +... ... mailingDateOffset :: recommend to add format +... ... paymentDueDateOffset :: recommend to add format + +... Customer/BillingCycleSpecificationRef.schema.json +... ... dateShift :: recommend to add format + +... Customer/BillingCycleSpecificationRefOrValue.schema.json +... ... isRef :: no description value + +... Customer/CartItem.schema.json +... ... itemTerm :: no description value +... ... cartItem :: no description value +... ... note :: no description value +... ... ItemTotalPrice :: no description value +... ... product :: no description value +... ... itemPrice :: no description value +... ... productOffering :: no description value +... ... cartItemRelationship :: no description value + +... Customer/CartItemRelationship.schema.json +... ... cartItem :: no description value + +... Customer/CartPrice.schema.json +... ... price :: no description value +... ... priceAlteration :: no description value + +... Customer/CartTerm.schema.json +... ... description :: no description value +... ... duration :: no description value + +... Customer/CashDetails.schema.json +... ... CashDetails :: no properties defined + +... Customer/CashMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/CheckMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/Customer.schema.json +... ... engagedParty :: no description value +... ... account :: no description value +... ... paymentMethod :: no description value +... ... contactMedium :: no description value +... ... creditProfile :: no description value +... ... agreement :: no description value +... ... relatedParty :: no description value + +... Customer/CustomerBill.schema.json +... ... billingAccount :: no description value +... ... taxItem :: no description value +... ... paymentMethod :: no description value +... ... relatedParty :: no description value +... ... financialAccount :: no description value + +... Customer/DigitalWalletMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/Disability.schema.json +... ... validFor :: no description value + +... Customer/OrderItem.schema.json +... ... appointment :: no description value +... ... billingAccount :: no description value +... ... itemPrice :: no description value +... ... orderItem :: no description value +... ... orderItemRelationship :: no description value +... ... itemTotalPrice :: no description value +... ... payment :: no description value +... ... productOffering :: no description value +... ... product :: no description value +... ... qualification :: no description value +... ... itemTerm :: no description value + +... Customer/OrderItemPrice.schema.json +... ... productOfferingPrice :: no description value +... ... billingAccount :: no description value +... ... price :: no description value +... ... priceAlteration :: no description value + +... Customer/OrderItemRelationship.schema.json +... ... OrderItemRelationship :: should be renamed as OrderItemRelationshipRef if this is a reference entity + +... Customer/OrderRelationship.schema.json +... ... OrderRelationship :: should be renamed as OrderRelationshipRef if this is a reference entity + +... Customer/PaymentItem.schema.json +... ... payment :: no description value + +... Customer/PaymentMethod.schema.json +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/PaymentMethodRefOrValue.schema.json +... ... type :: rename to avoid conflict with @type + +... Customer/PaymentPlan.schema.json +... ... paymentMethod :: no description value + +... Customer/ProductOrder.schema.json +... ... billingAccount :: no description value +... ... channel :: no description value +... ... note :: no description value +... ... orderTotalPrice :: no description value +... ... payment :: no description value +... ... productOfferingQualification :: no description value +... ... quote :: no description value +... ... productOrderItem :: no description value +... ... relatedParty :: no description value + +... Customer/ProductOrderItem.schema.json +... ... appointment :: no description value +... ... billingAccount :: no description value +... ... itemPrice :: no description value +... ... itemTerm :: no description value +... ... itemTotalPrice :: no description value +... ... payment :: no description value +... ... product :: no description value +... ... productOffering :: no description value +... ... productOfferingQualificationItem :: no description value +... ... quoteItem :: no description value +... ... productOrderItem :: no description value +... ... productOrderItemRelationship :: no description value +... ... qualification :: no description value + +... Customer/ProductOrderRef.schema.json +... ... ProductOrderRef :: no properties defined + +... Customer/QueryProductRecommendation.schema.json +... ... description :: no description value +... ... order :: no description value +... ... channel :: no description value +... ... relatedParty :: no description value +... ... item :: no description value + +... Customer/QuoteItem.schema.json +... ... product :: no description value +... ... productOffering :: no description value + +... Customer/QuoteItemRelationship.schema.json +... ... QuoteItemRelationship :: should be renamed as QuoteItemRelationshipRef if this is a reference entity + +... Customer/QuotePrice.schema.json +... ... priceAlteration :: no description value +... ... price :: no description value + +... Customer/QuoteRef.schema.json +... ... QuoteRef :: no properties defined + +... Customer/SearchTimeSlot.schema.json +... ... status :: no description value +... ... requestedTimeSlot :: no description value +... ... requestedTimeSlot :: recommend to add format +... ... availableTimeSlot :: no description value +... ... availableTimeSlot :: recommend to add format +... ... relatedEntity :: no description value + +... Customer/SettlementNoteAdvice.schema.json +... ... settlementMethod :: no description value +... ... settlementNoteImage :: no description value +... ... receiver :: no description value +... ... taxItem :: no description value +... ... issuer :: no description value +... ... settlementNoteItem :: no description value + +... Customer/SettlementNoteImage.schema.json +... ... imageFileURL :: recommend to add format + +... Customer/SettlementNoteItem.schema.json +... ... period :: no description value +... ... taxItem :: no description value + +... Customer/ShoppingCart.schema.json +... ... contactMedium :: no description value +... ... cartItem :: no description value +... ... relatedParty :: no description value + +... Customer/TokenizedCardMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... Customer/VoucherMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/Account.schema.json +... ... relatedParty :: no description value +... ... taxExemption :: no description value +... ... contact :: no description value +... ... accountBalance :: no description value +... ... accountRelationship :: no description value + +... EngagedParty/AccountDirectDetails.schema.json +... ... AccountDirectDetails :: should be renamed as AccountDirectDetailsRef if this is a reference entity +... ... account :: no description value + +... EngagedParty/AccountDirectMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/AccountRelationship.schema.json +... ... account :: no description value + +... EngagedParty/AccountTaxExemption.schema.json +... ... issuingJurisdiction :: recommend to add format + +... EngagedParty/Agreement.schema.json +... ... completionDate :: recommend to add format +... ... agreementSpecification :: no description value +... ... agreementItem :: no description value +... ... engagedPartyRole :: no description value +... ... agreementAuthorization :: no description value +... ... characteristic :: no description value +... ... associatedAgreement :: no description value + +... EngagedParty/AgreementItem.schema.json +... ... termOrCondition :: no description value + +... EngagedParty/AgreementSpecCharacteristic.schema.json +... ... specCharacteristicValue :: no description value + +... EngagedParty/AgreementSpecification.schema.json +... ... serviceCategory :: no description value +... ... specificationCharacteristic :: no description value +... ... relatedParty :: no description value +... ... attachment :: no description value +... ... specificationRelationship :: no description value + +... EngagedParty/BankAccountDebitMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/BankAccountTransferMethod.schema.json +... ... details :: no description value +... ... status :: no description value +... ... statusDate :: no description value +... ... relatedParty :: no description value +... ... account :: no description value + +... EngagedParty/Contact.schema.json +... ... contactMedium :: no description value +... ... relatedParty :: no description value + +... EngagedParty/FinancialAccount.schema.json +... ... FinancialAccount :: no properties defined + +... EngagedParty/FinancialAccountRef.schema.json +... ... accountBalance :: no description value + +... EngagedParty/Individual.schema.json +... ... otherName :: no description value +... ... individualIdentification :: no description value +... ... disability :: no description value +... ... languageAbility :: no description value +... ... skill :: no description value + +... EngagedParty/IndividualIdentification.schema.json +... ... attachment :: no description value + +... EngagedParty/LanguageAbility.schema.json +... ... isFavouriteLanguage :: recommend to add format +... ... validFor :: no description value + +... EngagedParty/Organization.schema.json +... ... existsDuring :: no description value +... ... existsDuring :: recommend to add format +... ... otherName :: no description value +... ... organizationIdentification :: no description value +... ... organizationChildRelationship :: no description value +... ... organizationParentRelationship :: no description value + +... EngagedParty/OrganizationChildRelationship.schema.json +... ... organization :: no description value + +... EngagedParty/OrganizationIdentification.schema.json +... ... attachment :: no description value + +... EngagedParty/OrganizationParentRelationship.schema.json +... ... organization :: no description value + +... EngagedParty/OrganizationRef.schema.json +... ... OrganizationRef :: no properties defined + +... EngagedParty/OtherNameIndividual.schema.json +... ... validFor :: no description value + +... EngagedParty/OtherNameOrganization.schema.json +... ... validFor :: no description value + +... EngagedParty/Partner.schema.json +... ... account :: no description value +... ... paymentMethod :: no description value +... ... contactMedium :: no description value +... ... creditProfile :: no description value +... ... agreement :: no description value +... ... relatedParty :: no description value + +... EngagedParty/PartnershipType.schema.json +... ... roleType :: no description value + +... EngagedParty/Party.schema.json +... ... externalReference :: no description value +... ... partyCharacteristic :: no description value +... ... taxExemptionCertificate :: no description value +... ... creditRating :: no description value +... ... relatedParty :: no description value +... ... contactMedium :: no description value + +... EngagedParty/PartyAccount.schema.json +... ... billStructure :: no description value +... ... paymentPlan :: no description value +... ... financialAccount :: no description value +... ... defaultPaymentMethod :: no description value + +... EngagedParty/PartyBill.schema.json +... ... billingAccount :: no description value +... ... taxItem :: no description value +... ... paymentMethod :: no description value +... ... relatedParty :: no description value +... ... financialAccount :: no description value + +... EngagedParty/PartyCreditProfile.schema.json +... ... validFor :: no description value + +... EngagedParty/PartyRef.schema.json +... ... PartyRef :: no properties defined + +... EngagedParty/PartyRole.schema.json +... ... engagedParty :: no description value +... ... account :: no description value +... ... paymentMethod :: no description value +... ... contactMedium :: no description value +... ... creditProfile :: no description value +... ... agreement :: no description value +... ... relatedParty :: no description value + +... EngagedParty/RoleSpecification.schema.json +... ... agreementSpecification :: no description value + +... EngagedParty/RoleType.schema.json +... ... agreementSpecification :: no description value + +... EngagedParty/Rule.schema.json +... ... consequence :: no description value +... ... metric :: no description value +... ... operator :: no description value +... ... referenceValue :: no description value +... ... tolerance :: no description value +... ... unit :: no description value + +... EngagedParty/RuleRef.schema.json +... ... description :: no description value + +... EngagedParty/SLA.schema.json +... ... approvalDate :: no description value +... ... approved :: no description value +... ... rule :: no description value +... ... relatedParty :: no description value +... ... template :: no description value + +... EngagedParty/SLAViolation.schema.json +... ... date :: no description value +... ... relatedParty :: no description value +... ... violation :: no description value +... ... sla :: no description value + +... EngagedParty/SettlementAccount.schema.json +... ... SettlementAccount :: no properties defined + +... EngagedParty/Skill.schema.json +... ... validFor :: no description value + +... EngagedParty/TaxExemptionCertificate.schema.json +... ... taxDefinition :: no description value +... ... validFor :: no description value +... ... attachment :: no description value + +... EngagedParty/TemplateRef.schema.json +... ... description :: no description value + +... EngagedParty/Violation.schema.json +... ... actualValue :: no description value +... ... comment :: no description value +... ... consequence :: no description value +... ... operator :: no description value +... ... referenceValue :: no description value +... ... tolerance :: no description value +... ... unit :: no description value +... ... violationAverage :: no description value +... ... attachment :: no description value +... ... rule :: no description value + +... MarketingSales/MarketingCampaignRef.schema.json +... ... MarketingCampaignRef :: no properties defined + +... MarketingSales/SalesLead.schema.json +... ... status :: no description value +... ... type :: rename to avoid conflict with @type +... ... priority :: no description value +... ... channel :: no description value +... ... productOffering :: no description value +... ... relatedParty :: no description value +... ... prospectContact :: no description value +... ... productSpecification :: no description value +... ... category :: no description value +... ... salesOpportunity :: no description value +... ... product :: no description value +... ... note :: no description value + +... MarketingSales/SalesOpportunityRef.schema.json +... ... SalesOpportunityRef :: no properties defined + +... Product/BundledProductOfferingPriceRelationship.schema.json +... ... BundledProductOfferingPriceRelationship :: should be renamed as BundledProductOfferingPriceRelationshipRef if this is a reference entity + +... Product/BundledProductSpecification.schema.json +... ... BundledProductSpecification :: should be renamed as BundledProductSpecificationRef if this is a reference entity + +... Product/LoyaltyAccount.schema.json +... ... LoyaltyAccount :: should be renamed as LoyaltyAccountRef if this is a reference entity +... ... loyaltyProgramProduct :: no description value + +... Product/LoyaltyAction.schema.json +... ... type :: rename to avoid conflict with @type + +... Product/LoyaltyEvent.schema.json +... ... eventId :: no description value +... ... eventTime :: recommend to add format + +... Product/LoyaltyEventType.schema.json +... ... LoyaltyEventType :: should be renamed as LoyaltyEventTypeRef if this is a reference entity + +... Product/LoyaltyProgramProduct.schema.json +... ... loyaltyProgramProductSpec :: no description value +... ... loyaltyAccount :: no description value +... ... validFor :: no description value + +... Product/LoyaltyProgramProductSpec.schema.json +... ... productNumber :: no description value +... ... ValidFor :: no description value + +... Product/LoyaltyRuleAction.schema.json +... ... LoyaltyRuleAction :: should be renamed as LoyaltyRuleActionRef if this is a reference entity + +... Product/LoyaltyRuleCondition.schema.json +... ... LoyaltyRuleCondition :: should be renamed as LoyaltyRuleConditionRef if this is a reference entity + +... Product/LoyaltyRuleEventType.schema.json +... ... LoyaltyRuleEventType :: should be renamed as LoyaltyRuleEventTypeRef if this is a reference entity + +... Product/PriceAlteration.schema.json +... ... productOfferingPrice :: no description value +... ... price :: no description value + +... Product/Product.schema.json +... ... agreement :: no description value +... ... billingAccount :: no description value +... ... productCharacteristic :: no description value +... ... productOffering :: no description value +... ... productOrderItem :: no description value +... ... product :: no description value +... ... productPrice :: no description value +... ... productRelationship :: no description value +... ... productSpecification :: no description value +... ... productTerm :: no description value +... ... realizingResource :: no description value +... ... realizingService :: no description value +... ... relatedParty :: no description value +... ... place :: no description value + +... Product/ProductInventoryRelationship.schema.json +... ... product :: no description value + +... Product/ProductOffering.schema.json +... ... serviceCandidate :: recommend to add format +... ... resourceCandidate :: recommend to add format + +... Product/ProductOfferingPriceRef.schema.json +... ... ProductOfferingPriceRef :: no properties defined + +... Product/ProductOfferingPriceRelationship.schema.json +... ... ProductOfferingPriceRelationship :: should be renamed as ProductOfferingPriceRelationshipRef if this is a reference entity + +... Product/ProductOfferingQualification.schema.json +... ... category :: no description value +... ... place :: no description value + +... Product/ProductOfferingQualificationItem.schema.json +... ... eligibilityUnavailabilityReason :: no description value +... ... qualificationItemRelationship :: no description value +... ... note :: no description value +... ... product :: no description value +... ... terminationError :: no description value +... ... productOffering :: no description value +... ... alternateProductOfferingProposal :: no description value + +... Product/ProductOfferingQualificationRef.schema.json +... ... ProductOfferingQualificationRef :: no properties defined + +... Product/ProductOfferingRef.schema.json +... ... ProductOfferingRef :: no properties defined + +... Product/ProductPrice.schema.json +... ... productOfferingPrice :: no description value +... ... billingAccount :: no description value +... ... productPriceAlteration :: no description value +... ... price :: no description value + +... Product/ProductRef.schema.json +... ... ProductRef :: no properties defined + +... Product/ProductRefOrValue.schema.json +... ... ProductRefOrValue :: no properties defined + +... Product/ProductRelationship.schema.json +... ... product :: no description value + +... Product/ProductRequest.schema.json +... ... referredProduct :: no description value +... ... realizingService :: no description value +... ... billingAccount :: no description value +... ... productOffering :: no description value +... ... agreement :: no description value +... ... characteristic :: no description value +... ... productRelationship :: no description value +... ... realizingResource :: no description value +... ... relatedParty :: no description value +... ... productPrice :: no description value +... ... productSpecification :: no description value +... ... place :: no description value + +... Product/ProductRestriction.schema.json +... ... productCharacteristic :: no description value +... ... productRelationship :: no description value +... ... relatedParty :: no description value +... ... productSpecification :: no description value +... ... relatedPlace :: no description value + +... Product/ProductSpecCharacteristic.schema.json +... ... productSpecCharRelationship :: no description value +... ... productSpecCharacteristicValue :: no description value + +... Product/Promotion.schema.json +... ... pattern :: no description value + +... Product/PromotionCriteriaGroup.schema.json +... ... criteria :: no description value + +... Product/PromotionPattern.schema.json +... ... action :: no description value +... ... criteriaGroup :: no description value + +... Product/QualificationItemRelationship.schema.json +... ... QualificationItemRelationship :: should be renamed as QualificationItemRelationshipRef if this is a reference entity + +... Product/Recommendation.schema.json +... ... description :: no description value +... ... order :: no description value +... ... channel :: no description value +... ... party :: no description value +... ... item :: no description value + +... Product/Usage.schema.json +... ... usageSpecification :: no description value +... ... usageCharacteristic :: no description value +... ... relatedParty :: no description value +... ... ratedProductUsage :: no description value + +... Product/UsageConsumptionReport.schema.json +... ... relatedParty :: no description value + +... Product/UsageSpecCharacteristic.schema.json +... ... usageSpecCharacteristicValue :: no description value + +... Product/UsageSpecification.schema.json +... ... usageSpecCharacteristic :: no description value + +... Product/UsageVolumeProduct.schema.json +... ... bucketBalance :: no description value +... ... bucketCounter :: no description value +... ... product :: no description value + +... Resource/LogicalResource.schema.json +... ... resourceRelationship :: no description value +... ... characteristic :: no description value +... ... place :: no description value +... ... partyRole :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/PhysicalResource.schema.json +... ... resourceRelationship :: no description value +... ... characteristic :: no description value +... ... place :: no description value +... ... partyRole :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/RealizingResourceRef.schema.json +... ... RealizingResourceRef :: no properties defined + +... Resource/Resource.schema.json +... ... resourceRelationship :: no description value +... ... characteristic :: no description value +... ... place :: no description value +... ... partyRole :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/ResourceAlarmRef.schema.json +... ... changeRequest :: no description value + +... Resource/ResourceOrder.schema.json +... ... orderRelationship :: no description value +... ... relatedParty :: no description value +... ... note :: no description value + +... Resource/ResourceOrderItem.schema.json +... ... resourceSpecification :: no description value +... ... orderItemRelationship :: no description value + +... Resource/ResourceOrderItemRelationship.schema.json +... ... orderItem :: no description value + +... Resource/ResourceOrderRelationship.schema.json +... ... resourceOrder :: no description value +... ... serviceOrder :: no description value + +... Resource/SupportingResource.schema.json +... ... SupportingResource :: should be renamed as SupportingResourceRef if this is a reference entity + +... Service/FirstAlert.schema.json +... ... FirstAlert :: should be renamed as FirstAlertRef if this is a reference entity + +... Service/Service.schema.json +... ... serviceDate :: recommend to add format + +... Service/ServiceCategory.schema.json +... ... serviceCandidate :: recommend to add format + +... Service/ServiceLevelObjective.schema.json +... ... graceTimes :: recommend to add format + +... Service/ServiceOrder.schema.json +... ... orderDate :: no description value + +... Service/ServiceOrderItemRelationship.schema.json +... ... ServiceOrderItemRelationship :: should be renamed as ServiceOrderItemRelationshipRef if this is a reference entity + +... Service/ServiceQualificationItemRelationship.schema.json +... ... ServiceQualificationItemRelationship :: should be renamed as ServiceQualificationItemRelationshipRef if this is a reference entity + +... Service/ServiceQualificationRelationship.schema.json +... ... ServiceQualificationRelationship :: should be renamed as ServiceQualificationRelationshipRef if this is a reference entity + +... Service/ServiceRef.schema.json +... ... ServiceRef :: no properties defined + +... Service/SupportingService.schema.json +... ... SupportingService :: should be renamed as SupportingServiceRef if this is a reference entity + +... Common/AttachmentRefOrValue.schema.json +... ... url :: recommend to add format +... ... isRef :: no description value + +... Common/ContentType.schema.json +... ... Failing to check for issues: TypeError: Cannot read property 'properties' of undefined + +... Common/RelatedGeographicAddressRefOrValue.schema.json +... ... isRef :: no description value +... ... role :: no description value + +... Common/RelatedGeographicLocationRefOrValue.schema.json +... ... isRef :: no description value +... ... role :: no description value + +... Customer/BalanceTopupStatus.schema.json +... ... Failing to check for issues: TypeError: Cannot read property 'properties' of undefined + +... EngagedParty/RelatedPartyRefOrValue.schema.json +... ... isRef :: no description value +... ... role :: no description value + +... Product/AlternateProduct.schema.json +... ... productCharacteristic :: no description value +... ... productRelationship :: no description value +... ... productSpecification :: no description value + +... Product/BaseProductRefOrValue.schema.json +... ... productCharacteristic :: no description value +... ... realizingResource :: no description value +... ... realizingService :: no description value +... ... productRelationship :: no description value +... ... relatedParty :: no description value +... ... productSpecification :: no description value +... ... relatedPlace :: no description value + +... Product/CancelProductOrder.schema.json +... ... CancelProductOrder :: should be renamed as CancelProductOrderRef if this is a reference entity +... ... productOrder :: no description value + +... Product/LoyaltyExecutionPoint.schema.json +... ... Failing to check for issues: TypeError: Cannot read property 'properties' of undefined + +... Service/AlternateServiceProposal.schema.json +... ... alternateService :: no description value +