Commit f24a46b5 authored by Mahesh Jethanandani's avatar Mahesh Jethanandani

Adding metadata file for yangcatalog

parent fb9620e7
Pipeline #1314 passed with stage
in 0 seconds
This README explains how the sol006-metadata.json file is used to populate
information in yangcatalog.org
This JSON file has been created using the example file described here. Note,
the first two lines in the example are really for putting on the command
line, and not be included in the JSON file.
Once the file has been populated, the following command should be used to
upload the metadata into the YANG Catalog.
curl -X PUT -u <username>:<password> -H "Content-type: application/json" https://yangcatalog.org/api/modules --upload-file sol006-metadata.json
where the 'username' and 'password' can be requested at
https://yangcatalog.org/create.html.
A successfule submission should result in an output that gives a job-id
like this:
{"info":"Verification successful","job-id":"75883423-a6b7-4e9e-94ad-0983a0a8cac7"}
Use the following link to verify the status of the job:
https://yangcatalog.org/api/job/<job-id>
If the submission is in progress, expect an output as follows:
{"info":{"job-id":"7b7f3436-34e9-4947-aa60-402102cdff05","reason":null,"result":"In progress\n"}}
and once it is complete, and the submission fails, expect an output as
follows:
{"info":{"job-id":"7b7f3436-34e9-4947-aa60-402102cdff05","reason":null,"result":"Failed\n"}}
Or if it is successful expect an output like this:
{"info":{"job-id":"75883423-a6b7-4e9e-94ad-0983a0a8cac7","reason":null,"result":"Finished successfully\n"}}
\ No newline at end of file
{
"modules": {
"module": [
{
"author-email": "pnns@etsi.org",
"document-name": "NFV descriptors based on YANG specification <https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/006/02.06.01_60/gs_nfv-sol006v020601p.pdf>",
"generated-from": "not-applicable",
"maturity-level": "ratified",
"name": "etsi-nfv-descriptors",
"organization": "etsi",
"reference": "https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/006/02.06.01_60/gs_nfv-sol006v020601p.pdf",
"module-classification": "network-service",
"revision": "2019-04-25",
"source-file": {
"owner": "YangModels",
"path": "standard/etsi/SOL006/src/yang/etsi-nfv-descriptors.yang",
"repository": "yang"
}
},
{
"author-email": "pnns@etsi.org",
"document-name": "NFV descriptors based on YANG specification <https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/006/02.06.01_60/gs_nfv-sol006v020601p.pdf>",
"generated-from": "not-applicable",
"maturity-level": "ratified",
"name": "etsi-nfv-common",
"organization": "etsi",
"reference": "https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/006/02.06.01_60/gs_nfv-sol006v020601p.pdf",
"module-classification": "network-service",
"revision": "2019-04-25",
"source-file": {
"owner": "YangModels",
"path": "standard/etsi/SOL006/src/yang/etsi-nfv-common.yang",
"repository": "yang"
}
},
{
"author-email": "pnns@etsi.org",
"document-name": "NFV descriptors based on YANG specification <https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/006/02.06.01_60/gs_nfv-sol006v020601p.pdf>",
"generated-from": "not-applicable",
"maturity-level": "ratified",
"name": "etsi-nfv-ns",
"organization": "etsi",
"reference": "https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/006/02.06.01_60/gs_nfv-sol006v020601p.pdf",
"module-classification": "network-service",
"revision": "2019-04-25",
"source-file": {
"owner": "YangModels",
"path": "standard/etsi/SOL006/src/yang/etsi-nfv-ns.yang",
"repository": "yang"
}
},
{
"author-email": "pnns@etsi.org",
"document-name": "NFV descriptors based on YANG specification <https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/006/02.06.01_60/gs_nfv-sol006v020601p.pdf>",
"generated-from": "not-applicable",
"maturity-level": "ratified",
"name": "etsi-nfv-nsd",
"organization": "etsi",
"reference": "https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/006/02.06.01_60/gs_nfv-sol006v020601p.pdf",
"module-classification": "network-service",
"revision": "2019-04-25",
"source-file": {
"owner": "YangModels",
"path": "standard/etsi/SOL006/src/yang/etsi-nfv-nsd.yang",
"repository": "yang"
}
},
{
"author-email": "pnns@etsi.org",
"document-name": "NFV descriptors based on YANG specification <https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/006/02.06.01_60/gs_nfv-sol006v020601p.pdf>",
"generated-from": "not-applicable",
"maturity-level": "ratified",
"name": "etsi-nfv-pnf",
"organization": "etsi",
"reference": "https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/006/02.06.01_60/gs_nfv-sol006v020601p.pdf",
"module-classification": "network-service",
"revision": "2019-04-25",
"source-file": {
"owner": "YangModels",
"path": "standard/etsi/SOL006/src/yang/etsi-nfv-pnf.yang",
"repository": "yang"
}
},
{
"author-email": "pnns@etsi.org",
"document-name": "NFV descriptors based on YANG specification <https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/006/02.06.01_60/gs_nfv-sol006v020601p.pdf>",
"generated-from": "not-applicable",
"maturity-level": "ratified",
"name": "etsi-nfv-pnfd",
"organization": "etsi",
"reference": "https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/006/02.06.01_60/gs_nfv-sol006v020601p.pdf",
"module-classification": "network-service",
"revision": "2019-04-25",
"source-file": {
"owner": "YangModels",
"path": "standard/etsi/SOL006/src/yang/etsi-nfv-pnfd.yang",
"repository": "yang"
}
},
{
"author-email": "pnns@etsi.org",
"document-name": "NFV descriptors based on YANG specification <https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/006/02.06.01_60/gs_nfv-sol006v020601p.pdf>",
"generated-from": "not-applicable",
"maturity-level": "ratified",
"name": "etsi-nfv-vnf",
"organization": "etsi",
"reference": "https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/006/02.06.01_60/gs_nfv-sol006v020601p.pdf",
"module-classification": "network-service",
"revision": "2019-04-25",
"source-file": {
"owner": "YangModels",
"path": "standard/etsi/SOL006/src/yang/etsi-nfv-vnf.yang",
"repository": "yang"
}
},
{
"author-email": "pnns@etsi.org",
"document-name": "NFV descriptors based on YANG specification <https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/006/02.06.01_60/gs_nfv-sol006v020601p.pdf>",
"generated-from": "not-applicable",
"maturity-level": "ratified",
"name": "etsi-nfv-vnfd",
"organization": "etsi",
"reference": "https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/006/02.06.01_60/gs_nfv-sol006v020601p.pdf",
"module-classification": "network-service",
"revision": "2019-04-25",
"source-file": {
"owner": "YangModels",
"path": "standard/etsi/SOL006/src/yang/etsi-nfv-vnfd.yang",
"repository": "yang"
}
}
]
}
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment