Skip to content

abhi2303237/AAS

Repository files navigation

Concept Description Management Service

This project is a comprehensive implementation of the DotAAS Part 2 HTTP/REST Submodel Service Specification, which is part of the Specification of the Asset Administration Shell (AAS). It provides a set of APIs for managing Concept Descriptions, including operations to get, post, delete, and update Concept Descriptions. The project also includes a self-describing endpoint that returns the service's capabilities and profiles. The implementation follows the guidelines and standards set by the Industrial Digital Twin Association (IDTA) to ensure interoperability and consistency across different systems.

Key Features

  1. CRUD Operations: The service provides APIs to create, read, update, and delete Concept Descriptions.
  2. Self-Describing Endpoint: There is an endpoint that returns the service's capabilities and profiles.
  3. Interoperability: The implementation follows guidelines from the Industrial Digital Twin Association (IDTA) to ensure consistency and interoperability across different systems.

Endpoints

Get All Concept Descriptions

  • Endpoint: /concept-descriptions
  • Method: GET
  • Description: Retrieves all Concept Descriptions.

Post Concept Description

  • Endpoint: /concept-descriptions
  • Method: POST
  • Description: Creates a new Concept Description.

Delete Concept Description By ID

  • Endpoint: /concept-descriptions/{id}
  • Method: DELETE
  • Description: Deletes a Concept Description by its ID.

Get Concept Description By ID

  • Endpoint: /concept-descriptions/{id}
  • Method: GET
  • Description: Retrieves a Concept Description by its ID.

Put Concept Description By ID

  • Endpoint: /concept-descriptions/{id}
  • Method: PUT
  • Description: Updates a Concept Description by its ID.

Get Service Description

  • Endpoint: /description
  • Method: GET
  • Description: Provides a description of the service and its capabilities.

Example Code

Here is an example of the GetDescription function that provides a detailed description of the project's purpose and capabilities:

func (repo *ConceptDescriptionRepo) GetDescription(c *fiber.Ctx) error {
	description := "This project is a comprehensive implementation of the DotAAS Part 2 HTTP/REST Submodel Service Specification, which is part of the Specification of the Asset Administration Shell. It provides a set of APIs for managing Concept Descriptions, including operations to get, post, delete, and update Concept Descriptions. The project also includes a self-describing endpoint that returns the service's capabilities and profiles. The implementation follows the guidelines and standards set by the Industrial Digital Twin Association (IDTA) to ensure interoperability and consistency across different systems."
	return c.Status(http.StatusOK).SendString(description)
}

Getting Started

To get started with this project, follow these steps:

  1. Clone the repository:

    git clone https://github.com/yourusername/yourrepository.git
  2. Install dependencies:

    go mod tidy
  3. Run the service:

    go run main.go

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any changes.

License

This project is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published