X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=enrichment-coordinator-service%2Fdocs%2Fapi.yaml;h=570caee66d9008ad324c7bbc7a549ff045dd0847;hb=af40dc43f26d3fea66ac04625080314162e93496;hp=bb34e2bc12cad9c58f113f1901dd123149ed0cf2;hpb=ebf3211ddd6e634ca9c0a2fec56abd1f12c7625d;p=nonrtric.git diff --git a/enrichment-coordinator-service/docs/api.yaml b/enrichment-coordinator-service/docs/api.yaml index bb34e2bc..570caee6 100644 --- a/enrichment-coordinator-service/docs/api.yaml +++ b/enrichment-coordinator-service/docs/api.yaml @@ -17,8 +17,7 @@ paths: get: tags: - A1-E Enrichment Data Consumer API - summary: Query EI type identifiers - description: DETAILS TBD + summary: EI type identifiers operationId: getEiTypeIdentifiersUsingGET produces: - application/json @@ -40,8 +39,7 @@ paths: get: tags: - A1-E Enrichment Data Consumer API - summary: Definitions for an individual EI Type - description: Query EI type + summary: Individual EI type operationId: getEiTypeUsingGET produces: - application/json @@ -69,8 +67,7 @@ paths: get: tags: - A1-E Enrichment Data Consumer API - summary: Query EI job identifiers - description: Returns the identifiers for an EI Type + summary: EI job identifiers operationId: getEiJobIdsUsingGET produces: - application/json @@ -88,7 +85,7 @@ paths: type: string responses: '200': - description: EI type + description: EI job identifiers schema: type: array items: @@ -139,7 +136,6 @@ paths: tags: - A1-E Enrichment Data Consumer API summary: Individual EI Job - description: Create or update an EI Job operationId: putIndividualEiJobUsingPUT consumes: - application/json @@ -184,7 +180,6 @@ paths: tags: - A1-E Enrichment Data Consumer API summary: Individual EI Job - description: Delete an EI job operationId: deleteIndividualEiJobUsingDELETE produces: - application/json @@ -254,8 +249,7 @@ paths: get: tags: - Enrichment Data Producer API - summary: Query EI producer identifiers - description: DETAILS TBD + summary: EI producer identifiers operationId: getEiProducerIdentifiersUsingGET produces: - application/json @@ -277,8 +271,7 @@ paths: get: tags: - Enrichment Data Producer API - summary: Job definition for an individual EI producer - description: Query EI jobs + summary: Individual EI producer operationId: getEiProducerUsingGET produces: - application/json @@ -292,7 +285,7 @@ paths: '200': description: EI Jobs schema: - $ref: '#/definitions/producer_ei_type_info' + $ref: '#/definitions/producer_registration_info' '401': description: Unauthorized '403': @@ -305,8 +298,7 @@ paths: put: tags: - Enrichment Data Producer API - summary: Definitions for an individual EI producer - description: Put EI producer + summary: Individual EI producer operationId: putEiProducerUsingPUT consumes: - application/json @@ -343,8 +335,7 @@ paths: delete: tags: - Enrichment Data Producer API - summary: Individual EI Producer - description: Delete an EI Producer + summary: Individual EI producer operationId: deleteEiProducerUsingDELETE produces: - application/json @@ -376,8 +367,8 @@ paths: get: tags: - Enrichment Data Producer API - summary: Job definition for an individual EI producer - description: Query EI producer jobs + summary: EI job definitions + description: EI job definitions for one EI producer operationId: getEiProducerJobsUsingGET produces: - application/json @@ -407,8 +398,7 @@ paths: get: tags: - Enrichment Data Producer API - summary: Query EI type identifiers - description: DETAILS TBD + summary: EI type identifiers operationId: getEiTypeIdentifiersUsingGET_1 produces: - application/json @@ -430,8 +420,7 @@ paths: get: tags: - Enrichment Data Producer API - summary: Definitions for an individual EI Type - description: Query EI type + summary: Individual EI Type operationId: getEiTypeUsingGET_1 produces: - application/json @@ -459,7 +448,7 @@ paths: post: tags: - Producer Simulator - summary: Callback for job creation + summary: Callback for EI job creation operationId: jobCreatedCallbackUsingPOST consumes: - application/json @@ -490,7 +479,7 @@ paths: post: tags: - Producer Simulator - summary: Callback for job deletion + summary: Callback for EI job deletion operationId: jobDeletedCallbackUsingPOST consumes: - application/json @@ -522,14 +511,18 @@ definitions: type: object required: - job_data - - owner + - job_owner + - target_uri properties: job_data: type: object description: EI Type specific job data - owner: + job_owner: type: string description: Identity of the owner of the job + target_uri: + type: string + description: The target of the EI data title: ei_job_info description: Information for a Enrichment Information Job ei_job_status: @@ -540,8 +533,8 @@ definitions: operational_state: type: string description: |- - Operational state, values: - ENABLED: TBD + Operational state, values: + ENABLED: TBD DISABLED: TBD. enum: - ENABLED @@ -562,37 +555,40 @@ definitions: detail: type: string example: EI job type not found - description: ' A human-readable explanation specific to this occurrence of the problem.' + description: A human-readable explanation specific to this occurrence of the problem. status: type: integer format: int32 - example: 503 - description: 'The HTTP status code generated by the origin server for this occurrence of the problem. ' + example: 404 + description: The HTTP status code generated by the origin server for this occurrence of the problem. title: error_information description: 'Problem as defined in https://tools.ietf.org/html/rfc7807' producer_ei_job_request: type: object required: - - identity + - ei_job_identity properties: - identity: - type: string - description: Json for the job data - job_data: + ei_job_data: type: object description: Json for the job data - type_identity: + ei_job_identity: + type: string + description: Idenitity of the EI job + ei_type_identity: type: string description: Type idenitity for the job + target_uri: + type: string + description: URI for the target of the EI title: producer_ei_job_request - description: Information EI job start + description: The body of the EI producer callbacks for EI job creation and deletion producer_ei_type_info: type: object properties: - job_data_schema: + ei_job_data_schema: type: object description: Json schema for the job data - producer_ids: + ei_producer_ids: type: array description: Registered producers items: @@ -604,25 +600,25 @@ definitions: required: - ei_type_identity properties: + ei_job_data_schema: + type: object + description: Json schema for the job data ei_type_identity: type: string description: EI type identity - job_data_schema: - type: object - description: Json schema for the job data title: producer_ei_type_registration_info description: Information for an EI type producer_registration_info: type: object required: - - job_creation_callback_url - - job_deletion_callback_url + - ei_job_creation_callback_url + - ei_job_deletion_callback_url - supported_ei_types properties: - job_creation_callback_url: + ei_job_creation_callback_url: type: string description: callback for job creation - job_deletion_callback_url: + ei_job_deletion_callback_url: type: string description: callback for job deletion supported_ei_types: @@ -631,5 +627,5 @@ definitions: items: $ref: '#/definitions/producer_ei_type_registration_info' title: producer_registration_info - description: Information for an EI Producer + description: Information for an EI producer