rest design meetings

Older meeting reports:

Meeting 2024-11-26

WG status:
- evolution of open issues:
  - x open issues: y new , z closed
  - openapi schemas: https://github.com/orgs/belgif/projects/1
- styleguide / common openapi schema updates:
  - belgif-openapi-organization v1.0.0 Initial release, with NACE codes
- Pull requests:
  - WIP: PR for #188 Guideline on examples
  - WIP: PR for #189 Guideline on nullable
  - #198 Promote belgif validator and rest-problem-java
  - [to complete]
New issues:
- [to complete]
Issues ready to discuss:
- status update of:
  - GitHub Discussions
  - REST guide for Brussels region
  - #169 ~~CBSS~~ Belgif rest-problem library
  - #190 Warnings in a successful response - discuss priority
- #126 Standardize validation issues for belgif types
- #105 Composite keys
Plan next meeting: 2024-11-xx

Meeting 2024-09-18

WG status:
- evolution of open issues (stats postponed to next meeting)
- styleguide / common openapi schema updates:
  - belgif-openapi-location v1.2.0 Adding BelgianPostCode schema
- Pull requests:
  - organization #1 NaceCode with variants (new reusable OpenAPI file)
  - healthcare #1 NihdiNumber schema (new reusable OpenAPI file)
  - rest-guide #193 Don't recommend cross-API linking for child concepts
- Discussions/communication:
  - #191 Allow status 204 for GET
New issues:
- #188 Guideline on examples => PR will be created
- #189 Guideline on nullable => PR will be created
- #190 Warnings in a successful response => call for use cases of other organizations
- #192 Leading zeros aren't allowed for numerical types => added to backlog
REST guide for Brussels region => create issues (or PRs) for improvements that apply to everyone, continue next time
Issues ready to discuss:
- status update of:
  - GitHub Discussions => no update
  - #168 styleguide validator => released!
  - #169 ~~CBSS~~ Belgif rest-problem library
  - #170 Update GitHub actions => closed
- #126 Standardize validation issues for belgif types
- #105 Composite keys => postponed to next meeting
Plan next meeting: 2024-11-26

Meeting 2024-05-29

WG status:
- evolution of open issues:
  - 47 open issues: 6 new , 6 closed (=)
  - openapi schemas: https://github.com/orgs/belgif/projects/1
- styleguide / common openapi schema updates:
  - new version of guide was published on 2024-04-05
  - belgif-openapi-organization-identifier v1.1.0 adds the VatNumber schema
  - belgif-openapi-person v2.1.0 adds HouseholdRelationTypeCode and CiviStatusTypeCode schemas
  - openapi-location #8 BelgianPostCode changed to string-based type with pattern
- Pull requests:
  - #179 Add new rule: required properties should be explicitly declared for #162
New issues:
- #177 Guidelines for packaging openapi definitions to exchange between institutions
- #178 Consumers should not parse problem title and detail
- #181 Recommended use of discriminator, oneOf, inheritance
- #182 Make operationId mandatory
- #184 Enum values should be consistent with schema
- #185 Standardized Belgif problem type(s) for 409 Conflict
Issues ready to discuss:
- status update of:
  - GitHub Discussions
  - #168 styleguide validator
  - #19 REST guide demo API
  - #169 ~~CBSS~~ Belgif rest-problem library
  - #170 Update GitHub actions
- #126 Standardize validation issues for belgif types
- #105 Composite keys
- openapi-common #8 Uuid type vs format
Plan next meeting: 2024-09-18

Meeting 2024-03-27

WG status:
- evolution of open issues:
  - 47 open issues: 6 new , 4 closed (+2)
  - openapi-common: 3 new issues
- styleguide / common openapi schema updates:
  - new version of guide was published on 2024-01-31
  - openapi-location #8 BelgianPostCode
  - openapi-common #12 conditional HTTP headers for new issue openapi-common #9
- Pull requests:
  - #156 for #167 How strictly to validate readOnly request properties and #143 Required properties should be explicitly defined
  - #172 for #163 UpperCamelCase for all components
  - #171 for #102 naming guidelines for OpenAPI tags
  - #174 for #165(comment) Clarify health status is client-oriented
