Skip to content

rest design meetings

Jump to bottom
Peter Van den Bosch edited this page Nov 26, 2025 · 191 revisions

Older meeting reports:

Meeting 2026-01-30

  • WG status:
    • evolution of open issues:
      • xx open issues: y new, z closed.
        • Closed issues: (to be completed)
    • REST guide, common openapi schemas and tooling updates:
    • Pull requests:
      • PR #260 for #255 Test allOf and oneOf guidelines with validator tooling
      • PR #261 for #152 description and summary in OpenAPI and for #176 Allow some use of title in schemas
  • New issues: (to be completed)
  • Issues ready to discuss:
    • status update of: (to be updated)
      • cloudevents:
      • rest-problem-java:
        • WIP spring boot 4 and Jackson 3 support
        • support for links (href) to issue type documentation (not yet released)
      • rest-guide-validator: WIP for allOf and oneOf rules; fixes for specific errors when resolving external files
      • WIP PR #228 Add list of organizations endorsing the REST guide
    • #199 Querying child resources
    • openapi-common #11 OffsetPaginatedCollection example schema
    • openapi-common #9 Standardized HTTP request and response headers
    • #258 Clarifications on resource linking
    • #105 Composite keys
  • Plan next meeting: 2026-03-xx 14h ??

Meeting 2025-11-21

  • WG status:
    • evolution of open issues:
      • 48 open issues: 2 new, 4 closed.
        • Closed issues: #181 (discriminator, oneOf, allOf, inheritance), #173 (phase out OpenAPI 2.0), #236 (i18n improvements), #125 (doc for issue types)
        • also closed openapi-common #27 Cannot make href property required
    • REST guide, common openapi schemas and tooling updates:
    • Pull requests:
  • New issues:
    • #255 Test allOf and oneOf guidelines with validator tooling
    • #258 Clarifications on resource linking
  • Issues discussed:
    • status update of:
      • cloudevents:
      • #19 example API
      • rest-problem-java:
        • WIP spring boot 4 and Jackson 3 support
        • support for links (href) to issue type documentation (not yet released)
      • rest-guide-validator: WIP for allOf and oneOf rules; fixes for specific errors when resolving external files
      • WIP PR #228 Add list of organizations endorsing the REST guide
    • #152 description and summary in OpenAPI
    • #255 Test allOf and oneOf guidelines with validator tooling
    • #89 OpenAPI 3.2
    • Postponed - next on backlog:
      • #199 Querying child resources
      • #233 WG organization (mail jpraet of 13/3)
      • #11 OffsetPaginatedCollection example schema
      • #9 Standardized HTTP request and response headers
      • #105 Composite keys
  • Plan next meeting: 2026-01-30 14h

Meeting 2025-09-19

  • WG status:
    • evolution of open issues:
      • 50 open issues: 7 new, 1 closed
    • REST guide, common openapi schemas and tooling updates:
    • Pull requests:
      • PR #228 List of organizations that endorse Belgif REST guidelines
      • PR #241 Apply OAS terminology
      • PR #243 for #181 Recommended use of discriminator, oneOf, inheritance
      • PR #245 URLs providing documentation of input validation issue types
      • PR #246 for #236 Improve guidelines for use of language
      • PR #253 for #252 W3C Trace Context and baggage
  • Closed issues:
    • #224 Always prefix identifiers in path for consistency
    • #242 REST resource with partial response (new issue)
  • New issues:
    • #240 Avoiding personal information in URLs
    • #247 Using PATCH without JSON merge patch
    • #248 Reconsider the use of 30x redirection
    • #249 Revamp Long-running Tasks guidelines and examples
    • #252 W3C Trace Context and baggage
    • #254 OpenAPI-valid REST API requests and responses
    • rest-guide-validator #118 Global x-ignore-rules
    • rest-guide-validator #114 HTTP Header naming and tracing headers
  • Issues discussed:
  • Plan next meeting: 2025-11-21 14h

Meeting 2025-06-13

  • WG status:
    • styleguide, common openapi schemas and tooling updates:
    • Pull requests reviewed:
      • #229 Update 409 Conflict description
      • #230 Describe compatibility problems with escaped slash values #230
      • #231 for #224 Always prefix identifiers in path for consistency
      • #232 for #126 invalidInput issue type
  • New issues:
    • #236 Improve guidelines for use of language
  • Issues ready to discuss:
  • Plan next meeting: 2025-09-19 14h

Meeting 2025-03-28

  • WG status:
    • evolution of open issues:
      • 46 open issues: 2 new, 2 closed
    • styleguide, common openapi schemas and tooling updates:
      • new release 2025-01-28 of REST guide - changelog
    • Pull requests:
      • #218 removal of OpenAPI 2.0 support
      • Note: #217 Representing operation can not be executed due to resource state (409) - didn't need change in guide
  • New issues:
    • #224 Always prefix identifiers in path for consistency
    • #226 request timeout propagation
  • WG organization (mail jpraet of 13/3) => new issues and will be created + put on agenda for a next meeting
  • Issues ready to discuss:
    • status update of:
      • GitHub Discussions
        • #225 Escaped slashes in path parameters
      • #173 Phase out support for OpenAPI 2.0
      • openapi-common #10 cloudevents (WIP)
      • rest-guide-validator: properties not nullable, mandatory unique operationId (no release yet)
    • #126 Standardize validation issues for belgif types
    • #105 Composite keys
  • Plan next meeting: 2025-06-13 14h
  • meeting dedicated for CloudEvents will be organized (date TBD)

Meeting 2025-01-24

  • WG status:
  • New issues:
    • #217 (replacing #185 + part of #126): Representing operation can not be executed due to resource state
  • Issues:
    • status update of:
    • #217 (replacing #185): Representing operation can not be executed due to resource state (409 Conflict)
    • #173 Phase out support for OpenAPI 2.0
  • next meeting: 2025-03-28 14h

Clone this wiki locally