diff --git a/docs/api/README.md b/docs/api/README.md new file mode 100644 index 000000000..2972a1ef4 --- /dev/null +++ b/docs/api/README.md @@ -0,0 +1,11 @@ +### API Documentation + +Go to the [API Hub](https://eclipse-tractusx.github.io/api-hub/) + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/public/documentation/data/main/developer.json b/public/documentation/data/main/developer.json index ac1ce1557..d48742ae0 100644 --- a/public/documentation/data/main/developer.json +++ b/public/documentation/data/main/developer.json @@ -3,212 +3,203 @@ "name": "Catena-X Developer Documentation", "children": [ { - "path": "developer/01. Onboarding", - "name": "01. Onboarding", + "path": "developer/00. Personas", + "name": "00. Personas", "children": [ { - "path": "developer/01. Onboarding/01. Invite", - "name": "01. Invite", + "path": "developer/00. Personas/05. Onboarding Service Provider.md", + "name": "05. Onboarding Service Provider.md", + "chapter": [] + } + ] + }, + { + "path": "developer/01. Registration", + "name": "01. Registration", + "children": [ + { + "path": "developer/01. Registration/01. Registration Process", + "name": "01. Registration Process", "children": [ { - "path": "developer/01. Onboarding/01. Invite/01. Summary.md", - "name": "01. Summary.md", - "chapter": ["## Summary", "## NOTICE"] + "path": "developer/01. Registration/01. Registration Process/00. Introduction.md", + "name": "00. Introduction.md", + "chapter": [] }, { - "path": "developer/01. Onboarding/01. Invite/02. Overview Invited Companies.md", - "name": "02. Overview Invited Companies.md", - "chapter": [ - "## Get Invited Companies", - "#### API Details", - "## NOTICE" - ] + "path": "developer/01. Registration/01. Registration Process/01. Registration Portal.md", + "name": "01. Registration Portal.md", + "chapter": [] }, { - "path": "developer/01. Onboarding/01. Invite/03. Invite Company_Create Application.md", - "name": "03. Invite Company_Create Application.md", - "chapter": ["## Invite Company", "#### API Details", "## NOTICE"] + "path": "developer/01. Registration/01. Registration Process/02. Registration External.md", + "name": "02. Registration External.md", + "chapter": [] } ] }, { - "path": "developer/01. Onboarding/02. Registration", - "name": "02. Registration", + "path": "developer/01. Registration/02. Registration Portal", + "name": "02. Registration Portal", "children": [ { - "path": "developer/01. Onboarding/02. Registration/01. Login.md", - "name": "01. Login.md", - "chapter": [ - "# Intro", - "#### Registration Login", - "### Registration Login Details", - "## Portal Login", - "## NOTICE" - ] + "path": "developer/01. Registration/02. Registration Portal/01. Login Flow.md", + "name": "01. Login Flow.md", + "chapter": [] }, { - "path": "developer/01. Onboarding/02. Registration/02. Add Company Data.md", + "path": "developer/01. Registration/02. Registration Portal/02. Add Company Data.md", "name": "02. Add Company Data.md", - "chapter": [ - "## Add Company Data", - "## Functional View", - "## Implementation View", - "### Enter Company Data", - "#### a) via BPN search and automatic data load", - "#### b) manually entered", - "##### Unique Identifier", - "###### Logic implemented for the country specific identifier", - "###### Result on UI", - "#A - no unique identifier", - "#B - only one unique identifier (happy path)", - "#C - multiple identifier", - "###### Implemented Pattern", - "###### POST allowed Unique Identifier", - "### Store/Save Company Data", - "### Display Company Data (pre-saved)", - "## NOTICE" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/03. Add Additional Users.md", + "chapter": [] + }, + { + "path": "developer/01. Registration/02. Registration Portal/03. Add Additional Users.md", "name": "03. Add Additional Users.md", - "chapter": [ - "# Implementation", - "## Add Additional Users", - "#### API Details", - "## NOTICE" - ] + "chapter": [] }, { - "path": "developer/01. Onboarding/02. Registration/04. Company Role & Consent.md", + "path": "developer/01. Registration/02. Registration Portal/04. Company Role & Consent.md", "name": "04. Company Role & Consent.md", - "chapter": [ - "# Implementation", - "## Select company role & sign terms and conditions", - "#### API Details", - "#1 Roles and agreements are fetched from the consent endpoint", - "#2 Consent Post", - "## NOTICE" - ] + "chapter": [] }, { - "path": "developer/01. Onboarding/02. Registration/05. Document Upload.md", + "path": "developer/01. Registration/02. Registration Portal/05. Document Upload.md", "name": "05. Document Upload.md", - "chapter": [ - "# Implementation", - "## Upload registration relevant documents", - "#### API Details", - "##### #1 API Get Documents", - "##### #2 API Upload Document", - "##### #3 API Delete Document", - "##### #4 API Download Document", - "## NOTICE" - ] - }, - { - "path": "developer/01. Onboarding/02. Registration/06. Verify Registration Data.md", + "chapter": [] + }, + { + "path": "developer/01. Registration/02. Registration Portal/06. Verify Registration Data.md", "name": "06. Verify Registration Data.md", - "chapter": [ - "## Verify Registration Data data", - "#### #1 Get application data", - "#### #2 Submit Registration", - "###### Validations", - "## NOTICE" - ] + "chapter": [] }, { - "path": "developer/01. Onboarding/02. Registration/07. Error Scenarios.md", + "path": "developer/01. Registration/02. Registration Portal/07. Error Scenarios.md", "name": "07. Error Scenarios.md", - "chapter": [ - "## Error Scenarios", - "### System Availability", - "### 1 Login", - "### 2 Company Data", - "### 3 Invite Users", - "### 4 Company Role and Terms&Conditions", - "### 5 Document Load", - "### 6 Verify Data", - "## NOTICE" - ] + "chapter": [] + } + ] + }, + { + "path": "developer/01. Registration/03. Registration External", + "name": "03. Registration External", + "children": [ + { + "path": "developer/01. Registration/03. Registration External/01. OSP Registration API.md", + "name": "01. OSP Registration API.md", + "chapter": [] + }, + { + "path": "developer/01. Registration/03. Registration External/02. External Registration Callback API.md", + "name": "02. External Registration Callback API.md", + "chapter": [] } ] }, { - "path": "developer/01. Onboarding/03. Registration Approval", - "name": "03. Registration Approval", + "path": "developer/01. Registration/04. Registration Approval", + "name": "04. Registration Approval", "children": [ { - "path": "developer/01. Onboarding/03. Registration Approval/02. View Company Application(s).md", + "path": "developer/01. Registration/04. Registration Approval/02. View Company Application(s).md", "name": "02. View Company Application(s).md", - "chapter": [ - "## View Company Application(s)", - "## 1 Get Applications", - "###### Filtering", - "###### Search", - "#### Logical flow of the service", - "#### API Details", - "## 2 Get Application Details", - "#### API Details Get Company Registration Data", - "##### Response Body / Details:", - "#### API Details Get Company Checklist Status", - "## 3 Download Documents", - "#### Logical flow of the service", - "#### API Details", - "## NOTICE" - ] - }, - { - "path": "developer/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md", + "chapter": [] + }, + { + "path": "developer/01. Registration/04. Registration Approval/03. Registration Approval Process.md", "name": "03. Registration Approval Process.md", - "chapter": [ - "## Summary", - "### Approval Overlay/Status", - "##### #1 Registration Validation", - "##### #2 BPN Creation", - "##### #3 Managed Identity Wallet", - "##### #4 Clearinghouse", - "##### #5 Self Description LP", - "### Approval Flow", - "#### Details \"Manual Validation\"", - "##### Scenario: Approve", - "##### Scenario: Decline", - "##### Details \"Create Business Partner Number (if necessary)\"", - "##### Scenario 1 - Registration with BPN", - "##### Scenario 2 - Registration without BPN", - "##### Scenario 3 - manually add BPN as an operator (interim supported workflow)", - "##### Details \"Create Managed Identity Wallet\"", - "#### Details \"Clearinghouse Check\"", - "###### Step 1 - Send company data to clearinghouse", - "###### Step 2 - Clearinghouse response", - "##### Details \"Self-Description Creation LegalParticipant\"", - "###### Step 1 - Create SelfDescription - send company data to SD Factory", - "###### Step 2 - Save self description document", - "###### DB Table Content", - "##### Details \"Activation\"", - "### Add/Update BPN for the registration company", - "### Status endpoint - Checklist Details", - "### Details for retrigger process", - "## NOTICE" - ] - }, - { - "path": "developer/01. Onboarding/03. Registration Approval/04. Decline Application.md", + "chapter": [] + }, + { + "path": "developer/01. Registration/04. Registration Approval/04. Decline Application.md", "name": "04. Decline Application.md", - "chapter": [ - "## Decline Company Application", - "##### API Implementation", - "## NOTICE" - ] + "chapter": [] }, { - "path": "developer/01. Onboarding/03. Registration Approval/index.md", + "path": "developer/01. Registration/04. Registration Approval/index.md", "name": "index.md", - "chapter": [ - "## Summary", - "## Functional Details", - "### Display Application Details", - "## NOTICE" - ] + "chapter": [] + } + ] + }, + { + "path": "developer/01. Registration/05. Others", + "name": "05. Others", + "children": [ + { + "path": "developer/01. Registration/05. Others/02. Overview Invited Companies.md", + "name": "02. Overview Invited Companies.md", + "chapter": [] + } + ] + }, + { + "path": "developer/01. Registration/06. Decline Registration", + "name": "06. Decline Registration", + "children": [ + { + "path": "developer/01. Registration/06. Decline Registration/01. Decline Registration.md", + "name": "01. Decline Registration.md", + "chapter": [] + } + ] + } + ] + }, + { + "path": "developer/02. Identity", + "name": "02. Identity", + "children": [ + { + "path": "developer/02. Identity/01. Identity Process", + "name": "01. Identity Process", + "children": [ + { + "path": "developer/02. Identity/01. Identity Process/00. Wallet Process.md", + "name": "00. Wallet Process.md", + "chapter": [] + } + ] + }, + { + "path": "developer/02. Identity/02. Wallet Creation", + "name": "02. Wallet Creation", + "children": [ + { + "path": "developer/02. Identity/02. Wallet Creation/00. Wallet Creation.md", + "name": "00. Wallet Creation.md", + "chapter": [] + } + ] + }, + { + "path": "developer/02. Identity/03. Credential Management", + "name": "03. Credential Management", + "children": [ + { + "path": "developer/02. Identity/03. Credential Management/01. Get UseCase Credential.md", + "name": "01. Get UseCase Credential.md", + "chapter": [] + }, + { + "path": "developer/02. Identity/03. Credential Management/02. Other Certificates.md", + "name": "02. Other Certificates.md", + "chapter": [] + }, + { + "path": "developer/02. Identity/03. Credential Management/03. Credential Admin Board.md", + "name": "03. Credential Admin Board.md", + "chapter": [] + } + ] + }, + { + "path": "developer/02. Identity/04. Wallet UI", + "name": "04. Wallet UI", + "children": [ + { + "path": "developer/02. Identity/04. Wallet UI/01. Wallet UI.md", + "name": "01. Wallet UI.md", + "chapter": [] } ] } @@ -225,74 +216,32 @@ { "path": "developer/02. Technical Integration/01. Connector Registration/01. Summary.md", "name": "01. Summary.md", - "chapter": ["# Summary", "## NOTICE"] + "chapter": [] }, { "path": "developer/02. Technical Integration/01. Connector Registration/02. View Connector.md", "name": "02. View Connector.md", - "chapter": [ - "## View Connector", - "## Details", - "##### Status:", - "##### SD Registration:", - "##### Host:", - "## Implementation/APIs", - "### 1 Get all \"my\" Connector Registrations", - "#### Logical flow of the service", - "#### API Details", - "### 2 Get all \"my\" Connector Registrations hosted for customers/3rd parties", - "#### Logical flow of the service", - "#### API Details", - "## NOTICE" - ] + "chapter": [] }, { "path": "developer/02. Technical Integration/01. Connector Registration/03. Create new Connector Registration.md", "name": "03. Create new Connector Registration.md", - "chapter": [ - "## 1. Create new Connector Registration - self-owned", - "#### Details to the SD", - "##### #1 Self description request", - "##### #2 Self description response (asynchronous)", - "#### Logical flow of the service", - "#### API Details", - "## 2. Create new Connector Registration - managed", - "#### Logical flow of the service", - "#### API Details", - "## NOTICE" - ] + "chapter": [] }, { "path": "developer/02. Technical Integration/01. Connector Registration/05. Self Description.md", "name": "05. Self Description.md", - "chapter": [ - "## Self Description", - "### Implementation Details", - "#### Send Company Data to SD Factory (Create SD)", - "#### SD CallBack Service", - "## NOTICE" - ] + "chapter": [] }, { "path": "developer/02. Technical Integration/01. Connector Registration/06. Delete Connector.md", "name": "06. Delete Connector.md", - "chapter": [ - "## 5 Delete Connector", - "#### API Details", - "## NOTICE" - ] + "chapter": [] }, { "path": "developer/02. Technical Integration/01. Connector Registration/07. Error Handling.md", "name": "07. Error Handling.md", - "chapter": [ - "## Connector Registration Error Handling", - "### View Connector Table", - "#### #1 Scenario: No Data available", - "#### #2 Scenario: Endpoints are responding with an 500 error", - "#### #3 Scenario: Endpoints are responding with an 4xx error", - "## NOTICE" - ] + "chapter": [] } ] }, @@ -303,74 +252,37 @@ { "path": "developer/02. Technical Integration/02. Identity Provider Management/01. Summary.md", "name": "01. Summary.md", - "chapter": ["# Summary", "## NOTICE"] + "chapter": [] }, { "path": "developer/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md", "name": "02. Company IdPs.md", - "chapter": [ - "## Identity Provider Overview", - "### Implementation", - "### API GET IdPs", - "## NOTICE" - ] + "chapter": [] }, { "path": "developer/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md", "name": "02. Configure Company IdP.md", - "chapter": [ - "## IDP Configuration", - "### Create IdP", - "#### Implementation details:", - "#### API Create new IdP connection", - "### Configure IdP", - "#### Implementation details:", - "#### API Update IdP Config", - "### User Connection", - "## NOTICE" - ] + "chapter": [] }, { "path": "developer/02. Technical Integration/02. Identity Provider Management/03. User Migration.md", "name": "03. User Migration.md", - "chapter": [ - "### Migrate existing user accounts to the new created IdP", - "### Implementation Details", - "#### GET User List", - "#### POST User IdP Link", - "## NOTICE" - ] + "chapter": [] }, { "path": "developer/02. Technical Integration/02. Identity Provider Management/04. Delete Identity Provider.md", "name": "04. Delete Identity Provider.md", - "chapter": [ - "### Identity Provider Deletion", - "#### Implementation details:", - "#### API DELETE IdPs", - "## NOTICE" - ] + "chapter": [] }, { "path": "developer/02. Technical Integration/02. Identity Provider Management/04. FAQ.md", "name": "04. FAQ.md", - "chapter": [ - "### FAQ", - "#### ", - "## NOTICE" - ] + "chapter": [] } ] }, @@ -662,86 +530,42 @@ { "path": "user/04. App(s)/02. App Release Process/01. App Card.md", "name": "01. App Card.md", - "chapter": [ - "### Step 1 - App Card Details", - "###### App language", - "###### Use Case", - "###### Sales Manager", - "###### App Lead Picture Image", - "## NOTICE" - ] + "chapter": [] }, { "path": "user/04. App(s)/02. App Release Process/02. App Detail Page.md", "name": "02. App Detail Page.md", - "chapter": [ - "### Step 2 - App Page Details", - "###### App Details Images", - "###### App Documents", - "###### Privacy Policy", - "## NOTICE" - ] + "chapter": [] }, { "path": "user/04. App(s)/02. App Release Process/03. Terms&Conditions.md", "name": "03. Terms&Conditions.md", - "chapter": [ - "### Step 3 - Terms & Conditions / Consent", - "## NOTICE" - ] + "chapter": [] }, { "path": "user/04. App(s)/02. App Release Process/04. Technical Integration.md", "name": "04. Technical Integration.md", - "chapter": ["### Step 4 - Technical Integration", "## NOTICE"] + "chapter": [] }, { "path": "user/04. App(s)/02. App Release Process/05. Verify & Submit.md", "name": "05. Verify & Submit.md", - "chapter": [ - "### Step 6 - Validate & Submit for Publishing check", - "## NOTICE" - ] + "chapter": [] }, { "path": "user/04. App(s)/02. App Release Process/App-Design_guidelines.md", "name": "App-Design_guidelines.md", - "chapter": [ - "## App Design Guidelines", - "### The App Picture", - "### Support Information", - "#### App Picture Layout Template", - "#### App Color Guidelines", - "###### Do's", - "###### Dont's", - "#### App Picture Icon Template", - "#### In-App Design (Catena-X Apps)", - "##### App Typography", - "##### Language Support", - "## NOTICE" - ] + "chapter": [] }, { "path": "user/04. App(s)/02. App Release Process/App-Release_guidelines.md", "name": "App-Release_guidelines.md", - "chapter": [ - "# App Release Guidelines", - "## Summary", - "## Technical Guidelines", - "#### #1 Authentication", - "#### #2 User Error Handling", - "## Functional Guidelines", - "## NOTICE" - ] + "chapter": [] }, { "path": "user/04. App(s)/02. App Release Process/index.md", "name": "index.md", - "chapter": [ - "## Summary", - "### Trigger the Publishing Process", - "## NOTICE" - ] + "chapter": [] } ] }, @@ -752,22 +576,22 @@ { "path": "user/04. App(s)/03. App Release Approval/01. App Approval Board.md", "name": "01. App Approval Board.md", - "chapter": ["## Summary", "### Page Design", "## NOTICE"] + "chapter": [] }, { "path": "user/04. App(s)/03. App Release Approval/02. App Details.md", "name": "02. App Details.md", - "chapter": ["## App details", "## NOTICE"] + "chapter": [] }, { "path": "user/04. App(s)/03. App Release Approval/03. Approve App Release.md", "name": "03. Approve App Release.md", - "chapter": ["## Approve App Release", "## NOTICE"] + "chapter": [] }, { "path": "user/04. App(s)/03. App Release Approval/04. Decline App Release.md", "name": "04. Decline App Release.md", - "chapter": ["## Decline App Release", "## NOTICE"] + "chapter": [] } ] }, @@ -778,7 +602,7 @@ { "path": "user/04. App(s)/04. App Provider Management Board(s)/01. App Board.md", "name": "01. App Board.md", - "chapter": ["## App Board", "### Details", "## NOTICE"] + "chapter": [] } ] }, @@ -789,44 +613,27 @@ { "path": "user/04. App(s)/05. App Subscription/01. Subscription Request (Customer).md", "name": "01. Subscription Request (Customer).md", - "chapter": ["# Summary", "## NOTICE"] + "chapter": [] }, { "path": "user/04. App(s)/05. App Subscription/02. Overview Company Subscription (Customer).md", "name": "02. Overview Company Subscription (Customer).md", - "chapter": ["# Summary", "## NOTICE"] + "chapter": [] }, { "path": "user/04. App(s)/05. App Subscription/03. Subscription Overview (App Provider).md", "name": "03. Subscription Overview (App Provider).md", - "chapter": [ - "## Summary", - "## Management Board", - "## Specific Subscription Details", - "## NOTICE" - ] + "chapter": [] }, { "path": "user/04. App(s)/05. App Subscription/04. Subscription Activation (App Provider).md", "name": "04. Subscription Activation (App Provider).md", - "chapter": ["## Subscription Activation", "## NOTICE"] - }, - { - "path": "user/04. App(s)/05. App Subscription/05. App Unsubscribe.md", - "name": "05. App Unsubscribe.md", - "chapter": ["## Unsubscribe", "## NOTICE"] + "chapter": [] }, { "path": "user/04. App(s)/05. App Subscription/05. FAQ.md", "name": "05. FAQ.md", - "chapter": [ - "### FAQ", - "#### I don't have subscription rights - how can I receive the necessary rights?", - "#### I triggered an app subscription request what do I need to do now?", - "#### Where can I see my company subscriptions?", - "#### ?", - "## NOTICE" - ] + "chapter": [] } ] }, @@ -837,45 +644,37 @@ { "path": "user/04. App(s)/06. App Change Process/01. Summary.md", "name": "01. Summary.md", - "chapter": ["## Summary", "## Function", "## NOTICE"] + "chapter": [] }, { "path": "user/04. App(s)/06. App Change Process/02. Change App Lead Image.md", "name": "02. Change App Lead Image.md", - "chapter": ["## Summary", "## NOTICE"] + "chapter": [] }, { "path": "user/04. App(s)/06. App Change Process/03. Change App Description.md", "name": "03. Change App Description.md", - "chapter": ["## Summary", "## NOTICE"] + "chapter": [] }, { "path": "user/04. App(s)/06. App Change Process/04. App Deactivation.md", "name": "04. App Deactivation.md", - "chapter": ["## Summary", "## NOTICE"] + "chapter": [] }, { "path": "user/04. App(s)/06. App Change Process/05. Change App Tenant URL.md", "name": "05. Change App Tenant URL.md", - "chapter": ["## App Tenant URL Change", "## NOTICE"] + "chapter": [] }, { - "path": "user/04. App(s)/06. App Change Process/06. Change App RolesL.md", - "name": "06. Change App RolesL.md", - "chapter": [ - "## App Role Change", - "#### How to fill the template", - "## NOTICE" - ] + "path": "user/04. App(s)/06. App Change Process/06. Change App Roles.md", + "name": "06. Change App Roles.md", + "chapter": [] }, { "path": "user/04. App(s)/06. App Change Process/07. Document Change.md", "name": "07. Document Change.md", - "chapter": [ - "### Document Change", - "#### Add Documents", - "#### Deleting" - ] + "chapter": [] } ] }, @@ -886,27 +685,14 @@ { "path": "user/04. App(s)/07. App Provider Management/01. Open API.md", "name": "01. Open API.md", - "chapter": [ - "## Open API - Offer Autosetup", - "## Interface / API / Service Summary", - "## Architecture Overview", - "## Implementation", - "### #1 PUT Service URL", - "### #2 POST Service Request", - "### #3 POST Service Instance", - "## NOTICE" - ] + "chapter": [] } ] }, { "path": "user/04. App(s)/index.md", "name": "index.md", - "chapter": [ - "# Summary", - "### App Marketplace in Catena-X", - "## NOTICE" - ] + "chapter": [] } ] }, @@ -921,22 +707,17 @@ { "path": "user/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md", "name": "01. Service Marketplace.md", - "chapter": [ - "## Summary", - "## Functionality", - "### Service Marketplace Overview", - "## NOTICE" - ] + "chapter": [] }, { "path": "user/05. Service(s)/01. Service Marketplace/02. Service Details.md", "name": "02. Service Details.md", - "chapter": ["## Service Offer Details", "## NOTICE"] + "chapter": [] }, { "path": "user/05. Service(s)/01. Service Marketplace/03. FAQ.md", "name": "03. FAQ.md", - "chapter": ["### FAQ", "## NOTICE"] + "chapter": [] } ] }, @@ -947,58 +728,37 @@ { "path": "user/05. Service(s)/02. Service Release Process/01. Service Card.md", "name": "01. Service Card.md", - "chapter": ["### Step 1 - Service Card Details", "## NOTICE"] + "chapter": [] }, { "path": "user/05. Service(s)/02. Service Release Process/02. Service Detail Page.md", "name": "02. Service Detail Page.md", - "chapter": [ - "### Step 2 - Service Page Details", - "#### Additional information to the requested service details", - "##### Long Description", - "##### Additional Documents/Information", - "##### Provider Details", - "## NOTICE" - ] + "chapter": [] }, { "path": "user/05. Service(s)/02. Service Release Process/03. Terms&Conditions.md", "name": "03. Terms&Conditions.md", - "chapter": [ - "### Step 3 - Terms & Conditions / Consent", - "## NOTICE" - ] + "chapter": [] }, { "path": "user/05. Service(s)/02. Service Release Process/04. Technical Integration.md", "name": "04. Technical Integration.md", - "chapter": ["### Step 4 - Technical Integration", "## NOTICE"] + "chapter": [] }, { "path": "user/05. Service(s)/02. Service Release Process/05. Verify & Submit.md", "name": "05. Verify & Submit.md", - "chapter": [ - "### Step 4 - Validate & Submit for Publishing check", - "## NOTICE" - ] + "chapter": [] }, { "path": "user/05. Service(s)/02. Service Release Process/06. FAQ.md", "name": "06. FAQ.md", - "chapter": [ - "### FAQ", - "### How can I submit a new service offer for marketplace publishing?", - "## NOTICE" - ] + "chapter": [] }, { "path": "user/05. Service(s)/02. Service Release Process/index.md", "name": "index.md", - "chapter": [ - "## Service Release Process", - "### Trigger the Publishing Process", - "## NOTICE" - ] + "chapter": [] } ] }, @@ -1009,22 +769,22 @@ { "path": "user/05. Service(s)/03. Service Release Approval/01. Service Approval Board.md", "name": "01. Service Approval Board.md", - "chapter": ["## Summary", "### Page Design", "## NOTICE"] + "chapter": [] }, { "path": "user/05. Service(s)/03. Service Release Approval/02. Service Details.md", "name": "02. Service Details.md", - "chapter": ["## Service Details", "## NOTICE"] + "chapter": [] }, { "path": "user/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md", "name": "03. Approve Service Release.md", - "chapter": ["## Approve Service Release", "## NOTICE"] + "chapter": [] }, { "path": "user/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md", "name": "04. Decline Service Release.md", - "chapter": ["## Decline Service Release", "## NOTICE"] + "chapter": [] } ] }, @@ -1035,43 +795,27 @@ { "path": "user/05. Service(s)/03. Service Subscription/01. Service Subscription.md", "name": "01. Service Subscription.md", - "chapter": ["## Summary", "## NOTICE"] + "chapter": [] }, { "path": "user/05. Service(s)/03. Service Subscription/03. Subscription Overview (Provider).md", "name": "03. Subscription Overview (Provider).md", - "chapter": [ - "## Summary", - "## Management Board", - "## Specific Subscription Details", - "## NOTICE" - ] + "chapter": [] }, { "path": "user/05. Service(s)/03. Service Subscription/04. Service Subscription Activation (Provider).md", "name": "04. Service Subscription Activation (Provider).md", - "chapter": [ - "## Subscription Activation", - "#### A) Services with technical user profile configured", - "#### B) Services without technical user profile configured", - "## NOTICE" - ] + "chapter": [] }, { - "path": "user/05. Service(s)/03. Service Subscription/04. Service Unsubscribe.md", - "name": "04. Service Unsubscribe.md", - "chapter": ["## NOTICE"] + "path": "user/05. Service(s)/03. Service Subscription/05. Subscription Management.md", + "name": "05. Subscription Management.md", + "chapter": [] }, { - "path": "user/05. Service(s)/03. Service Subscription/05. FAQ.md", - "name": "05. FAQ.md", - "chapter": [ - "### FAQ", - "#### Can I trigger a second service subscription request?", - "#### I don't have subscription rights - how can I receive the necessary rights?", - "#### I triggered a service request what do I need to do now?", - "## NOTICE" - ] + "path": "user/05. Service(s)/03. Service Subscription/06. FAQ.md", + "name": "06. FAQ.md", + "chapter": [] } ] }, @@ -1082,63 +826,55 @@ { "path": "user/05. Service(s)/05. Service Change Process/01. Summary.md", "name": "01. Summary.md", - "chapter": ["## Summary", "## NOTICE"] + "chapter": [] }, { "path": "user/05. Service(s)/05. Service Change Process/02. Service Deactivation.md", "name": "02. Service Deactivation.md", - "chapter": ["## Summary", "## NOTICE"] + "chapter": [] } ] }, { "path": "user/05. Service(s)/index.md", "name": "index.md", - "chapter": ["## Service Marketplace in Catena-X", "## NOTICE"] + "chapter": [] } ] }, { - "path": "user/06. Certificates", - "name": "06. Certificates", + "path": "user/06. Credential Management", + "name": "06. Credential Management", "children": [ { - "path": "user/06. Certificates/01. UseCase Participation.md", + "path": "user/06. Credential Management/01. UseCase Participation.md", "name": "01. UseCase Participation.md", - "chapter": ["## UseCase Participation", "## NOTICE"] + "chapter": [] }, { - "path": "user/06. Certificates/02. Other Certificates.md", + "path": "user/06. Credential Management/02. Other Certificates.md", "name": "02. Other Certificates.md", - "chapter": ["## Company Certificates", "## NOTICE"] + "chapter": [] }, { - "path": "user/06. Certificates/03. Credential Admin Board.md", + "path": "user/06. Credential Management/03. Credential Admin Board.md", "name": "03. Credential Admin Board.md", - "chapter": [ - "## Credential Admin Board", - "#### Filter based on credential request status", - "#### Open the attached document", - "#### Approve Credential Request", - "#### Reject Credential Request", - "## NOTICE" - ] + "chapter": [] }, { - "path": "user/06. Certificates/03. FAQ.md", + "path": "user/06. Credential Management/03. FAQ.md", "name": "03. FAQ.md", - "chapter": [ - "## FAQ", - "#### 1. Why can I not upload any certificate", - "#### 2. Who validates my VC request after submission", - "#### 3. For how long will the credential be valid.", - "## NOTICE" - ] + "chapter": [] + }, + { + "path": "user/06. Credential Management/04. Credential Revocation.md", + "name": "04. Credential Revocation.md", + "chapter": [] }, { - "path": "user/06. Certificates/index.md", + "path": "user/06. Credential Management/index.md", "name": "index.md", - "chapter": ["## Summary", "## NOTICE"] + "chapter": [] } ] }, @@ -1153,16 +889,38 @@ { "path": "user/06. Notifications/01. Notifications/01. Overview.md", "name": "01. Overview.md", - "chapter": [ - "## Notifications", - "### Notification Element Details", - "## NOTICE" - ] + "chapter": [] } ] } ] }, + { + "path": "user/08. Certificate Management", + "name": "08. Certificate Management", + "children": [ + { + "path": "user/08. Certificate Management/00. Summary.md", + "name": "00. Summary.md", + "chapter": [] + }, + { + "path": "user/08. Certificate Management/01. Certificate Upload.md", + "name": "01. Certificate Upload.md", + "chapter": [] + }, + { + "path": "user/08. Certificate Management/02. Certificate Deletion.md", + "name": "02. Certificate Deletion.md", + "chapter": [] + }, + { + "path": "user/08. Certificate Management/03. Certificate Publishing.md", + "name": "03. Certificate Publishing.md", + "chapter": [] + } + ] + }, { "path": "user/09. Others", "name": "09. Others", @@ -1175,19 +933,7 @@ { "path": "user/09. Others/12. Offer Authentication Flow.md", "name": "12. Offer Authentication Flow.md", - "chapter": [ - "## Connect Your App to the central Opertaor IdP (Keycloak)", - "### Overview", - "### Process", - "## Highlevel Process", - "## Background Information", - "### Client Concept", - "## Step by Step description", - "### #1 Register your app/service inside the CX marketplace", - "### #2 App Subscription and activation", - "### Connected Topics", - "## NOTICE" - ] + "chapter": [] } ] }, @@ -1198,113 +944,42 @@ { "path": "user/Style-Guide/Static_Page_Template.md", "name": "Static_Page_Template.md", - "chapter": [ - "## Static Page Template(s)", - "### Templates", - "#### Common Notes", - "#### #1 TextCenterAlignedWithCardGrid", - "#### #2 TextCenterAlignedWithLinkButtonGrid", - "#### #3 TextImageSideBySideWithCardGrid", - "#### #4 TextVideoSideBySide", - "#### #5 Video-Text-Side-By-Side", - "#### #6 Text-Image-Center-Aligned", - "#### #7 Text-Center-Aligned", - "#### #8 Text-Image-Side-By-Side", - "#### #9 TextCenterAlignedBody2", - "#### #10 TextImageSideBySideWithLinks", - "#### #11 TextImageSideBySideWithSections", - "### Implementation", - "#### New Page creation", - "#### Enhancing an existing page", - "## NOTICE" - ] + "chapter": [] }, { "path": "user/Style-Guide/button load more.md", "name": "button load more.md", - "chapter": [ - "### Buttons Pagination / Load More", - "##### Setting:", - "## NOTICE" - ] - }, - { - "path": "user/Style-Guide/button.md", - "name": "button.md", - "chapter": [ - "### Buttons", - "#### Interaction", - "#### Context and usage", - "#### When to consider something else", - "#### Guidance", - "## NOTICE" - ] - }, - { - "path": "user/Style-Guide/date picker.md", - "name": "date picker.md", - "chapter": [ - "### Date Picker", - "#### Principles", - "#### When to use", - "## NOTICE" - ] - }, - { - "path": "user/Style-Guide/drop down.md", - "name": "drop down.md", - "chapter": ["### Drop Down", "#### ...", "#### Guidance", "## NOTICE"] + "chapter": [] }, { "path": "user/Style-Guide/dropzone.md", "name": "dropzone.md", - "chapter": [ - "### Dropzone", - "##### The dropzone supports following setting", - "#### Upload List", - "#### Upload Status", - "#### Auto upload queue", - "#### Delete Function", - "#### Preview Function", - "## NOTICE" - ] + "chapter": [] }, { "path": "user/Style-Guide/input field.md", "name": "input field.md", - "chapter": ["### Input Field", "#### Guidance", "## NOTICE"] + "chapter": [] }, { "path": "user/Style-Guide/loading.md", "name": "loading.md", - "chapter": ["### Loading", "#### Guidance", "## NOTICE"] + "chapter": [] }, { "path": "user/Style-Guide/scrollbar.md", "name": "scrollbar.md", - "chapter": ["### Scrollbar", "## NOTICE"] + "chapter": [] }, { "path": "user/Style-Guide/searchbar.md", "name": "searchbar.md", - "chapter": [ - "### Searchbar", - "#### Details", - "#### Interaction", - "#### Context and usage", - "#### Guidance", - "## NOTICE" - ] + "chapter": [] }, { "path": "user/Style-Guide/toast message.md", "name": "toast message.md", - "chapter": [ - "### Toast Message", - "#### Details", - "#### Style", - "## NOTICE" - ] + "chapter": [] } ] }