Skip to content

chore: update v3 OpenAPI specs to v3.847.0 - #39

Merged
Ed Fricker (beastawakens) merged 1 commit into
mainfrom
sync/v3.847.0
Aug 24, 2026
Merged

chore: update v3 OpenAPI specs to v3.847.0#39
Ed Fricker (beastawakens) merged 1 commit into
mainfrom
sync/v3.847.0

Conversation

@beastawakens

@beastawakens Ed Fricker (beastawakens) commented Aug 24, 2026

Copy link
Copy Markdown
Member

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 spec

  • Define AmlMonitoringNewsResponse and AmlMonitoringNewsItem schemas

  • Register new spec in README, docs viewer, and aggregated openapi.yaml

  • Add CHANGELOG entry for v3.847.0


Diagram Walkthrough

flowchart LR
  A["New spec: v3-aml-monitoring-news.yaml"] -- "merged into" --> B["specs/v3/openapi.yaml"]
  A -- "listed in" --> C["README.md spec table"]
  A -- "listed in" --> D["docs/index.html SPECS"]
  A -- "recorded in" --> E["CHANGELOG.md v3.847.0"]
Loading

File Walkthrough

Relevant files
Enhancement
v3-aml-monitoring-news.yaml
New AML Monitoring News OpenAPI spec file                               

specs/v3/v3-aml-monitoring-news.yaml

  • New standalone OpenAPI 3.0.3 spec for AML Monitoring News endpoint
  • Defines path params (job_id, reference), required news_category enum,
    pagination and SDK/HMAC headers
  • Adds AmlMonitoringNewsResponse, AmlMonitoringNewsItem,
    ApiErrorResponse schemas and SmileIDToken security scheme
  • Documents 200/400/401/403/404/500/502/503 responses with examples
+329/-0 
openapi.yaml
Integrate news endpoint into aggregated V3 spec                   

specs/v3/openapi.yaml

  • Adds AML Monitoring News tag
  • Adds /v3/aml/monitoring/{job_id}/news/{reference} GET operation with
    full parameters and responses
  • Adds AmlMonitoringNewsResponse and AmlMonitoringNewsItem component
    schemas
+284/-0 
Documentation
index.html
Register new spec in docs viewer list                                       

docs/index.html

  • Adds v3-aml-monitoring-news entry to the SPECS list for the docs
    viewer
+1/-0     
README.md
Document new endpoint in README table                                       

README.md

  • Adds table row documenting the new AML Monitoring News endpoint
+1/-0     
CHANGELOG.md
Add v3.847.0 changelog entry                                                         

CHANGELOG.md

  • Adds v3.847.0 release section dated 2026-08-24
  • Notes updates to openapi and v3-aml-monitoring-news
+7/-0     


Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • @prfectionist

    prfectionist Bot commented Aug 24, 2026

    Copy link
    Copy Markdown

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🏅 Score: 85
    🧪 No relevant tests
    🔒 No security concerns identified
    🔀 No multiple PR themes
    ⚡ Recommended focus areas for review

    Inconsistent Examples

    The published_date field example in the schema is a plain date (2023-01-01) while the
    response example in the endpoint uses a full ISO 8601 timestamp
    (2026-01-15T12:00:00.000Z), and no format is declared. Similarly url uses
    www.example.com/article1 in the schema versus a full https:// URL in the response
    example. Generated clients/docs and consumers relying on the schema may parse these fields
    incorrectly; declaring format: date-time / format: uri (or picking one consistent
    representation) would remove the ambiguity.

    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
    Missing Schema Description

    AmlMonitoringNewsResponse.product declares only an enum with a single value and no
    example, unlike the other properties. Tools that generate examples from the schema (rather
    than the operation-level example) may omit or mis-render this required field. Adding
    example: aml_monitoring_news keeps it consistent with the rest of the schema.

    product:
      type: string
      description: Product identifier for this endpoint.
      enum:
        - aml_monitoring_news

    @beastawakens
    Ed Fricker (beastawakens) merged commit 4611e3b into main Aug 24, 2026
    2 checks passed
    @beastawakens
    Ed Fricker (beastawakens) deleted the sync/v3.847.0 branch August 24, 2026 12:38
    Comment on lines +301 to +315
    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

    Copy link
    Copy Markdown

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    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]

    Suggested change
    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

    Comment thread specs/v3/openapi.yaml
    Comment on lines +3783 to +3797
    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

    Copy link
    Copy Markdown

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    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]

    Suggested change
    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

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    2 participants