Code Monkey home page Code Monkey logo

uscir-spec's Introduction

uscir-spec

The official specification for unnamed_sdvx_clone's Internet Ranking protocol!

uscir-spec's People

Contributors

ereti avatar farkasma avatar zkldi avatar

Watchers

 avatar

uscir-spec's Issues

Specification needs to support 22 (ACCEPTED)

The USCIR specification currently does not support a status code for a deferred import, which TachiIR will be using.

The 22 status code should imply that the score import has been accepted, but that the score will not display for the user yet.

The implementation reason for this in TachiIR is such that a chart has to be played by N unique users before it is counted as a "real" chart, to avoid IR spam.

GET /charts/:chartHash/leaderboard Ambiguous for N

If the request has, say, N of 10, but the server only has 5 unique PBs, the specification does not specify what to do explicitly. As it stands, I think the reasonable thing to do is to assume that N is the upper bound for the returned documents, but may be less (incl. 0) for any reason.

POST /scores Bad Requests

Should probably be documented that POST /scores can return 40 if the score document/chart document provided is invalid. This probably wont happen, but has to be accounted for anyway.

Client Score Document autoFlags conflicts with gameFlags

Maybe I'm reading this wrong but it isn't clear how options.autoFlags works with gameFlags. Don't they represent the same thing?

Or rather, isn't options in general just a more sensible form of gameFlags, and we can omit it entirely?

GET /charts/:chartHash/leaderboard Doesn't specify what to do with invalid args

This endpoint mandates mode and n params, but it is unspecified what to do if they are invalid.

I think returning 200 with 40 in the body is the reasonable approach.

Specifications should probably also be allowed to return 40 for unsupported args - such as an n param too great, or mode of rivals if it is unsupported. etc.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.