diff --git a/schemas/components/schemas/LabelsEventError.yaml b/schemas/components/schemas/LabelSubmissionError.yaml similarity index 67% rename from schemas/components/schemas/LabelsEventError.yaml rename to schemas/components/schemas/LabelSubmissionError.yaml index f3064acb..029940b3 100644 --- a/schemas/components/schemas/LabelsEventError.yaml +++ b/schemas/components/schemas/LabelSubmissionError.yaml @@ -1,5 +1,5 @@ type: object -description: A stable error code and message describing why a label submission was rejected. +description: A stable error code and message describing why labels in a submission could not be applied. additionalProperties: false required: - code diff --git a/schemas/components/schemas/LabelsStatus.yaml b/schemas/components/schemas/LabelSubmissionEventOutcome.yaml similarity index 100% rename from schemas/components/schemas/LabelsStatus.yaml rename to schemas/components/schemas/LabelSubmissionEventOutcome.yaml diff --git a/schemas/components/schemas/LabelsRequest.yaml b/schemas/components/schemas/LabelSubmissionEventRequest.yaml similarity index 92% rename from schemas/components/schemas/LabelsRequest.yaml rename to schemas/components/schemas/LabelSubmissionEventRequest.yaml index 1a31b831..2940f333 100644 --- a/schemas/components/schemas/LabelsRequest.yaml +++ b/schemas/components/schemas/LabelSubmissionEventRequest.yaml @@ -15,4 +15,4 @@ properties: description: The list of labels to submit. A label may appear only once. minItems: 1 items: - $ref: LabelsEventLabel.yaml + $ref: LabelSubmissionLabel.yaml diff --git a/schemas/components/schemas/LabelsResponse.yaml b/schemas/components/schemas/LabelSubmissionEventResult.yaml similarity index 89% rename from schemas/components/schemas/LabelsResponse.yaml rename to schemas/components/schemas/LabelSubmissionEventResult.yaml index 06658de7..527492e1 100644 --- a/schemas/components/schemas/LabelsResponse.yaml +++ b/schemas/components/schemas/LabelSubmissionEventResult.yaml @@ -23,9 +23,9 @@ properties: examples: - 1735401600000.AbCdEf status: - $ref: LabelsStatus.yaml + $ref: LabelSubmissionEventOutcome.yaml errors: type: array description: The reasons the labels were rejected. Omitted unless `status` is `rejected`. items: - $ref: LabelsEventError.yaml + $ref: LabelSubmissionError.yaml diff --git a/schemas/components/schemas/LabelsEventLabel.yaml b/schemas/components/schemas/LabelSubmissionLabel.yaml similarity index 100% rename from schemas/components/schemas/LabelsEventLabel.yaml rename to schemas/components/schemas/LabelSubmissionLabel.yaml diff --git a/schemas/paths/labels.yaml b/schemas/paths/labels.yaml index 720f4207..1832f3cf 100644 --- a/schemas/paths/labels.yaml +++ b/schemas/paths/labels.yaml @@ -1,7 +1,7 @@ post: tags: - Labels - operationId: submitFraudLabels + operationId: submitEventFraudLabels summary: Submit Fraud Labels for an event description: | Submits labels for a single event, no more than 30 days old. The submission is processed synchronously — a `200` @@ -12,7 +12,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/LabelsRequest.yaml + $ref: ../components/schemas/LabelSubmissionEventRequest.yaml examples: valid: summary: Example request @@ -23,7 +23,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/LabelsResponse.yaml + $ref: ../components/schemas/LabelSubmissionEventResult.yaml examples: 200-applied: summary: Example response @@ -73,7 +73,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/LabelsResponse.yaml + $ref: ../components/schemas/LabelSubmissionEventResult.yaml examples: 422-rejected: summary: Response when the labels were rejected.