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

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

Closed
  • Is something wrong?
#529 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 4 days

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
Quiet
Tech stack
python
Domain
api, backend

Research direction

Start in server/app/interfaces/repository.py at the four routes currently using self.not_implemented, and compare their behavior with the linked Submodel Repository Service OpenAPI operations and issue #439. Done means implementing the metadata and value PATCH operations plus the value and path GET operations with the specified responses.

Written by the indexing model from the issue text.

Description

feature high priority server

Current Situation

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

"/$metadata", methods=["PATCH"], endpoint=self.not_implemented
"/$value", methods=["GET"], endpoint=self.not_implemented
"/$value", methods=["PATCH"], endpoint=self.not_implemented
"/$path", methods=["GET"], endpoint=self.not_implemented

According to the Submodel Repository Service OpenAPI Specification, the PATCH /submodels/{submodelIdentifier}/$metadata endpoint should update the metadata attributes of an existing Submodel.

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

The GET /submodels/{submodelIdentifier}/$value endpoint should return the specific Submodel in its value only representation.

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

The PATCH /submodels/{submodelIdentifier}/$value endpoint should support the updating of the values of an existing Submodel.

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

The GET /submodels/{submodelIdentifier}/$path endpoint should return a specific Submodel in path notation.

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

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

Proposed Change

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

Dominant language
Python
Stars
104
Forks
56
Avg merge
12d 13h
Merged PRs (30d)
5

Getting set up

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.