Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

server/app/interfaces/repository.py: Implement missing `/submodels` endpoints

Open
#528 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
55/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
api, backend

Research direction

Start in server/app/interfaces/repository.py at the three routes currently using self.not_implemented, then read the linked Submodel Repository Service OpenAPI operations and issue #439. Done means GET /submodels/$value and GET /submodels/$path return the specified representations, while PATCH /submodels/{submodelIdentifier} updates an existing submodel and returns the specified success response.

Written by the indexing model from the issue text.

Description

feature high priority server

Current Situation

Currently, several server endpoints under /submodels are not implemented:

"/$value", methods=["GET"], endpoint=self.not_implemented
"/$path", methods=["GET"], endpoint=self.not_implemented
"/<base64url:submodel_id>", methods=["PATCH"], endpoint=self.not_implemented

According to the Submodel Repository Service OpenAPI Specification, the GET /submodels/$value endpoint should return all Submodels in value only representation.

[...]
responses:
        '200':
          description: Requested Submodels
          content:
            application/json:
              schema:
                $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/schemas/GetSubmodelsValueResult'
[...]

The GET /submodels/$path endpoint should return all Submodels in their path notation.

[...]
responses:
        '200':
          description: Requested Submodels
          content:
            application/json:
              schema:
                $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/schemas/GetPathItemsResult'
[...]

The PATCH /submodels/{submodelIdentifier} endpoint should support the updating of existing submodels.

[...]
responses:
        '204':
          description: Submodel updated successfully
[...]

This issue specifies https://github.com/eclipse-basyx/basyx-python-sdk/issues/439.

Proposed Change

We should evaluate and, if feasible, implement the three missing GET /submodels/$value, GET /submodels/$path and PATCH /submodels/{submodelIdentifier} endpoints according to the specification.

Dominant language
Python
Stars
102
Forks
52
Avg merge
20d 17h
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from eclipse-basyx/basyx-python-sdk

All issues in eclipse-basyx/basyx-python-sdk

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.