New issues:
- #168 styleguide validator
- #169 rest-problem library
- #170 Update GitHub actions
- #173 Phase out OpenAPI 2.0
- #175 Response type of /doc/openapi.yaml
- #176 Allow some use of title property on schemas
- openapi-common #10 CloudEvents schemas
- openapi-common #11 Paginated collection schema
Issues discussed:
- status update of:
  - GitHub Discussions
  - #168 styleguide validator
  - #19 REST guide demo API
  - #169 CBSS rest-problem library - possible move to belgif
- #126 Standardize validation issues for belgif types
- #105 Composite keys
Next meeting: 2024-05-29

Meeting 2024-01-24

WG status:
- evolution of open issues:
  - 45 open issues: 5 new , 1 closed
- styleguide / common openapi schema updates:
  - feedback handled for #144 handled in #154 Rename unknown parameter to unknown issue + clarifications
  - new beta type VatNumber fedvoc #29
- Pull requests reviewed:
  - #159 for #148 lowerCamelCase for path and query parameters
  - #156 Motivate why readOnly and required properties are not allowed
  - #161 for #106 Singleton document resource
  - #158 for #107 access to /health
  - openapi-problem #13 and #155 Update InputValidationProblem example (new version + REST guide alignment)
  - #160 Multi-value query parameters should be singular
Overview of new issues:
- #153 Extension of schemas and additional properties
- #162 Required properties should be explicitly defined (issue discussed on WG)
- #163 UpperCamelCase for all components (issue discussed on WG)
- #164 Naming convention for API-specific input validation issue type
- #167 How strictly to validate readOnly request properties (issue discussed on WG)
Issues discussed:
- status update of:
  - GitHub Discussions
  - styleguide validator
  - #19 REST guide demo API
- present CBSS rest-problem library - evaluate for possible move to belgif
- #102 naming guidelines for OpenAPI tags
- #126 Standardize validation issues for belgif types (discussion started, will be continued)
Plan next meeting: 2024-03-27

Meeting 2023-11-22

WG status:
- evolution of open issues:
  - 41 open issues (+3): 4 new (+1 in openapi-common), 1 closed
  - closed:
    - #25: evaluate OpenAPI tooling - replaced by GitHub Discussions
- REST guide was updated on 2023-10-05 (see Changelog)
- new version 1.1.0 of belgif-openapi-money adding Belgian Remittance Information
- Pull requests:
  - #144 Rename unknown parameter to unknown issue + clarifications
  - openapi-problem #13 Update problem examples
new issues:
- openapi-common #8 Uuid type vs format
- #151 Add rule about fedvoc naming
- #148 lowerCamelCase for path and query parameters
- #143 readOnly + required properties
- #152 description and summary guidelines
Issues ready to discussed:
- status update of:
  - #145, #146, #147 tooling
  - styleguide validator
  - #19 REST guide demo API
- #106 Singleton document resource
- #107 access to /health
Plan next meeting: 24/1

Meeting 2023-09-27

WG status:
- evolution of open issues:
  - 38 open issues (=): 4 new, 4 closed
  - closed:
    - #101 href linking merged + other discussion ctd. in #130
    - #94 Naming of properties and types for codes
    - 2 merged or duplicate issues
- Pull requests reviewed and approved:
  - #129 HTTP headers case-insensitive
  - #132 Replace links to belgif swaggers by openapi
  - #133 Improve overview of http methods usage + add explicit rule
  - #134 Make "items" array in collection response mandatory
  - #135 Fix OpenAPI 2.0 example multi-value query param
  - #137 update broken link to SOA article
  - #139 Update Problem Details RFC to 9457
  - #141 Explicit rule for sort query param
  - openapi-money #3 BelgianRemittanceInformation
new issues:
- openapi-common #7 Add explicit additionalProperties to types
- #130 Duplication of resource data across APIs
- #8 UUID type (openapi-common v. format: uuid)
- #131 Multiple and mixed media type guidelines
- #140 rename unknownParameter issue type
Issues discussed:
- #25 update on tooling (IntelliJ, OpenAPI generator 7.0 experiences)
- demo of styleguide validator
- #19 REST guide demo API - status update
- #113 issue types for multiple param validations
- #140 rename unknownParameter issue type
Next meeting: November 22th

Meeting 2023-06-20

WG status:
- evolution of open issues:
  - 38 open issues (+2): 5 new, 3 closed
  - closed:
    - #112 Make self links optional
    - #127 and #128 - by updating REST guide demo API
- styleguide update published 2023-06-14
  - #121 Add doc openapi resource to reserved paths
  - #119 Naming convention for identifier and code types
  - #115 Clarify the meaning of 'total' w.r.t. filtering
  - #118 Handling unknown request parameters
  - #122 Avoid cross-API links, optional self-links
  - #123 Update OpenAPI tooling
- belgif-openapi-common 1.4.0: #5 Language types, default health problem response (health responses)
- PR: openapi-money #3 BelgianRemittanceInformation
new issues:
- #124 Use additionalProperties instead of separate key-value properties
- #125 URLs providing documentation of input validation issue types - split from #113
- #126 Standardize validation issues on belgif types - split from #113
Issues discussed:
- #19 REST guide demo API - status update
- #94 Currency -> CurrencyCode
- #108 input validation problems for multiple params (mut. excl or must match)
- #103 HTTP headers case-insensitive
Plan next meeting: 27 Sept

Meeting 2023-05-10

WG status:
- evolution of open issues:
  - 35 open issues (+4): 5 new, 1 closed
- styleguide update published 2023-03-17
  - #111 Static rule identifiers
  - #5 Language types, default health problem response (if validated)
  - #94 Naming convention for codes (part w/o OpenAPI types)
- communication: #117
new issues:
- #112 Make self links optional
- #113 Standardization of input validation issue types
- #114 listing unauthorized parameter values in missingPermission
- #160 API resources depending on user context
- #120 naming types for a partial resource representation
review of pull requests
- #5 Language types, default health problem response (health responses)
- #115 Clarify the meaning of 'total' w.r.t. filtering
- #118 Handling undefined request parameters
- #119 Naming convention for identifier and code types
- #121 Add doc openapi resource to reserved paths
- #122 Avoid cross-API links, optional self-links
- #123 Update OpenAPI tooling
Issues ready to discuss:
- #19 REST guide demo API - status update
- #108 input validation problems for multiple params (mut. excl or must match)
- #103 HTTP headers case-insensitive
- #106 Singleton document resource
- #107 access to /health
- #9 “in” property in InputValidationIssue
- #102 naming guidelines for OpenAPI tags
- #105 Composite keys

Meeting 2023-03-15

WG status:
- number of open issues
  - 31 open issues (+1): 1 new, 0 closed
- styleguide and openapi schemas updates
  - openapi-employment-identifier 1.0.1 published (EmployerId format int64)
review of pull requests
- #5 Language types, default health problem response
- #111 Static rule identifiers
New issues
- #110 Handling undefined request parameters
Issues discussed:
- #19 REST guide demo API
- #94 Naming convention for codes
- #101 including code descriptions in responses
- #108 input validation problems for multiple params (mut. excl or must match)

Meeting 2023-02-15

Current WG status:
- number of open issues
  - 30 open issues (+6): 8 new, 2 closed
  - 2 new in belgif-openapi-* projects
- styleguide and openapi schemas updates
  - new update published on 2022-12-07
  - openapi-common 1.3.0 published with updated dependency on openapi-problem 1.3.0
review of pull requests:
- EmployerId int64
Overview of new issues:
- #101 Descriptions of codes
- #7 replace Problem example with a more generic one
- #104 Add license to Belgif OpenAPI schemas
- #103 HTTP headers case-insensitive
- #106 Singleton document resource
- #107 access to /health
- #9 “in” property in InputValidationIssue
- #102 naming guidelines for OpenAPI tags
- #105 Composite keys
- #108 input validation problems for multiple params (mut. excl or must match)
Closed issues
- #96 access to /doc resource
- #67 non-API-specific headers and problems
Issues discussed:
- #7 replace Problem example with a more generic one
- #104 Add license to Belgif OpenAPI schemas
- #38 static rule numbers
- #19 REST guide demo API
- #34 styleguide compliance validator
- #25 swagger tooling
- #98 Usage of - and + for sort direction
- #94 Naming convention for codes
- #101 including code descriptions in responses
next meeting: date and issues to discuss

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rest design meetings

Meeting 2024-11-26

Meeting 2024-09-18

Meeting 2024-05-29

Meeting 2024-03-27

Meeting 2024-01-24

Meeting 2023-11-22

Meeting 2023-09-27

Meeting 2023-06-20

Meeting 2023-05-10

Meeting 2023-03-15

Meeting 2023-02-15

Clone this wiki locally