Skip to content

Conversation

@johnbrvc
Copy link
Collaborator

@johnbrvc johnbrvc commented Dec 2, 2025

Updated the readme to reflect functional and non-functional changes, including new properties and breaking changes in various endpoints since 2023-06.

Addresses #204

Updated the readme to reflect functional and non-functional changes, including new properties and breaking changes in various endpoints since 2023-06.
Copy link
Collaborator

@eldering eldering left a comment

Choose a reason for hiding this comment

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

Seems very complete, but I'd remove a bunch of duplication. I think the main thing we want here is that people can go through this list and know what might affect their implementations.

1) Description of *Identifiers* clarified.
2) Clarify no meaning is implied by the order of objects in arrays.
3) Added note to href
4) Added property **tag** (array of string) to file reference objects (FILE) along with a description of how it may be used. (eg. hints such as light or dark for images)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nitpick: I'd say this is a functional change as it changes every endpoint that has a property of FILE type.

3. Interface specification
1. Types of endpoints
1) Wording change (groups-\>types)
2) Added statement about judgment **current** property may change
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
2) Added statement about judgment **current** property may change
2) Added statement about judgement **current** property may change

4) Consistently use “judges” instead of “jury” in descriptions.
5) Update rules for **post\_clar** capability (which fields may be specified by what roles, etc).
14. Awards
1) Added descriptions of new “Bill” rules awards for honors, high-honors, highest-honors
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we want to name these "Bill" rules? Maybe better "ICPC World Finals specific".

1) Add description of how to post commentary
16. Scoreboard
1) Change types for **score.total\_time**, **score.time**, **problems.time** to **RELTIMEs**
2) Update examples to use **RELTIME**s in changed properties
Copy link
Collaborator

Choose a reason for hiding this comment

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

This was already mentioned, so I think adding it here again is duplicate.

1) Added descriptions for new properties **memory\_limit**, **output\_limit**, **code\_limit, attachments**
2) Clarify maximum score for problems in **score** type contests.
3) Clarify that the **rgb** property should not include an alpha channel.
4) Fixed examples to include newly added properties
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd drop this as I'd consider that implicit from the changes in properties.

Comment on lines +91 to +97
4. Contests
1) Clarify wording for **countdown\_pause\_time** and description below
2) Change type of penalty\_time to **RELTIME**
3) Change examples to use **RELTIME** for **penalty\_time**
5. Judgement Types
1) Added description of new property **simplified\_judgement\_type**
2) Added example for **simplified\_judgement\_type**
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd say these are already implied by the changes mentioned above.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants