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

Check 1.0 docs for accuracy against 0.9 changes #581

Closed
mattheworiordan opened this issue Jan 27, 2017 · 7 comments
Closed

Check 1.0 docs for accuracy against 0.9 changes #581

mattheworiordan opened this issue Jan 27, 2017 · 7 comments
Assignees
Labels
enhancement New feature or improved functionality.

Comments

@mattheworiordan
Copy link
Member

See ably/docs#264 and 1.0 PR at ably/docs#260

@ricardopereira please can you do a similar task to what Peter did and review all Realtime & REST API docs and provide a list of what needs changing please.

Please note that Peter did not provide a list of links to Github as a reference for method definitions / interfaces etc. Please can you do that so that it's easier for me to jump straight to code when working out what to change.

@mattheworiordan mattheworiordan added the enhancement New feature or improved functionality. label Jan 27, 2017
@ricardopereira
Copy link
Contributor

ricardopereira commented Jan 30, 2017

Types

ARTTokenRequest

ttl property of type NSTimeInterval in Swift & ObjC:
https://github.com/ably/docs/blame/77fe470b34d29524a4ed1e118e83d2f649e2ce33/content/types/_token_request.textile#L9

timestamp property of type NSDate in Swift & ObjC:
https://github.com/ably/docs/blame/77fe470b34d29524a4ed1e118e83d2f649e2ce33/content/types/_token_request.textile#L10

ARTAuthOptions

authUrl property of type NSURL in Swift & ObjC:
https://github.com/ably/docs/blame/77fe470b34d29524a4ed1e118e83d2f649e2ce33/content/types/_auth_options.textile#L24

authHeaders property of type NSDictionary<String *, String *> in ObjC, [String, String]/Dictionary<String, String> in Swift:
https://github.com/ably/docs/blame/77fe470b34d29524a4ed1e118e83d2f649e2ce33/content/types/_auth_options.textile#L28

authParams property of type NSArray<NSURLQueryItem *> in ObjC, [NSURLQueryItem]/Array<NSURLQueryItem> in Swift:
https://github.com/ably/docs/blame/77fe470b34d29524a4ed1e118e83d2f649e2ce33/content/types/_auth_options.textile#L30

@ricardopereira
Copy link
Contributor

Done ✅

@mattheworiordan
Copy link
Member Author

Thanks, please leave this open as we need to update this before we release 1.0.

@mattheworiordan
Copy link
Member Author

@ricardopereira I believe this is all fixed in 155fa73. I'm merging into www.ably.io/documentation now so it would be nice if you could double check the issues you mentioned above and confirm everything is OK. Thanks

@ricardopereira
Copy link
Contributor

@mattheworiordan Reviewed. I only found this issue ably/docs#285.

@mattheworiordan
Copy link
Member Author

Thanks @ricardopereira

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or improved functionality.
Development

No branches or pull requests

2 participants