Git Product home page Git Product logo

specklespecs's People

Contributors

didimitrie avatar gouldingken avatar mswaidan avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

specklespecs's Issues

userLogin info confusing and maybe incorrect

Step 0:

regarding: https://speckleworks.github.io/SpeckleSpecs/#userlogin

Expected Behaviour

The things listed under "Actual Behavior" are not the case.

Actual Behaviour

  • says "The only required elements are email and password." but password isn't listed in body params.
  • Python example code uses params keyword arg, when it should be "data"
  • also I think you need to do a lil json.dumps() for that to work
  • description says "Login and get jwt token." - but below it says "...you must be authenticated by means of one of the following methods: JWT"

Affected Projects

Nah, just took a little while to realise I needed to write data rather than params in my request, and the other confusing elements made me doubt my sanity briefly.

Reproduction Steps & System Config (win, osx, web, etc.)

open and browser and go to https://speckleworks.github.io/SpeckleSpecs/#userlogin

Proposed Solution (if any)

correct the above issues.. also, happy to do myself at some point when I have time.

InkedCapture_LI

Uppercase properties keys for planes

Origin:
$ref: '#/definitions/SpecklePoint'
description: The origin of the plane.
Normal:
$ref: '#/definitions/SpeckleVector'
description: The normal of the plane.
Xdir:
$ref: '#/definitions/SpeckleVector'
description: The X axis of the plane.
Ydir:
$ref: '#/definitions/SpeckleVector'
description: The Y axis of the plane.

Origin, Normal, Xdir, Ydir should be lowercase

Docs for registering new user needs updating

Step 0:

Expected Behaviour

How things should actually work!

First thing I do when I start a new server is register a user. I should copy code snippet from docs and it just works.

Actual Behaviour

What's actually going on!

The inputBody does not have a "password" key and thus the request fails with message "passwords are necessary evil..."

Affected Projects

Does this issue propagate to other dependencies or dependants? If so, list them here!

Probably not

Reproduction Steps & System Config (win, osx, web, etc.)
Any client using docs as reference

Proposed Solution (if any)

Update docs to indicate that a password key is required when creating a user

General Update & Cleanup

Things are moving along in the server, and the specs need a rather thorough general update:

  • remove deprecated routes
  • add the new datatypes, especially re SpeckleObjects
  • cleanup

Get Stream response is invalid-ish

objects are no longer populated, therefore we need a simpler structure for data streams, or workaround (it will fail casting in .net)

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.