Openapi for 5GCoreNetSDK

The code in this repository is generated automatically using a GitHub Action workflow. DO NOT EDIT THE CODE IN THIS REPOSITORY.

This repository contains the Go code generated from the 5GC OpenAPI specifications provided here used by the 5GCoreNetSDK.

We use the OpenAPI Generator to generate the code from the OpenAPI specifications automatically using a GitHub Action workflow that runs every month and creates a Pull Request with the generated code if there are any changes.

Feel free to create an issue if there are any updates to the OpenAPI specifications we will update the code in this repository manually.

Also, it is possible to run the code generation locally, see Run locally for more information.

Feel free to use the code in this repository for your own projects. If you do, please consider giving us a star ⭐.

Run locally

Sometimes you may want to generate the code locally. This is possible by following the steps below.

Prerequisites

The following tools are required to run the code generation locally:

• docker
• act

Act is a tool to run GitHub Actions locally. It is used to run the GitHub Action workflow that generates the code.

Clone

As the code generation is done in a GitHub Action workflow, the repository needs to be cloned first.

git clone https://github.com/5GCoreNet/openapi
git submodule update --init --recursive

Run

To run the code generation locally, run the following command:

cd openapi
act

This will generate the code in the current directory. Be aware that the code generation may overwrite the existing code.

License

This project uses the Apache 2.0 license.

Contributing

See CONTRIBUTING.md.