diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index 33fb229..3c5c830 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -8,12 +8,12 @@ info: servers: - url: https://api.integratielaag.nl/fiko/1.0 paths: - /transactionitems: + /Odata/TransactionItem: get: - summary: P1. Find transaction items. + summary: Find transaction items. description: Find transaction items. tags: - - Transactions v2.2 + - Odata parameters: - $ref: "#/components/parameters/top" - $ref: "#/components/parameters/skip" @@ -201,6 +201,11 @@ paths: aggregationReference: FIKO-6a4fca8cd6 accountingSystemReference: U4F-123456 href: null + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited + /transactionitems: post: summary: P1. Add one ore more finanicial transaction items in bulk. description: Add one ore more finanicial transaction items in bulk. @@ -496,12 +501,12 @@ paths: The transactionAuditTrailId is returned as a reference for the consumer. value: transactionAuditTrailId: 37a8095b-19db-498f-9349-5f37d21c5bdf - /transactionaudittrails: + /Odata/TransactionAuditTrail: get: - summary: P3. Find audit trail entries. + summary: Find audit trail entries. description: Find audit trail entries. tags: - - Audit Trail v2.2 + - Odata parameters: - $ref: "#/components/parameters/top" - $ref: "#/components/parameters/skip" @@ -688,12 +693,16 @@ paths: description: Validation XYZ failed. correlationId: null href: null - /processingfailures: + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited + /Odata/ProcessingFailure: get: - summary: P1.Find processing failures. + summary: Find processing failures. description: Find processing failures. tags: - - Failures v2.2 + - Odata parameters: - $ref: "#/components/parameters/top" - $ref: "#/components/parameters/skip" @@ -842,6 +851,10 @@ paths: resolved: false change: null href: null + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited /processingfailures/{processingFailureId}: parameters: - in: path @@ -884,12 +897,12 @@ paths: description: The processing failure has been updated successfully. value: processingFailureId: 37a8095b-19db-498f-9349-5f37d21c5bdf - /bookingprocesses: + /Odata/BookingProcess: get: - summary: P1. Find booking processes. + summary: Find booking processes. description: Find booking processes. tags: - - Booking Processes v2.2 + - Odata parameters: - $ref: "#/components/parameters/top" - $ref: "#/components/parameters/skip" @@ -951,6 +964,11 @@ paths: transactionType: purchase identifyingFieldName: null href: null + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited + /bookingprocesses: post: summary: P2. Add a booking process. description: Add a booking process. @@ -1075,12 +1093,12 @@ paths: description: The new booking metadata was successfully added to the database. value: bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - /bookingmetadata: + /Odata/BookingMetadata: get: - summary: P1. Find booking metadata. + summary: Find booking metadata. description: Find booking metadata. tags: - - Booking Processes v2.2 + - Odata parameters: - $ref: "#/components/parameters/top" - $ref: "#/components/parameters/skip" @@ -1187,6 +1205,10 @@ paths: validFrom: 2022-01-01 00:00:00 validUntil: null href: null + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited /bookingmetadata/{bookingMetadataId}: parameters: - in: path @@ -1339,12 +1361,12 @@ paths: description: The new booking line metadata was successfully added to the database. value: bookingLineMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - /bookinggroupfields: + /Odata/BookingGroupField: get: - summary: P1. Find booking group fields. + summary: Find booking group fields. description: Find booking group fields. tags: - - Booking Processes v2.2 + - Odata parameters: - $ref: "#/components/parameters/top" - $ref: "#/components/parameters/skip" @@ -1459,6 +1481,10 @@ paths: bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 identifyingFieldValue: 4055 href: null + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited /bookinggroupfields/{bookingGroupFieldId}: parameters: - in: path @@ -1477,12 +1503,12 @@ paths: responses: "200": description: OK - /bookinglinemetadata: + /Odata/BookingLineMetadata: get: - summary: P1. Find booking line metadata. + summary: Find booking line metadata. description: Find booking line metadata. tags: - - Booking Processes v2.2 + - Odata parameters: - $ref: "#/components/parameters/top" - $ref: "#/components/parameters/skip" @@ -1750,6 +1776,10 @@ paths: extRef5: null extRef6: null href: null + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited /bookinglinemetadata/{bookingLineMetadataId}: parameters: - in: path @@ -1799,12 +1829,12 @@ paths: responses: "200": description: OK - /taxmetadata: + /Odata/TaxMetadata: get: - summary: P1. Find tax metadata. + summary: Find tax metadata. description: Find tax metadata. tags: - - Metadata v2.2 + - Odata parameters: - $ref: "#/components/parameters/top" - $ref: "#/components/parameters/skip" @@ -1898,6 +1928,11 @@ paths: validFrom: 2024-03-22T09:00:00 validUntil: null href: null + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited + /taxmetadata: post: summary: P3. Add tax metadata. description: Add tax metadata. @@ -1972,12 +2007,12 @@ paths: description: The tax metadata was successfully updated in the database. value: taxMetadataId: 7c3a5b0f-b89e-4f02-8b09-d11c5a050a07 - /sourcemetadata: + /Odata/SourceMetadata: get: - summary: P1. Find source metadata. + summary: Find source metadata. description: Find source metadata. tags: - - Metadata v2.2 + - Odata parameters: - $ref: "#/components/parameters/top" - $ref: "#/components/parameters/skip" @@ -2058,6 +2093,11 @@ paths: rejectionProcessing: mail rejectionInfo: ao@htm.nl href: null + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited + /sourcemetadata: post: summary: P3. Add source metadata. description: Add source metadata. @@ -2133,12 +2173,12 @@ paths: description: The source metadata was successfully updated in the database. value: sourceMetadataId: 37a8095b-19db-498f-9349-5f37d21c5bdf - /accountingperiodmetadata: + /Odata/AccountingPeriodMetadata: get: - summary: P1. Find accounting period metadata. + summary: Find accounting period metadata. description: Find accounting period metadata. tags: - - Metadata v2.2 + - Odata parameters: - $ref: "#/components/parameters/top" - $ref: "#/components/parameters/skip" @@ -2199,6 +2239,11 @@ paths: accountingPeriod: 2024/11 isOpen: false href: null + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited + /accountingperiodmetadata: post: summary: P2. Add accounting period metadata. description: Add accounting period metadata. @@ -2270,12 +2315,12 @@ paths: description: The accounting period metadata was successfully updated in the database. value: accountingPeriodMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 - /concessionmetadata: + /Odata/ConcessionMetadata: get: - summary: P1. Find concession metadata. + summary: Find concession metadata. description: Find concession metadata. tags: - - Metadata v2.2 + - Odata parameters: - $ref: "#/components/parameters/top" - $ref: "#/components/parameters/skip" @@ -2386,6 +2431,7 @@ paths: validFrom: 2024-11-01T00:00:00.000 validUntil: 2024-11-30T23:59:59.999 href: null + /concessionmetadata: post: summary: P2. Add concession metadata. description: Add concession metadata. @@ -2463,126 +2509,53 @@ paths: description: The concession metadata was successfully updated in the database. value: concessionMetadataId: 37a8095b-19db-498f-9349-5f37d21c5bdf - /metadataaudittrails: + /Odata/Concession: get: - summary: Find metadata audit trails. - description: Find metadata audit trails. - deprecated: true + summary: Find concessions. + description: Find concessions. tags: - - Audit Trail v2.2 + - Odata parameters: - - in: query - name: metadataAuditTrailId - schema: - type: string - format: uuid - example: 37a8095b-19db-498f-9349-5f37d21c5bdf - description: The id of the metadata audit trail. - - in: query - name: source - schema: - type: string - example: FMT - description: The source of the metadata change. - - in: query - name: endpoint - schema: - type: string - format: url - example: https://dev.api.htm.nl/v2/productmetadata - description: The endpoint of the metadata change. - - in: query - name: operation + - $ref: "#/components/parameters/top" + - $ref: "#/components/parameters/skip" + - $ref: "#/components/parameters/filter" + - $ref: "#/components/parameters/count" + - name: $orderby + in: query + description: Order items by property values + required: false + style: form + explode: false schema: + uniqueItems: true type: array items: type: string enum: - - GET - - POST - - PATCH - - DELETE - example: POST + - concessionMetadataRowId + - concessionMetadataId + - concessionId + - percentage + - validFrom + - validUntil + - name: $select + in: query + description: Select properties to be returned + required: false + style: form explode: false - description: The operation of the metadata change. - - in: query - name: responseCode schema: - type: integer - example: 200 - description: The HTTP response code of the metadata change. - - in: query - name: requestBody - schema: - type: string - format: json - example: { "json": "data" } - description: The request body of the metadata change. - - in: query - name: responseBody - schema: - type: string - format: json - example: { "json": "data" } - description: The response body of the metadata change. - - in: query - name: user - schema: - type: string - example: ad.vogelaar - description: The id of the user who performed the metadata change. - - in: query - name: timestampBefore - schema: - type: string - format: date-time - example: 2024-01-01T00:00:00.000 - description: The timestamp before the metadata change was made. - - in: query - name: timestampAfter - schema: - type: string - format: date-time - example: 2024-01-01T00:00:00.000 - description: The timestamp after the metadata change was made. - - in: query - name: correlationId - schema: - type: string - example: 37a8095b-19db-498f-9349-5f37d21c5bdf - description: The correlation id of the metadata change. - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: "#/components/schemas/MetadataAuditTrailsGetResponseBody" - post: - summary: Add metadata audit trail. - description: Add metadata audit trail. - deprecated: true - tags: - - Audit Trail v2.2 - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/MetadataAuditTrailsPostRequestBody" - responses: - "201": - description: Created - content: - application/json: - schema: - $ref: "#/components/schemas/MetadataAuditTrailsPostResponseBody" - /concessions: - get: - summary: P1. Get all concessions. - description: Get all concessions. - tags: - - References v2.2 + uniqueItems: true + type: array + items: + type: string + enum: + - concessionMetadataRowId + - concessionMetadataId + - concessionId + - percentage + - validFrom + - validUntil responses: "200": description: OK @@ -2601,6 +2574,10 @@ paths: - concessionId: 2 name: BUS href: null + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited components: securitySchemes: bearerToken: