X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=capifcore%2FREADME.md;h=657687fda7951d7ebaecf8537f2aa7a4527151a8;hb=c2422dba52b7c2fe640ff957137ccf64d2c96753;hp=5eea851d0475408ce6f89593a3d6bf698032f37a;hpb=c956436e747ab021a2593aae4f46fdbc66ece7fb;p=nonrtric%2Fplt%2Fsme.git diff --git a/capifcore/README.md b/capifcore/README.md index 5eea851..657687f 100644 --- a/capifcore/README.md +++ b/capifcore/README.md @@ -27,11 +27,11 @@ This product is a Go implementation of the CAPIF Core function, based on the 3GP ## Generation of API code The CAPIF APIs are generated from the OpenAPI specification provided by 3GPP. The `generate.sh` script downloads the -specifications from 3GPP, fixes them and then generates the APIs. It also generates the mocks needed for unit testing. +specifications from 3GPP, fixes them and then generates the APIs. It also generates the mocks needed for unit testing. The specifications are downloaded from the following site; https://www.3gpp.org/ftp/Specs/archive/29_series. To see the APIs in swagger format, see the following link; https://github.com/jdegre/5GC_APIs/tree/Rel-16#common-api-framework-capif. **NOTE!** The documentation in this link is for release 16 of CAPIF, the downloaded specifications are for release 17. To fix the specifications there are three tools: - `commoncollector`, collects type definitions from peripheral specifications to keep down the number of dependencies to - other specifications. The types to collect are listed in the `definitions.txt`file. + other specifications. The types to collect are listed in the `definitions.txt`file. Some fixes are hard coded. - `enumfixer`, fixes enumeration definitions so they can be properly generated. - `specificationfixer`, fixes flaws in the specifications so they can be properly generated. All fixes are hard coded.