diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index 41399ba..e93b813 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -2329,6 +2329,8 @@ paths: - businessOwner - rejectionProcessing - rejectionInfo + - validFrom + - validUntil - name: $select in: query description: Select properties to be returned @@ -2349,6 +2351,8 @@ paths: - businessOwner - rejectionProcessing - rejectionInfo + - validFrom + - validUntil responses: "200": description: OK @@ -2372,6 +2376,8 @@ paths: businessOwner: Koos Verweg rejectionProcessing: system rejectionInfo: api.htm.nl/v2/account/12345/msgs/abc + validFrom: 2025-01-01T00:00.000 + validUntil: null - "@odata.etag": 4b743da5-4195-4b2e-a11b-6e5393a94c0a sourceMetadataRowId: 3 sourceMetadataId: c3a9ef01-06c6-4c05-8fc7-df825f676dfc @@ -2381,6 +2387,8 @@ paths: businessOwner: Danny Negen rejectionProcessing: mail rejectionInfo: d.negen@htm.nl + validFrom: 2025-01-01T00:00.000 + validUntil: null - "@odata.etag": 502e2f58-b4e1-4dd0-947a-db6eea726e3a sourceMetadataRowId: 4 sourceMetadataId: 0b6e3e07-c4e0-42bf-86f2-9c9522b71209 @@ -2390,6 +2398,8 @@ paths: businessOwner: Guus Geluk rejectionProcessing: mail rejectionInfo: ao@htm.nl + validFrom: 2025-01-01T00:00.000 + validUntil: null security: - default: [] x-auth-type: Application & Application User @@ -2417,6 +2427,8 @@ paths: businessOwner: Danny Negen rejectionProcessing: mail rejectionInfo: d.negen@htm.nl + validFrom: 2025-01-01T00:00.000 + validUntil: null responses: "201": description: Created @@ -2456,9 +2468,26 @@ paths: schema: $ref: "#/components/schemas/SourceMetadataPatchRequestBody" examples: - Update a source in the metadata: - summary: Update a source in the metadata - description: In this example we update the business owner of a single source meta data + Update a source: + summary: Update a source + description: In this example we update a single source. + value: + incomingName: HTM-app + incomingEntity: OrderLine + outgoingName: ticketapp + businessOwner: Danny Negen + rejectionProcessing: mail + rejectionInfo: d.negen@htm.nl + validFrom: 2025-01-01T00:00.000 + validUntil: 2025-01-31T23:59:59.999 + Update a source validity: + summary: Update a source validity + description: In this example we update the validity of a single source. + value: + validUntil: 2025-01-31T23:59:59.999 + Update a business owner of a source: + summary: Update a business owner of a source + description: In this example we update the business owner of a single source. value: businessOwner: Chef Erwin responses: @@ -2478,6 +2507,20 @@ paths: - default: [] x-auth-type: Application & Application User x-throttling-tier: Unlimited + delete: + summary: Delete source metadata. + description: | + Delete source metadata. Note that source metadata can only be deleted + if the validFrom is in the future. + tags: + - Metadata v2.2 + responses: + "200": + description: OK + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited /Odata/AccountingPeriodMetadata: get: summary: Find accounting period metadata. @@ -4390,6 +4433,15 @@ components: rejectionInfo: type: string example: api.htm.nl/v2/account/12345/msgs/abc + validFrom: + type: string + format: date-time + example: 2025-01-01T00:00:00.000 + validUntil: + type: string + format: date-time + example: null + nullable: true required: - sourceMetadataId - incomingName @@ -4420,6 +4472,15 @@ components: rejectionInfo: type: string example: api.htm.nl/v2/account/12345/msgs/abc + validFrom: + type: string + format: date-time + example: 2025-01-01T00:00:00.000 + validUntil: + type: string + format: date-time + example: null + nullable: true required: - incomingName - incomingEntity @@ -4427,6 +4488,7 @@ components: - businessOwner - rejectionProcessing - rejectionInfo + - validFrom SourceMetadataPostResponseBody: type: object properties: @@ -4442,21 +4504,37 @@ components: incomingName: type: string example: HTM-website + nullable: true incomingEntity: type: string example: OrderLine + nullable: true outgoingName: type: string example: Website Verkopen + nullable: true businessOwner: type: string example: Koos Verweg + nullable: true rejectionProcessing: type: string example: system + nullable: true rejectionInfo: type: string example: api.htm.nl/v2/account/12345/msgs/abc + nullable: true + validFrom: + type: string + format: date-time + example: 2025-01-01T00:00:00.000 + nullable: true + validUntil: + type: string + format: date-time + example: null + nullable: true SourceMetadataPatchResponseBody: type: object properties: