diff --git a/docs/about-oneground.md b/docs/about-oneground.md index 79ba2a6..ebe8e70 100644 --- a/docs/about-oneground.md +++ b/docs/about-oneground.md @@ -1,20 +1,7 @@ --- -title: "About OneGround - Complete ZGW API Implementation" -description: "OneGround is a comprehensive implementation of Dutch ZGW APIs for case management (Zaakgericht Werken). Learn about ZRC, DRC, ZTC, BRC, NRC, AC components, features, and how to get started with OneGround." -keywords: - - OneGround - - ZGW API - - Zaakgericht Werken - - Dutch case management - - ZRC - - DRC - - ZTC - - BRC - - NRC - - AC - - VNG standards - - government APIs - - API documentation +title: "About OneGround" +description: "Overview of OneGround, a case-oriented API implementation by Roxit, covering its attended and unattended versions, key characteristics, and compliance with ZGW standards." +keywords: ["OneGround", "Roxit", "ZGW", "API", "Case Oriented", "VNG", "SaaS", "Open Source", "ISO-16175"] --- # About OneGround diff --git a/docs/api-versions.md b/docs/api-versions.md index 072dcfb..0662d3c 100644 --- a/docs/api-versions.md +++ b/docs/api-versions.md @@ -1,19 +1,7 @@ --- -title: "ZGW API Versions Supported by OneGround" -description: "Complete overview of supported ZGW API versions in OneGround including ZRC, DRC, ZTC, BRC, NRC, and AC. View current, maintenance, and end-of-life versions with release dates and migration timelines." -keywords: - - ZGW API versions - - OneGround versions - - ZRC versions - - DRC versions - - ZTC versions - - BRC versions - - NRC versions - - AC versions - - API compatibility - - version support - - migration guide -hide_table_of_contents: true +title: "Supported ZGW API Versions" +description: "A list of supported ZGW API versions (AC, NRC, DRC, ZRC, BRC, ZTC) in OneGround, including their current support status and release dates." +keywords: ["API Versions", "ZGW", "AC", "NRC", "DRC", "ZRC", "BRC", "ZTC", "Support Status", "Lifecycle"] --- # Supported ZGW API's versions by OneGround diff --git a/docs/authorizations.md b/docs/authorizations.md index 73436d2..288ef84 100644 --- a/docs/authorizations.md +++ b/docs/authorizations.md @@ -1,16 +1,7 @@ --- -title: "Authorization Management for ZGW APIs in OneGround" -description: "Learn how to configure and manage authorizations for ClientIDs in OneGround ZGW APIs. Set up application permissions, authorization profiles, and secure access controls for your ZGW components." -keywords: - - authorization - - permissions - - ClientID authorization - - ZGW security - - OneGround access control - - application permissions - - authorization profiles - - API security - - access management +title: "Authorizations" +description: "Explanation of how authorizations, applications, and Client IDs function within OneGround, including configuration guidelines and tool limitations." +keywords: ["Authorizations", "OneGround", "ClientID", "Application", "ZGW", "Configuration", "Security"] --- # Authorizations diff --git a/docs/example-document-upload/example-document-upload.md b/docs/example-document-upload/example-document-upload.md index 1ca4842..9aabdab 100644 --- a/docs/example-document-upload/example-document-upload.md +++ b/docs/example-document-upload/example-document-upload.md @@ -1,5 +1,7 @@ --- -title: "Example document upload" +title: "Example Document Upload" +description: "Step-by-step guide and Postman example for uploading documents in parts (bestandsdelen) to the DRC API in OneGround." +keywords: ["Document Upload", "DRC", "ZGW", "OneGround", "File Parts", "Bestandsdelen", "Postman", "API"] --- Attached is an example [Postman project](./examplepm.json) with a sequence for document upload in parts (bestandsdelen). diff --git a/docs/gebruik-van-subscriptions-in-autorisaties.md b/docs/gebruik-van-subscriptions-in-autorisaties.md index ef191cf..fc7451c 100644 --- a/docs/gebruik-van-subscriptions-in-autorisaties.md +++ b/docs/gebruik-van-subscriptions-in-autorisaties.md @@ -1,3 +1,9 @@ +--- +title: "Use of Subscriptions for Notifications" +description: "A comprehensive guide on creating and managing subscriptions for ZGW API notifications, detailing filter options for various channels like Zaken, Besluiten, and Documenten." +keywords: [subscriptions, notifications, filters, ZGW, API, webhooks, callbacks, Zaken, Besluiten, Documenten, OneGround, Roxit] +--- + # Use of Subscriptions for Notifications ## What is a subscription? diff --git a/docs/usage-of-clientids.md b/docs/usage-of-clientids.md index ad04fa0..7891975 100644 --- a/docs/usage-of-clientids.md +++ b/docs/usage-of-clientids.md @@ -1,16 +1,7 @@ --- -title: "ClientID Management and JWT Authentication in OneGround" -description: "Complete guide to ClientID creation, management, and JWT bearer token authentication for OneGround ZGW APIs. Learn how to obtain credentials, generate tokens, and configure secure API access." -keywords: - - ClientID - - JWT authentication - - bearer token - - OneGround authentication - - ZGW API security - - API credentials - - client configuration - - authentication guide - - secret management +title: "Usage of ClientIDs" +description: "Learn how to obtain or generate JWT bearer tokens using ClientIDs for OneGround APIs in both Community and Unlimited editions." +keywords: ["ClientID", "JWT", "OneGround", "API", "Authentication", "ZGW"] --- # ClientID's diff --git a/docs/version-header.md b/docs/version-header.md index df6d4fe..1b36a74 100644 --- a/docs/version-header.md +++ b/docs/version-header.md @@ -1,6 +1,7 @@ --- -title: "Version Headers" -description: "Usage of version headers in OneGround" +title: "Usage of Version Headers" +description: "Guidelines and best practices for using the Api-version header in OneGround APIs, including compliance with the API Strategy standard." +keywords: ["Api-version", "Header", "OneGround", "ZGW", "API Strategy", "Versioning"] --- # Usage of version headers in OneGround diff --git a/docs/ztc1_3problemsandsolutions.md b/docs/ztc1_3problemsandsolutions.md index 7abfefc..b8d0611 100644 --- a/docs/ztc1_3problemsandsolutions.md +++ b/docs/ztc1_3problemsandsolutions.md @@ -1,5 +1,7 @@ --- -title: "Problems in and solutions for ZTC 1.3" +title: "ZTC 1.3 Problems and Solutions" +description: "A comprehensive list of known issues within the ZTC 1.3 standard and how Roxit components address them." +keywords: ["ZTC 1.3", "ZGW", "Roxit", "Issues", "Solutions", "Workarounds"] --- # Problems in and solutions for ZTC 1.3 diff --git a/package-lock.json b/package-lock.json index d1700f4..fda6a37 100644 --- a/package-lock.json +++ b/package-lock.json @@ -21,7 +21,7 @@ "@docusaurus/module-type-aliases": "3.9.2", "@docusaurus/tsconfig": "3.9.2", "@docusaurus/types": "3.9.2", - "prettier": "^3.7.4", + "prettier": "^3.8.0", "typescript": "~5.9.3" }, "engines": { @@ -14694,9 +14694,9 @@ } }, "node_modules/prettier": { - "version": "3.7.4", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.7.4.tgz", - "integrity": "sha512-v6UNi1+3hSlVvv8fSaoUbggEM5VErKmmpGA7Pl3HF8V6uKY7rvClBOJlH6yNwQtfTueNkGVpOv/mtWL9L4bgRA==", + "version": "3.8.0", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.8.0.tgz", + "integrity": "sha512-yEPsovQfpxYfgWNhCfECjG5AQaO+K3dp6XERmOepyPDVqcJm+bjyCVO3pmU+nAPe0N5dDvekfGezt/EIiRe1TA==", "dev": true, "license": "MIT", "bin": { diff --git a/package.json b/package.json index 361f26a..3757e6a 100644 --- a/package.json +++ b/package.json @@ -30,7 +30,7 @@ "@docusaurus/module-type-aliases": "3.9.2", "@docusaurus/tsconfig": "3.9.2", "@docusaurus/types": "3.9.2", - "prettier": "^3.7.4", + "prettier": "^3.8.0", "typescript": "~5.9.3" }, "browserslist": {