Skip to content

🧹 Clarification: MAYs in several sections are linquistic, not requirements #1573

Closed
@gregsdennis

Description

@gregsdennis
Member

Specification section

Validation spec:

  • deprecated
  • readOnly / writeOnly

What is unclear?

There are several "MAY" words that don't need to be capitalized as they are neither constrictive nor permissive. This usage is just informing the reader that something could happen in the data that the schema is describing; it's not related to an implementation, tooling, or an application.

Proposal

Fix the casing to lowercase.

Do you think this work might require an [Architectural Decision Record (ADR)]? (significant or noteworthy)

No

Activity

added this to the stable-release milestone on Jan 15, 2025
changed the title [-]🧹 Clarification: MAYs in `deprecated` section are linquistic, not requirements[/-] [+]🧹 Clarification: MAYs in several sections are linquistic, not requirements[/+] on Jan 15, 2025
jdesrosiers

jdesrosiers commented on Jan 15, 2025

@jdesrosiers
Member

Thanks for looking out for things like this. I think there's quite a few places in the spec where we use these uppercase terms inappropriately.

moved this from In Discussion to Awaiting PR in Stable Release Developmenton Jan 19, 2025
moved this from Awaiting PR to In Progress in Stable Release Developmenton Feb 2, 2025
self-assigned this
on Feb 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

Status

Done

Relationships

None yet

    Development

    Participants

    @jdesrosiers@gregsdennis

    Issue actions

      🧹 Clarification: MAYs in several sections are linquistic, not requirements · Issue #1573 · json-schema-org/json-schema-spec