Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

List of Capabilities is inconsistent with example #164

Open
johnbrvc opened this issue Nov 9, 2023 · 1 comment
Open

List of Capabilities is inconsistent with example #164

johnbrvc opened this issue Nov 9, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@johnbrvc
Copy link
Collaborator

johnbrvc commented Nov 9, 2023

The /contests/contestid/access endpoint description has an example that shows a capability (patch_time) that is not part of the Capabilities list, rather, the contest_start capability is what should probably be used in the example, eg:

{
   "capabilities": ["contest_start"],
   "endpoints": [
     { "type": "contests", "properties": ["id","name","formal_name",...]},
     { "type": "problems", "properties": ["id","label",...]},
     { "type": "submissions", "properties": ["id","language_id","reaction",...]}
     ...
   ]
}
@johnbrvc johnbrvc added the documentation Improvements or additions to documentation label Nov 9, 2023
@johnbrvc johnbrvc self-assigned this Nov 13, 2023
johnbrvc added a commit that referenced this issue Nov 13, 2023
One of the examples for the Access endpoint showed a capability of "patch_time".  This capability does not appear in the Capabilities list that says "All capabilities are listed in the table below".  Clearly, "patch_time" is not in the list.  It makes sense to change the example to use a documented property and "contest_start" makes the most sense here.
@deboer-tim
Copy link
Member

Just to be clear, any system can support capabilities that are not in the spec (like additional objects, this is one of the expected places for systems to extend or try new things for future spec versions), but I 100% agree that our examples should use capabilities that are in the spec.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants