chore: update v3 OpenAPI specs to v3.847.0 - #39
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
| published_date: | ||
| type: string | ||
| example: '2023-01-01' | ||
| publisher: | ||
| type: string | ||
| example: Publisher 1 | ||
| publisher_country_code: | ||
| type: string | ||
| example: NG | ||
| title: | ||
| type: string | ||
| example: Sample AML Monitoring News Item | ||
| url: | ||
| type: string | ||
| example: www.example.com/article1 |
There was a problem hiding this comment.
Suggestion: The schema-level examples contradict the operation-level success example ('2026-01-15T12:00:00.000Z' vs '2023-01-01', and https://example.com/... vs www.example.com/article1). Add explicit format hints and align examples so generated SDKs/mock servers produce consistent, parseable values. [general, importance: 5]
| published_date: | |
| type: string | |
| example: '2023-01-01' | |
| publisher: | |
| type: string | |
| example: Publisher 1 | |
| publisher_country_code: | |
| type: string | |
| example: NG | |
| title: | |
| type: string | |
| example: Sample AML Monitoring News Item | |
| url: | |
| type: string | |
| example: www.example.com/article1 | |
| published_date: | |
| type: string | |
| format: date-time | |
| example: '2026-01-15T12:00:00.000Z' | |
| publisher: | |
| type: string | |
| example: Example News Publisher | |
| publisher_country_code: | |
| type: string | |
| description: ISO 3166-1 alpha-2 country code of the publisher. | |
| example: NG | |
| title: | |
| type: string | |
| example: Sample AML Monitoring News Item | |
| url: | |
| type: string | |
| format: uri | |
| example: https://example.com/news/sample-aml-monitoring |
| published_date: | ||
| type: string | ||
| example: '2023-01-01' | ||
| publisher: | ||
| type: string | ||
| example: Publisher 1 | ||
| publisher_country_code: | ||
| type: string | ||
| example: NG | ||
| title: | ||
| type: string | ||
| example: Sample AML Monitoring News Item | ||
| url: | ||
| type: string | ||
| example: www.example.com/article1 |
There was a problem hiding this comment.
Suggestion: The bundled spec carries the same inconsistent examples as the standalone spec; keep both in sync and add format: date-time / format: uri so generated clients type these fields correctly. [general, importance: 5]
| published_date: | |
| type: string | |
| example: '2023-01-01' | |
| publisher: | |
| type: string | |
| example: Publisher 1 | |
| publisher_country_code: | |
| type: string | |
| example: NG | |
| title: | |
| type: string | |
| example: Sample AML Monitoring News Item | |
| url: | |
| type: string | |
| example: www.example.com/article1 | |
| published_date: | |
| type: string | |
| format: date-time | |
| example: '2026-01-15T12:00:00.000Z' | |
| publisher: | |
| type: string | |
| example: Example News Publisher | |
| publisher_country_code: | |
| type: string | |
| description: ISO 3166-1 alpha-2 country code of the publisher. | |
| example: NG | |
| title: | |
| type: string | |
| example: Sample AML Monitoring News Item | |
| url: | |
| type: string | |
| format: uri | |
| example: https://example.com/news/sample-aml-monitoring |
User description
Automated v3 OpenAPI spec update for v3.847.0.
Triggered by Adeyemi Adunola (@Kennyinspire) - assigned to you in case it needs a manual merge.
PR Type
Enhancement, Documentation
Description
Add new
GET /v3/aml/monitoring/{job_id}/news/{reference}endpoint specDefine
AmlMonitoringNewsResponseandAmlMonitoringNewsItemschemasRegister new spec in README, docs viewer, and aggregated
openapi.yamlAdd CHANGELOG entry for v3.847.0
Diagram Walkthrough
File Walkthrough
v3-aml-monitoring-news.yaml
New AML Monitoring News OpenAPI spec filespecs/v3/v3-aml-monitoring-news.yaml
job_id,reference), requirednews_categoryenum,pagination and SDK/HMAC headers
AmlMonitoringNewsResponse,AmlMonitoringNewsItem,ApiErrorResponseschemas andSmileIDTokensecurity schemeopenapi.yaml
Integrate news endpoint into aggregated V3 specspecs/v3/openapi.yaml
AML Monitoring Newstag/v3/aml/monitoring/{job_id}/news/{reference}GET operation withfull parameters and responses
AmlMonitoringNewsResponseandAmlMonitoringNewsItemcomponentschemas
index.html
Register new spec in docs viewer listdocs/index.html
v3-aml-monitoring-newsentry to the SPECS list for the docsviewer
README.md
Document new endpoint in README tableREADME.md
CHANGELOG.md
Add v3.847.0 changelog entryCHANGELOG.md
openapiandv3-aml-monitoring-news