Skip to content

Commit

Permalink
Chapter overview, separate glossary and move postman import
Browse files Browse the repository at this point in the history
  • Loading branch information
typecastcloud committed Oct 16, 2024
1 parent 056260f commit cb0ee01
Show file tree
Hide file tree
Showing 3 changed files with 88 additions and 32 deletions.
73 changes: 41 additions & 32 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,74 +4,83 @@ This documentation follows the arc42 template to provide a comprehensive overvie

## 1. Introduction and Goals

This chapter provides an overview of the project, including its purpose, goals, and business context.

### [Business Context](./architecture/Context%20and%20scope.md#Business-Context)

[The business context section](./architecture/Context%20and%20scope.md#Business-Context) outlines the project's background, including the problem statement, stakeholders, and objectives.

## 2. [Constraints](./architecture/Architecture%20Constraints.md)

[The constraints document](./architecture/Architecture%20Constraints.md) outlines the various constraints that affect the architecture of the system, including general constraints, developer constraints, and any other relevant limitations.

### [General Constraints](./architecture/Architecture%20Constraints.md#General-Constraints)

[The general constraints section](./architecture/Architecture%20Constraints.md#General-Constraints) outlines the constraints that impact the design and implementation of the system, such as regulatory requirements and technology restrictions.

### [Developer Constraints](./architecture/Architecture%20Constraints.md#Developer-Constraints)

## 3. [Context and Scope](./architecture/Context%20and%20scope.md)
[The developer constraints section](./architecture/Architecture%20Constraints.md#Developer-Constraints) specifies the coding guidelines, tools, technologies, and licensing requirements that developers must follow.

## 4. [Solution Strategy](./architecture/Solution%20strategy.md)
## 3. [Context and Scope](./architecture/Context%20and%20scope.md)

## 5. Building Block View
[The context and scope document](./architecture/Context%20and%20scope.md) provides an overview of the system's context and scope, including its boundaries and interactions with external systems.

## 6. Runtime View
## 4. [Solution Strategy](./architecture/Solution%20strategy.md)

## 7. Deployment View
[The solution strategy document](./architecture/Solution%20strategy.md) outlines the overall strategy for the solution, including the key principles and approaches that guide the design and implementation of the system.

## 8. Crosscutting Concepts
## 5. Building Block View

### [Operational Concept](./architecture/Operational%20Concept.md)
The building block view details the system's static structure, including its modules, components, subsystems, and their relationships and dependencies.

### [Development Concept](./architecture/Development%20Concept.md)
To be added.

### [Security Assessment](./architecture/Security_Assessment.md)
## 6. Runtime View

## 9. Architecture Decisions
The runtime view describes the dynamic behavior of the system, focusing on the interactions between components and the flow of control during the execution of various use cases or scenarios.

## 10. Quality Requirements
To be added.

## 11. Risks and Technical Debt
## 7. Deployment View

### [Threats & Risks](./architecture/Security_Assessment.md#Threats-&-Risks)
The deployment view describes the physical deployment of the system, including the hardware and software components, network topology, and infrastructure configuration.

## 12. Glossary
To be added.

### Self-Sovereign Identity (SSI)
## 8. Crosscutting Concepts

A decentralized identity model where individuals or organizations have control over their digital identities without relying on a central authority.
This section describes overall, principal regulations and solution ideas that are relevant in multiple parts of your system.

### Schema
### [Operational Concept](./architecture/Operational%20Concept.md)

A structured framework or blueprint that defines the format and types of data that can be stored in a credential.
[The operational concept section](./architecture/Operational%20Concept.md) outlines the operational aspects of the system, including monitoring, maintenance, and operational procedures.

### Credential
### [Development Concept](./architecture/Development%20Concept.md)

A digital document that certifies certain attributes or claims about an individual or organization, issued by a trusted authority.
[The development concept section](./architecture/Development%20Concept.md) outlines the development practices, tools, and methodologies used in the project.

### Credential Definition
### [Security Assessment](./architecture/Security_Assessment.md)

A specific implementation of a schema that includes additional metadata and rules for issuing and verifying credentials.
[The security assessment chapter](./architecture/Security_Assessment.md) outlines the security measures in place, including threat modeling and risk mitigation strategies.

### DID (Decentralized Identifier)
## 9. Architecture Decisions

A globally unique identifier that is created, owned, and controlled by the individual or organization it represents, without the need for a central registry.
The architecture decisions document outlines the key architecture decisions made during the project, including the rationale and implications of each decision.
This chapter documents significant.

### Verifiable Credential
## 10. [Quality Requirements](./architecture/Requirements.md)

A tamper-evident credential that can be cryptographically verified to ensure its authenticity and integrity.
[The quality requirements document](./architecture/Requirements.md) outlines the quality attributes the system must meet, such as performance, security, maintainability, and usability.

### Issuer
## 11. Risks and Technical Debt

An entity that creates and issues credentials to individuals or organizations.
This chapter identifies potential risks and technical debt within the project, along with strategies for mitigation.

### Holder
### [Threats & Risks](./architecture/Security_Assessment.md#Threats-&-Risks)

An individual or organization that receives and stores credentials issued by an issuer.
[The threats and risks](./architecture/Security_Assessment.md#Threats-&-Risks) section outlines potential security threats and risks to the system.

### Verifier
## 12. [Glossary](./architecture/Glossary.md)

An entity that requests and verifies credentials presented by a holder to confirm the authenticity of the claims.
[The glossary](./architecture/Glossary.md) provides definitions for specialized terms and concepts used within the SSI Authority & Schema Registry project.
47 changes: 47 additions & 0 deletions docs/architecture/Glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Glossary

## Key Terms and Definitions

### Self-Sovereign Identity (SSI)

A decentralized identity model where individuals or organizations have control over their digital identities without relying on a central authority.

### Schema

A structured framework or blueprint that defines the format and types of data that can be stored in a credential.

### Credential

A digital document that certifies certain attributes or claims about an individual or organization, issued by a trusted authority.

### Credential Definition

A specific implementation of a schema that includes additional metadata and rules for issuing and verifying credentials.

### DID (Decentralized Identifier)

A globally unique identifier that is created, owned, and controlled by the individual or organization it represents, without the need for a central registry.

### Verifiable Credential

A tamper-evident credential that can be cryptographically verified to ensure its authenticity and integrity.

### Issuer

An entity that creates and issues credentials to individuals or organizations.

### Holder

An individual or organization that receives and stores credentials issued by an issuer.

### Verifier

An entity that requests and verifies credentials presented by a holder to confirm the authenticity of the claims.

## 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/ssi-authority-schema-registry

0 comments on commit cb0ee01

Please sign in to comment.