{"openapi":"3.0.0","servers":[{"description":"3GPP SA4 5G Media Streaming Interfaces","url":"https://virtserver.swaggerhub.com/ibouazizi/3gpp-m1d/1.0.0"},{"url":"https://www.3gpp.org/3gpp-m1d/v1","description":"5G Media Provisioning Interface","variables":{}}],"info":{"description":"Documentation of the 3GPP M1d Provisioning interface.","version":"1.0.0","title":"3GPP M1d interface","contact":{"email":"bouazizi@qti.qualcomm.com"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"tags":[{"name":"3GPP TS 26.512","description":"5G Media Provisioning Interface M1d","externalDocs":{"description":"Find out more","url":"http://www.3gpp.org"}}],"paths":{"/provisioning-sessions":{"get":{"summary":"List of all Provisionings","description":"","parameters":[{"name":"provisioningSessionId","in":"query","required":false,"schema":{"type":"string"},"description":"A unique identifier of the Provisioning"}],"operationId":"listProvisionings","responses":{"200":{"description":"list of Provisioning Sessions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProvisioningSession"}}}}}},"post":{"summary":"Create a new Provisioning Session","description":"","requestBody":{"description":"initial configuration of new Provisioning Session","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProvisioningSession"}}}},"parameters":[],"operationId":"Create a new Provisioning Session","responses":{"201":{"description":"Created"}}}},"/provisioning-sessions/{provisioningSessionId}":{"parameters":[{"name":"provisioningSessionId","in":"path","required":true,"schema":{"type":"string"},"description":"A unique identifier of the Provisioning Session"}],"get":{"summary":"Get Provisioning Session","description":"","parameters":[],"operationId":"getProvisioningById","responses":{"200":{"description":"list of Provisioning sessions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProvisioningSession"}}}}}},"put":{"summary":"Update a Provisioning Session","description":"","parameters":[],"operationId":"","responses":{"default":{"description":"Default response"}}},"delete":{"summary":"","description":"","parameters":[],"operationId":"","responses":{"default":{"description":"Default response"}}}},"/provisioning-sessions/{provisioningSessionId}/content-hosting-configurations":{"parameters":[{"name":"provisioningSessionId","in":"path","required":true,"schema":{"type":"string"},"description":"A unique identifier of the Provisioning"}],"get":{"summary":"retrieve an existing Content Hosting Configuration","description":"retrieve an existing Content Hosting Configuration","parameters":[{"name":"contentHostingConfigurationId","in":"query","required":false,"schema":{"type":"string"},"description":"A unique identifier of the Content Hosting Configuration"}],"responses":{"200":{"description":"The Content Hosting Configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentHostingConfiguration"}}}}}},"post":{"summary":"create a Content Hosting Configuration","description":"Used to retrieve an existing Content Hosting Configuration","responses":{"201":{"description":"Created","headers":{"Location":{"description":"Location of the newly created Content Hosting Configuration","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentHostingConfiguration"}}}}}}},"/provisioning-sessions/{provisioningSessionId}/content-hosting-configuration/{contentHostingConfigurationId}":{"parameters":[{"name":"provisioningSessionId","in":"path","required":true,"schema":{"type":"string"},"description":"A unique identifier of the Provisioning Session"},{"name":"contentHostingConfigurationId","in":"path","required":true,"schema":{"type":"string"},"description":"A unique identifier of the Content Hosting Configuration"}],"get":{"summary":"retrieve an existing Content Hosting Configuration","description":"retrieve an existing Content Hosting Configuration","responses":{"200":{"description":"The identified Provisioning","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentHostingConfiguration"}}}}}},"put":{"summary":"","description":"","responses":{"default":{"description":""}}},"delete":{"summary":"","description":"","responses":{"default":{"description":"Default response"}}}},"/provisioning-sessions/{provisioningSessionId}/content-hosting-configuration/{contentHostingConfigurationId}/purge":{"parameters":[{"name":"provisioningSessionId","in":"path","required":true,"schema":{"type":"string"},"description":"A unique identifier of the Provisioning"},{"name":"contentHostingConfigurationId","in":"path","required":true,"schema":{"type":"string"},"description":"A unique identifier of the Content Hosting Configuration"}],"post":{"summary":"Purge the content of the cache","description":"","requestBody":{"description":"The RegEx pattern for resources to purge from the cache","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pattern"}}}},"responses":{"200":{"description":"Content was purged successfully"}}}},"/provisioning-sessions/{provisioningSessionId}/certificates":{"parameters":[{"name":"provisioningSessionId","in":"path","required":true,"schema":{"type":"string"},"description":"A unique identifier of the the Provisioning"}],"post":{"summary":"Create a new security certificate","description":"","responses":{"200":{"description":"The generated certificate","headers":{"Location":{"description":"Location of the newly created server certificate","schema":{"type":"string"}}},"content":{"application/x-pem-file":{"schema":{"type":"string"}}}}}},"get":{"summary":"retrieve previously uploaded server certificate","parameters":[{"name":"certificateId","in":"path","required":true,"schema":{"type":"string"},"description":"A unisque identifier of the server certificate"}],"responses":{"200":{"description":"the server certificate","content":{"application/x-pem-file":{"schema":{"type":"string"}}}}}}},"/provisioning-sessions/{provisioningSessionId}/consumption-reporting-configuration":{"parameters":[{"name":"provisioningSessionId","in":"path","required":true,"schema":{"type":"string"},"description":"A unique identifier of the Provisioning"}],"post":{"summary":"Activate the consumption reporting procedure","description":"Activate the consumption reporting procedure","responses":{"200":{"description":"the consumption reporting is successfully activate"}}},"get":{"summary":"Retrieve the consumption reporting configuration","description":"retrieve the consumption reporting configuration","responses":{"200":{"description":"a description of the consumption reporting configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsumptionReportingConfiguration"}}}}}}},"/provisioning-sessions/{provisioningSessionId}/policy-templates":{"parameters":[{"name":"provisioningSessionId","in":"path","required":true,"schema":{"type":"string"},"description":"A unique identifier of the Provisioning Session"}],"post":{"summary":"Create a new Policy Template","description":"create a new Policy Template","responses":{"201":{"description":"the newly created Policy Template","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyTemplate"}}}}}}},"/provisioning-sessions/{provisioningSessionId}/policy-templates/{policyTemplateId}":{"parameters":[{"name":"provisioningSessionId","in":"path","required":true,"schema":{"type":"string"},"description":"A unique identifier of the Provisioning Session"},{"name":"policyTemplateId","in":"path","required":true,"schema":{"type":"string"},"description":"A unique identifier of the Policy Template"}],"get":{"summary":"retrieve a description of the Policy Template","description":"retrieve a description of the Policy Template","responses":{"200":{"description":"a description of the Policy Template","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyTemplate"}}}}}},"put":{"summary":"modify the configuration of a Policy Template","description":"","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyTemplate"}}}},"responses":{"200":{"description":"update a policy template","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyTemplate"}}}}}},"delete":{"summary":"delete a Policy Template","description":"delete a Policy Template","responses":{"200":{"description":"a Policy Template is deleted"}}}}},"externalDocs":{"description":"TS 26.512","url":"http://www.3gpp.org/DynaReport/26346.htm"},"components":{"schemas":{"ProvisioningSession":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64"}}},"ContentHostingConfiguration":{"type":"object","required":["id","origin"],"properties":{"id":{"type":"integer","format":"int64"},"ingestConfiguration":{"$ref":"#/components/schemas/IngestConfiguration"},"distributionConfiguration":{"type":"array","items":{"$ref":"#/components/schemas/DistributionConfiguration"}}}},"IngestConfiguration":{"type":"object","properties":{"name":{"type":"string"},"path":{"type":"string"},"pull":{"type":"boolean"},"protocol":{"type":"string","enum":["dashifpush"]},"entryPoint":{"type":"string"}},"xml":{"name":"IngestConfiguration"}},"DistributionConfiguration":{"type":"object","properties":{"contentPreparationTemplateId":{"type":"string"},"targetDomain":{"type":"string"},"originDomain":{"type":"string"},"pathRewriteRules":{"type":"array","items":{"$ref":"#/components/schemas/PathRewriteRule"}},"cacheConfiguration":{"type":"array","items":{"$ref":"#/components/schemas/CachingConfiguration"}},"geoFencing":{"type":"array","items":{"$ref":"#/components/schemas/Geo"}},"urlSignature":{"type":"object","properties":{"urlPattern":{"type":"string"},"tokenName":{"type":"string"},"passphraseName":{"type":"string"},"passphrase":{"type":"string"},"tokenExpiryName":{"type":"string"},"useIPAddress":{"type":"boolean"},"ipAddressName":{"type":"string"}}},"certificateId":{"type":"integer"}},"xml":{"name":"DistributionConfiguration"}},"PathRewriteRule":{"type":"object","properties":{"originPathPattern":{"type":"string"},"distributionPath":{"type":"string"}}},"CachingConfiguration":{"type":"object","properties":{"urlPatternFilter":{"type":"string"},"cachingDirectives":{"type":"object","properties":{"statusCodeFilters":{"type":"array","items":{"type":"integer"}},"noCache":{"type":"boolean"},"maxAge":{"type":"integer","format":"int32"}}}}},"Geo":{"type":"object","properties":{"locationType":{"type":"string","enum":["cell","city"]},"locations":{"type":"array","items":{"type":"string"}}}},"Pattern":{"type":"object","properties":{"pattern":{"type":"string"}}},"ConsumptionReportingConfiguration":{"type":"object","properties":{"reportingInterval":{"$ref":"https://forge.etsi.org/rep/3GPP/5G_APIs/blob/master/TS29122_CommonData.yaml#/components/schemas/DurationSec"},"samplePercentage":{"type":"number","format":"float","minimum":0.0,"maximum":100.0},"locationType":{"$ref":"#/components/schemas/Geo"}}},"PolicyTemplate":{"type":"object","required":["policyTemplateId"],"properties":{"policyTemplateId":{"type":"integer"},"state":{"type":"string","default":"suspended","enum":["pending","ready","suspended"]},"apiEndPoint":{"type":"string"},"apiType":{"type":"string","default":"N5","enum":["N5","N33"]},"externalReference":{"type":"string"},"qosSpecification":{"$ref":"#/components/schemas/QoSSpecification"},"applicationSessionContext":{"$ref":"#/components/schemas/ApplicationSessionContext"},"chargingSpecification":{"$ref":"#/components/schemas/ChargingSpecification"}}},"QoSSpecification":{"type":"object","properties":{"marBwUl":{"$ref":"https://forge.etsi.org/rep/3GPP/5G_APIs/blob/master/TS29571_CommonData.yaml#/components/schemas/BitRate"},"marBwDl":{"$ref":"https://forge.etsi.org/rep/3GPP/5G_APIs/blob/master/TS29571_CommonData.yaml#/components/schemas/BitRate"},"maxPacketLossRateDl":{"$ref":"https://forge.etsi.org/rep/3GPP/5G_APIs/blob/master/TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm"},"maxPacketLossRateUl":{"$ref":"https://forge.etsi.org/rep/3GPP/5G_APIs/blob/master/TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm"},"maxSuppBwDl":{"$ref":"https://forge.etsi.org/rep/3GPP/5G_APIs/blob/master/TS29571_CommonData.yaml#/components/schemas/BitRate"},"maxSuppBwUl":{"$ref":"https://forge.etsi.org/rep/3GPP/5G_APIs/blob/master/TS29571_CommonData.yaml#/components/schemas/BitRate"},"minDesBwDl":{"$ref":"https://forge.etsi.org/rep/3GPP/5G_APIs/blob/master/TS29571_CommonData.yaml#/components/schemas/BitRate"},"minDesBwUl":{"$ref":"https://forge.etsi.org/rep/3GPP/5G_APIs/blob/master/TS29571_CommonData.yaml#/components/schemas/BitRate"},"mirBwUl":{"$ref":"https://forge.etsi.org/rep/3GPP/5G_APIs/blob/master/TS29571_CommonData.yaml#/components/schemas/BitRate"},"mirBwDl":{"$ref":"https://forge.etsi.org/rep/3GPP/5G_APIs/blob/master/TS29571_CommonData.yaml#/components/schemas/BitRate"}}},"ApplicationSessionContext":{"type":"object","properties":{"afAppId":{"$ref":"https://forge.etsi.org/rep/3GPP/5G_APIs/blob/master/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AfAppId"},"sliceInfo":{"$ref":"https://forge.etsi.org/rep/3GPP/5G_APIs/blob/master/TS29571_CommonData.yaml#/components/schemas/Snssai"},"dnn":{"$ref":"https://forge.etsi.org/rep/3GPP/5G_APIs/blob/master/TS29571_CommonData.yaml#/components/schemas/Dnn"},"aspId":{"$ref":"https://forge.etsi.org/rep/3GPP/5G_APIs/blob/master/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AspId"}}},"ChargingSpecification":{"type":"object","properties":{"sponId":{"type":"string"},"sponStatus":{"$ref":"https://forge.etsi.org/rep/3GPP/5G_APIs/blob/master/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/SponsoringStatus"},"gpsi":{"type":"array","items":{"$ref":"https://forge.etsi.org/rep/3GPP/5G_APIs/blob/master/TS29571_CommonData.yaml#/components/schemas/Gpsi"}}}}},"securitySchemes":{"m1d_auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://www.3gpp.org/3gpp-m1d/v1/authorize","tokenUrl":"https://www.3gpp.org/3gpp-m1d/v1/token","scopes":{"read":"Grants read access","write":"Grants write access","admin":"Grants access to admin operations"}}}}},"links":{},"callbacks":{}},"security":[{"m1d_auth":[]}]}