Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use OpenAPI to bindings script from 5G-MAG/rt-common-shared repository. #34

Closed
davidjwbbc opened this issue Oct 6, 2022 · 3 comments · Fixed by #35
Closed

Use OpenAPI to bindings script from 5G-MAG/rt-common-shared repository. #34

davidjwbbc opened this issue Oct 6, 2022 · 3 comments · Fixed by #35
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@davidjwbbc
Copy link
Contributor

Enhancement

This project has a script at build_scripts/generate_openapi which is used to generate the python bindings from the 5G APIs OpenAPI YAML.

Once PR #33 has been merged, there will be a more generic version of this script at docs/rt-common-shared/5gms/scripts/generate_openapi.

When this script is available the build_scripts/generate_openapi should be modified to call the more generic script, from rt-common-shared, with appropriate parameters to build the bindings.

Requirements

PR #33 will need to be merged before this can be done.

@rjb1000
Copy link
Contributor

rjb1000 commented Oct 6, 2022

Seems a bit unintuitive to import the submodule under docs, @davidjwbbc.

@davidjwbbc
Copy link
Contributor Author

The location is due to the rt-common-shared submodule only having example files which were moved from the docs directory in this repository to rt-common-shared. So preserving the examples under docs seemed sensible. The rt-common-shared submodule now contains the helper scripts too, whiich means the location of this submodule should probably move out of the docs directory.

I would suggest:

  1. Move docs/rt-common-shared to external/rt-commonm-shared
  2. Modify pyproject.toml to distribute the examples from external/rt-common-shared/5gms/examples/* with the other docs.
  3. Add external/rt-common-shared as a recursive include in the MANIFEST.in
  4. Make build_scripts/generate_openapi use the common script from external/rt-common-shared/5gms/scripts/generate_openapi.
  5. Rename build_scripts/generate_openapi to build_scripts/generate_5gms_as_openapi to avoid confusion between the two scripts.
  6. Modify build_scripts/backend.py to use the renamed script.

@rjb1000
Copy link
Contributor

rjb1000 commented Oct 7, 2022

Sounds like a good plan, @davidjwbbc.

@davidjwbbc davidjwbbc moved this from Todo to In Progress in 5GMS: Basic media stream handling (MVP#1) Oct 7, 2022
davidjwbbc added a commit to davidjwbbc/rt-5gms-application-server that referenced this issue Oct 7, 2022
Closes 5G-MAG#34

Reworks the OpenAPI generator script to use the common generate_openapi script from rt-common-shared.
Move rt-common-shared submodule to a more appropriate directory since it doesn't just hold examples
anymore.
Rename the old generator script so that its name doesn't clash with the common script.
Modify the project build files to reflect the new names and directory structure.
@rjb1000 rjb1000 closed this as completed in 293dfe8 Oct 7, 2022
Repository owner moved this from In Progress to Done in 5GMS: Basic media stream handling (MVP#1) Oct 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants