Skip to content

Release P7 en P8 aangepast#129

Open
Eric Zwaal (ezw2000) wants to merge 1 commit intomainfrom
Releasenotes-aangepast
Open

Release P7 en P8 aangepast#129
Eric Zwaal (ezw2000) wants to merge 1 commit intomainfrom
Releasenotes-aangepast

Conversation

@ezw2000
Copy link
Copy Markdown
Collaborator

No description provided.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the AFAS Profit OpenAPI specifications and accompanying documentation/navigation to reflect recent Profit 7 changes and to introduce initial (beta) Profit 8 release notes.

Changes:

  • Updated multiple OpenAPI specs (NL + EN) with revised custom GetConnector descriptions, added/removed endpoints, and added new schema fields.
  • Updated endpoint navigation mappings and the site menu to include Profit 8 release notes.
  • Updated Profit 7 release notes content/dates and added new Profit 8 release notes pages.

Reviewed changes

Copilot reviewed 50 out of 50 changed files in this pull request and generated 20 comments.

Show a summary per file
File Description
OpenApiSpecs/profit/nl/Werving en selectie.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/nl/Werkgever.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/nl/Verlof en Ziekte.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/nl/Verkoop en Orders.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/nl/Projecten en nacalculatie.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/nl/Overige.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/nl/Organisaties en personen.json Updates custom GetConnector text and removes KnPurchaseRelationOrg/Per delete paths.
OpenApiSpecs/profit/nl/Mutaties.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/nl/Medewerker en contract.json Updates custom GetConnector text and adds DsTp schema field in bank info structures.
OpenApiSpecs/profit/nl/Magazijn.json Updates custom GetConnector text and adds DELETE for FbItemCodeWarehouse with composite key.
OpenApiSpecs/profit/nl/Loonadministratie.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/nl/Inrichting.json Adds ReportConnector + OTP endpoints and reorganizes some connector sections.
OpenApiSpecs/profit/nl/Inkoop.json Updates custom GetConnector text and removes KnPurchaseRelationOrg/Per delete paths.
OpenApiSpecs/profit/nl/Flex.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/nl/Fiscaal.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/nl/Dossiers en bijlagen en workflows.json Adds SubjectConnector and FileConnector endpoints.
OpenApiSpecs/profit/nl/Cursusmanagement.json Updates custom GetConnector text and adjusts tag description.
OpenApiSpecs/profit/nl/Budgetten en activa.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/nl/Bouw.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/nl/Bakkerijen.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/nl/Artikelen.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/en/Werving en selectie.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/en/Werkgever.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/en/Verlof en Ziekte.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/en/Verkoop en Orders.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/en/Projecten en nacalculatie.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/en/Overige.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/en/Organisaties en personen.json Updates custom GetConnector text and removes KnPurchaseRelationOrg/Per delete paths.
OpenApiSpecs/profit/en/Mutaties.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/en/Medewerker en contract.json Updates custom GetConnector text and adds DsTp schema field in bank info structures.
OpenApiSpecs/profit/en/Magazijn.json Updates custom GetConnector text and adds DELETE for FbItemCodeWarehouse with composite key.
OpenApiSpecs/profit/en/Loonadministratie.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/en/Inrichting.json Adds ReportConnector + OTP endpoints and reorganizes some connector sections.
OpenApiSpecs/profit/en/Inkoop.json Updates custom GetConnector text and removes KnPurchaseRelationOrg/Per delete paths.
OpenApiSpecs/profit/en/Flex.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/en/Fiscaal.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/en/Dossiers en bijlagen en workflows.json Adds SubjectConnector and FileConnector endpoints.
OpenApiSpecs/profit/en/Cursusmanagement.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/en/Budgetten en activa.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/en/Bouw.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/en/Bakkerijen.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/profit/en/Artikelen.json Updates custom GetConnector summary/parameter descriptions.
OpenApiSpecs/endpointpaths.json Updates endpoint-to-doc URL mapping (including new connectors and removed deletes).
menustructures/multilanguage_menu.json Adds Profit 8 release notes links and removes Profit 3 entries from the news menu.
markdownpages/profit/nl/news-profit8.md Adds new (beta) Profit 8 release notes page (NL).
markdownpages/profit/nl/news-profit7.md Updates Profit 7 release notes date and changelog entries (NL).
markdownpages/profit/en/news-profit8.md Adds new (beta) Profit 8 release notes page (EN).
markdownpages/profit/en/news-profit7.md Updates Profit 7 release notes date and changelog entries (EN).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +1187 to +1196
"get": {
"descriptionNl": "",
"url": "Inrichting#get-/connectors/OtpRequest",
"descriptionEn": ""
}
},
"OtpValidation": {
"get": {
"descriptionNl": "",
"url": "Inrichting#get-/connectors/OtpValidation",
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In endpointpaths.json, OtpRequest and OtpValidation are registered under a get operation, but in the OpenAPI spec they are POST endpoints (/OtpRequest and /OtpValidation). This will likely generate incorrect links/anchors in the docs navigation; update these entries to use post (and corresponding post- anchor).

Suggested change
"get": {
"descriptionNl": "",
"url": "Inrichting#get-/connectors/OtpRequest",
"descriptionEn": ""
}
},
"OtpValidation": {
"get": {
"descriptionNl": "",
"url": "Inrichting#get-/connectors/OtpValidation",
"post": {
"descriptionNl": "",
"url": "Inrichting#post-/connectors/OtpRequest",
"descriptionEn": ""
}
},
"OtpValidation": {
"post": {
"descriptionNl": "",
"url": "Inrichting#post-/connectors/OtpValidation",

Copilot uses AI. Check for mistakes.
Comment on lines +578 to +582
"/ReportConnector/{id}": {
"get": {
"summary": "Get a report in a specific format based on the report Id and format Id",
"tags": [
"GET"
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ReportConnector summary mentions "based on the report Id and format Id", but this endpoint only defines a single path parameter (id) and no format parameter (path or query). Please either add the missing format parameter or adjust the summary to match the actual request shape.

Copilot uses AI. Check for mistakes.
Comment on lines +692 to +698
"/OtpRequest": {
"post": {
"summary": "Request and validate One Time Password (OTP) for authorization.",
"tags": [
"OTP Authorization"
],
"responses": {
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tag OTP Authorization is used for this endpoint, but it is not present in the top-level tags list of this spec. If your docs generator relies on tags definitions for navigation/grouping, add a matching tags entry (or reuse an existing tag).

Copilot uses AI. Check for mistakes.
Comment on lines +796 to +801
"description": "The API secret of the App Connector (Omgevingssleutel)"
},
"userId": {
"type": "string",
"description": "The emailladdress or userid (12345.user)"
}
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spelling/wording in the userId field description: "emailladdress" should be "email address", and "userid" should be consistently written as "userId" to match the property name.

Copilot uses AI. Check for mistakes.
Comment on lines +809 to +816
"examples": {
"OTP Example": {
"value": {
"apiKey": "8B4406A0041C4A319D6594224186383F",
"userid": "work@exampleemail.com",
"apiToken": "941C8D1742366C922BFF7B81946526EE"
}
}
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The requestBody example uses userid, but the schema property is userId. This is likely to confuse API consumers and generated clients; update the example key to userId.

Copilot uses AI. Check for mistakes.
Comment on lines +695 to +697
"tags": [
"OTP Authorization"
],
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tag OTP Authorization is used for this endpoint, but it is not present in the top-level tags list of this spec. If your docs generator relies on tags definitions for navigation/grouping, add a matching tags entry (or reuse an existing tag).

Suggested change
"tags": [
"OTP Authorization"
],

Copilot uses AI. Check for mistakes.
Comment on lines +798 to +801
"userId": {
"type": "string",
"description": "The emailladdress or userid (12345.user)"
}
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spelling/wording in the userId field description: "emailladdress" should be "email address", and "userid" should be consistently written as "userId" to match the property name.

Copilot uses AI. Check for mistakes.
"OTP Example": {
"value": {
"apiKey": "8B4406A0041C4A319D6594224186383F",
"userid": "work@exampleemail.com",
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The requestBody example uses userid, but the schema property is userId. This is likely to confuse API consumers and generated clients; update the example key to userId.

Suggested change
"userid": "work@exampleemail.com",
"userId": "work@exampleemail.com",

Copilot uses AI. Check for mistakes.
"OTP Example": {
"value": {
"apiKey": "8B4406A0041C4A319D6594224186383F",
"userid": "work@exampleemail.com",
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The requestBody example uses userid, but the schema property is userId. This is likely to confuse API consumers and generated clients; update the example key to userId.

Suggested change
"userid": "work@exampleemail.com",
"userId": "work@exampleemail.com",

Copilot uses AI. Check for mistakes.
Comment on lines +578 to +583
"/SubjectConnector": {
"get": {
"summary": "Get a subject attachment based on the subject Id and file Id",
"tags": [
"Bestanden"
],
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This endpoint uses the tag Bestanden, but that tag is not defined in the top-level tags list for this spec. Consider adding a Bestanden tag definition (also used by /FileConnector) so it shows up consistently in generated docs/navigation.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants